From: Ron Steinke Date: Mon, 28 Jan 2002 21:17:45 +0000 (+0000) Subject: Some documentation fixes/elaborations I really should have gotten X-Git-Tag: GLIB_1_3_13~10 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=03b959009503240778053041a21ad5c93ee7cb9f;p=platform%2Fupstream%2Fglib.git Some documentation fixes/elaborations I really should have gotten in a long time ago --- diff --git a/ChangeLog b/ChangeLog index 8f4da72..21e9bc9 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2002-01-28 Ron Steinke + + * glib/giochannel.c: Some documentation fixes/elaborations + I really should have gotten in a long time ago + 2002-01-24 Sven Neumann * glib/gutf8.c (g_utf8_to_utf16): removed an empty line in the diff --git a/ChangeLog.pre-2-0 b/ChangeLog.pre-2-0 index 8f4da72..21e9bc9 100644 --- a/ChangeLog.pre-2-0 +++ b/ChangeLog.pre-2-0 @@ -1,3 +1,8 @@ +2002-01-28 Ron Steinke + + * glib/giochannel.c: Some documentation fixes/elaborations + I really should have gotten in a long time ago + 2002-01-24 Sven Neumann * glib/gutf8.c (g_utf8_to_utf16): removed an empty line in the diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 8f4da72..21e9bc9 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,8 @@ +2002-01-28 Ron Steinke + + * glib/giochannel.c: Some documentation fixes/elaborations + I really should have gotten in a long time ago + 2002-01-24 Sven Neumann * glib/gutf8.c (g_utf8_to_utf16): removed an empty line in the diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12 index 8f4da72..21e9bc9 100644 --- a/ChangeLog.pre-2-12 +++ b/ChangeLog.pre-2-12 @@ -1,3 +1,8 @@ +2002-01-28 Ron Steinke + + * glib/giochannel.c: Some documentation fixes/elaborations + I really should have gotten in a long time ago + 2002-01-24 Sven Neumann * glib/gutf8.c (g_utf8_to_utf16): removed an empty line in the diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2 index 8f4da72..21e9bc9 100644 --- a/ChangeLog.pre-2-2 +++ b/ChangeLog.pre-2-2 @@ -1,3 +1,8 @@ +2002-01-28 Ron Steinke + + * glib/giochannel.c: Some documentation fixes/elaborations + I really should have gotten in a long time ago + 2002-01-24 Sven Neumann * glib/gutf8.c (g_utf8_to_utf16): removed an empty line in the diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 8f4da72..21e9bc9 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,8 @@ +2002-01-28 Ron Steinke + + * glib/giochannel.c: Some documentation fixes/elaborations + I really should have gotten in a long time ago + 2002-01-24 Sven Neumann * glib/gutf8.c (g_utf8_to_utf16): removed an empty line in the diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 8f4da72..21e9bc9 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,8 @@ +2002-01-28 Ron Steinke + + * glib/giochannel.c: Some documentation fixes/elaborations + I really should have gotten in a long time ago + 2002-01-24 Sven Neumann * glib/gutf8.c (g_utf8_to_utf16): removed an empty line in the diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 8f4da72..21e9bc9 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,8 @@ +2002-01-28 Ron Steinke + + * glib/giochannel.c: Some documentation fixes/elaborations + I really should have gotten in a long time ago + 2002-01-24 Sven Neumann * glib/gutf8.c (g_utf8_to_utf16): removed an empty line in the diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 78ee042..b481981 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +2002-01-28 Ron Steinke + + * glib/iochannel.sgml: Changed #IOChannelError to + #GIOChannelError in one place + 2002-01-16 Matthias Clasen * glib/building.sgml, glib/compiling.sgml, diff --git a/docs/reference/glib/tmpl/iochannels.sgml b/docs/reference/glib/tmpl/iochannels.sgml index 96e9cd4..acae9f6 100644 --- a/docs/reference/glib/tmpl/iochannels.sgml +++ b/docs/reference/glib/tmpl/iochannels.sgml @@ -276,7 +276,7 @@ Error codes returned by #GIOChannel operations. Error domain for #GIOChannel operations. Errors in this domain will -be from the #IOChannelError enumeration. See #GError for information on +be from the #GIOChannelError enumeration. See #GError for information on error domains. diff --git a/glib/giochannel.c b/glib/giochannel.c index 5beba7e..fe60dc7 100644 --- a/glib/giochannel.c +++ b/glib/giochannel.c @@ -279,7 +279,7 @@ g_io_channel_seek (GIOChannel *channel, * @filename: A string containing the name of a file. * @mode: One of "r", "w", "a", "r+", "w+", "a+". These have * the same meaning as in fopen(). - * @error: A location to return an error of type %G_IO_FILE_ERROR. + * @error: A location to return an error of type %G_FILE_ERROR. * * Open a file @filename as a #GIOChannel using mode @mode. This * channel will be closed when the last reference to it is dropped, @@ -688,7 +688,7 @@ g_io_channel_get_line_term (GIOChannel *channel, * @flags: the flags to set on the IO channel. * @error: A location to return an error of type #GIOChannelError. * - * Sets flags on the IO channel. + * Sets the (writeable) flags in @channel to (@flags & %G_IO_CHANNEL_SET_MASK). * * Return value: the status of the operation. **/ @@ -767,13 +767,13 @@ g_io_channel_set_close_on_unref (GIOChannel *channel, * g_io_channel_get_close_on_unref: * @channel: a #GIOChannel. * - * Returns whether the channel will be closed on the final unref of the - * #GIOChannel data structure. The default value of this is %TRUE for - * channels created by g_io_channel_new_file(), and %FALSE for all other - * channels. - * - * Return value: %TRUE if the channel will be closed on the final unref of - * the #GIOChannel data structure. + * Returns whether the file/socket/whatever associated with @channel + * will be closed when @channel receives its final unref and is + * destroyed. The default value of this is %TRUE for channels created + * by g_io_channel_new_file (), and %FALSE for all other channels. + * + * Return value: Whether the channel will be closed on the final unref of + * the GIOChannel data structure. **/ gboolean g_io_channel_get_close_on_unref (GIOChannel *channel) @@ -975,7 +975,7 @@ g_io_channel_set_buffered (GIOChannel *channel, * g_io_channel_get_buffered: * @channel: a #GIOChannel. * - * Returns the buffering state of the channel. + * Returns whether @channel is buffered. * * Return Value: %TRUE if the @channel is buffered. **/