From df9d3818ac8b7c55f60da040175c229e7d1def4c Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Tue, 25 Apr 2023 15:17:51 +0100 Subject: glib-unix: Improve documentation for g_unix_fd_source_new() In particular, document the type of the callback function. Signed-off-by: Philip Withnall --- glib/glib-unix.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/glib/glib-unix.c b/glib/glib-unix.c index ef0d1fbfb..f671887c9 100644 --- a/glib/glib-unix.c +++ b/glib/glib-unix.c @@ -293,12 +293,15 @@ GSourceFuncs g_unix_fd_source_funcs = { /** * g_unix_fd_source_new: * @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. * - * 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 * -- cgit v1.2.1