From 9f896667f8fc8b9596a50242116782567710c3a7 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sat, 1 Feb 2014 10:14:41 -0500 Subject: [PATCH] GIOChannel: remove unneeded markup from the docs --- glib/giochannel.c | 56 +++++++++++++++++++++---------------------------------- 1 file changed, 21 insertions(+), 35 deletions(-) diff --git a/glib/giochannel.c b/glib/giochannel.c index 7d43292..7cd1b2e 100644 --- a/glib/giochannel.c +++ b/glib/giochannel.c @@ -44,15 +44,9 @@ /** * SECTION:iochannels * @title: IO Channels - * @short_description: portable support for using files, pipes and - * sockets - * @see_also: - * g_io_add_watch(), g_io_add_watch_full(), - * g_source_remove() Convenience - * functions for creating #GIOChannel instances and adding - * them to the main - * event loop. - * + * @short_description: portable support for using files, pipes and sockets + * @see_also: g_io_add_watch(), g_io_add_watch_full(), g_source_remove(), + * #GMainLoop * * The #GIOChannel data type aims to provide a portable method for * using file descriptors, pipes, and sockets, and integrating them @@ -1290,43 +1284,35 @@ g_io_channel_get_buffered (GIOChannel *channel) * * The encoding can only be set if one of the following conditions * is true: - * - * - * The channel was just created, and has not been written to or read - * from yet. - * - * - * The channel is write-only. - * - * - * The channel is a file, and the file pointer was just - * repositioned by a call to g_io_channel_seek_position(). - * (This flushes all the internal buffers.) - * - * - * The current encoding is %NULL or UTF-8. - * - * - * One of the (new API) read functions has just returned %G_IO_STATUS_EOF - * (or, in the case of g_io_channel_read_to_end(), %G_IO_STATUS_NORMAL). - * - * - * One of the functions g_io_channel_read_chars() or + * + * - The channel was just created, and has not been written to or read from yet. + * + * - The channel is write-only. + * + * - The channel is a file, and the file pointer was just repositioned + * by a call to g_io_channel_seek_position(). (This flushes all the + * internal buffers.) + * + * - The current encoding is %NULL or UTF-8. + * + * - One of the (new API) read functions has just returned %G_IO_STATUS_EOF + * (or, in the case of g_io_channel_read_to_end(), %G_IO_STATUS_NORMAL). + * + * - One of the functions g_io_channel_read_chars() or * g_io_channel_read_unichar() has returned %G_IO_STATUS_AGAIN or * %G_IO_STATUS_ERROR. This may be useful in the case of * %G_CONVERT_ERROR_ILLEGAL_SEQUENCE. * Returning one of these statuses from g_io_channel_read_line(), * g_io_channel_read_line_string(), or g_io_channel_read_to_end() * does not guarantee that the encoding can be changed. - * - * + * * Channels which do not meet one of the above conditions cannot call * g_io_channel_seek_position() with an offset of %G_SEEK_CUR, and, if * they are "seekable", cannot call g_io_channel_write_chars() after * calling one of the API "read" functions. * - * Return Value: %G_IO_STATUS_NORMAL if the encoding was successfully set. - **/ + * Return Value: %G_IO_STATUS_NORMAL if the encoding was successfully set + */ GIOStatus g_io_channel_set_encoding (GIOChannel *channel, const gchar *encoding, -- 2.7.4