luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-05 08:56:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

GIOChannel: Add missing annotations

Browse Source 
The various read and write methods have several out arguments which were not
previously marked as such. Also, as GIOChannel supports binary data with a NULL
encoding, the buffers need to be uint8 arrays instead of utf8 strings.
This commit is contained in:
Martin Pitt 2012-10-25 14:55:30 +02:00
parent a5c5730085
commit 1775c46e7a
1 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
glib/giochannel.c
View File

@ -1649,12 +1649,12 @@ reencode:
/** /**
* g_io_channel_read_line: * g_io_channel_read_line:
* @channel: a #GIOChannel * @channel: a #GIOChannel
* @str_return: The line read from the #GIOChannel, including the * @str_return: (out): The line read from the #GIOChannel, including the
* line terminator. This data should be freed with g_free() * line terminator. This data should be freed with g_free()
* when no longer needed. This is a nul-terminated string. * when no longer needed. This is a nul-terminated string.
* If a @length of zero is returned, this will be %NULL instead. * If a @length of zero is returned, this will be %NULL instead.
* @length: (allow-none): location to store length of the read data, or %NULL * @length: (allow-none) (out): location to store length of the read data, or %NULL
* @terminator_pos: (allow-none): location to store position of line terminator, or %NULL * @terminator_pos: (allow-none) (out): location to store position of line terminator, or %NULL
* @error: A location to return an error of type #GConvertError * @error: A location to return an error of type #GConvertError
* or #GIOChannelError * or #GIOChannelError
* *
@ -1913,12 +1913,12 @@ done:
/** /**
* g_io_channel_read_to_end: * g_io_channel_read_to_end:
* @channel: a #GIOChannel * @channel: a #GIOChannel
* @str_return: Location to store a pointer to a string holding * @str_return: (out) (array length=length) (element-type guint8): Location to
* the remaining data in the #GIOChannel. This data should * store a pointer to a string holding the remaining data in the
* be freed with g_free() when no longer needed. This * #GIOChannel. This data should be freed with g_free() when no
* data is terminated by an extra nul character, but there * longer needed. This data is terminated by an extra nul
* may be other nuls in the intervening data. * character, but there may be other nuls in the intervening data.
* @length: location to store length of the data * @length: (out): location to store length of the data
* @error: location to return an error of type #GConvertError * @error: location to return an error of type #GConvertError
* or #GIOChannelError * or #GIOChannelError
* *
@ -1994,11 +1994,12 @@ g_io_channel_read_to_end (GIOChannel *channel,
/** /**
* g_io_channel_read_chars: * g_io_channel_read_chars:
* @channel: a #GIOChannel * @channel: a #GIOChannel
* @buf: a buffer to read data into * @buf: (out caller-allocates) (array length=count) (element-type guint8):
* @count: the size of the buffer. Note that the buffer may not be * a buffer to read data into
* @count: (in): the size of the buffer. Note that the buffer may not be
* complelely filled even if there is data in the buffer if the * complelely filled even if there is data in the buffer if the
* remaining data is not a complete character. * remaining data is not a complete character.
* @bytes_read: (allow-none): The number of bytes read. This may be * @bytes_read: (allow-none) (out): The number of bytes read. This may be
* zero even on success if count < 6 and the channel's encoding * zero even on success if count < 6 and the channel's encoding
* is non-%NULL. This indicates that the next UTF-8 character is * is non-%NULL. This indicates that the next UTF-8 character is
* too wide for the buffer. * too wide for the buffer.
@ -2174,10 +2175,10 @@ g_io_channel_read_unichar (GIOChannel *channel,
/** /**
* g_io_channel_write_chars: * g_io_channel_write_chars:
* @channel: a #GIOChannel * @channel: a #GIOChannel
* @buf: a buffer to write data from * @buf: (array) (element-type guint8): a buffer to write data from
* @count: the size of the buffer. If -1, the buffer * @count: the size of the buffer. If -1, the buffer
* is taken to be a nul-terminated string. * is taken to be a nul-terminated string.
* @bytes_written: The number of bytes written. This can be nonzero * @bytes_written: (out): The number of bytes written. This can be nonzero
* even if the return value is not %G_IO_STATUS_NORMAL. * even if the return value is not %G_IO_STATUS_NORMAL.
* If the return value is %G_IO_STATUS_NORMAL and the * If the return value is %G_IO_STATUS_NORMAL and the
* channel is blocking, this will always be equal * channel is blocking, this will always be equal