Merge branch 'unix-fd-source-docs' into 'main'

glib-unix: Improve documentation for g_unix_fd_source_new()

See merge request GNOME/glib!3396
This commit is contained in:
Philip Withnall 2023-04-26 16:11:42 +00:00
commit 73bf66dd2a

View File

@ -293,12 +293,15 @@ GSourceFuncs g_unix_fd_source_funcs = {
/** /**
* g_unix_fd_source_new: * g_unix_fd_source_new:
* @fd: a file descriptor * @fd: a file descriptor
* @condition: IO conditions to watch for on @fd * @condition: I/O conditions to watch for on @fd
* *
* Creates a #GSource to watch for a particular IO condition on a file * Creates a #GSource to watch for a particular I/O condition on a file
* descriptor. * descriptor.
* *
* The source will never close the fd -- you must do it yourself. * The source will never close the @fd you must do it yourself.
*
* Any callback attached to the returned #GSource must have type
* #GUnixFDSourceFunc.
* *
* Returns: the newly created #GSource * Returns: the newly created #GSource
* *