summaryrefslogtreecommitdiff
path: root/glib/src/iochannel.hg
diff options
context:
space:
mode:
Diffstat (limited to 'glib/src/iochannel.hg')
-rw-r--r--glib/src/iochannel.hg12
1 files changed, 6 insertions, 6 deletions
diff --git a/glib/src/iochannel.hg b/glib/src/iochannel.hg
index 5df0ebc5..00e49e36 100644
--- a/glib/src/iochannel.hg
+++ b/glib/src/iochannel.hg
@@ -158,7 +158,7 @@ public:
#endif /* G_OS_WIN32 */
/** Read a single UCS-4 character.
- * @retval thechar The Unicode character.
+ * @param[out] thechar The Unicode character.
* @return The status of the operation.
* @throw Glib::IOChannelError
* @throw Glib::ConvertError
@@ -170,7 +170,7 @@ public:
* @param count The size of the buffer in bytes. Note that the buffer may
* not be complelely filled even if there is data in the buffer if the
* remaining data is not a complete character.
- * @retval bytes_read The number of bytes read. This may be zero even on
+ * @param[out] bytes_read The number of bytes read. This may be zero even on
* success if @a count < 6 and the channel's encoding is not <tt>""</tt>.
* This indicates that the next UTF-8 character is too wide for the buffer.
* @return The status of the operation.
@@ -181,8 +181,8 @@ public:
g_io_channel_read_chars, errthrow)
/** Read a maximum of @a count bytes into @a str.
+ * @param[out] str The characters that have been read.
* @param count The maximum number of bytes to read.
- * @retval str The characters that have been read.
* @return The status of the operation.
* @throw Glib::IOChannelError
* @throw Glib::ConvertError
@@ -192,7 +192,7 @@ public:
/** Read a whole line.
* Reads until the line separator is found, which is included
* in the result string.
- * @retval line The line that was read.
+ * @param[out] line The line that was read.
* @return The status of the operation.
* @throw Glib::IOChannelError
* @throw Glib::ConvertError
@@ -201,7 +201,7 @@ public:
_IGNORE(g_io_channel_read_line, g_io_channel_read_line_string)
/** Reads all the remaining data from the file.
- * @retval str The resulting string.
+ * @param[out] str The resulting string.
* @return Glib::IO_STATUS_NORMAL on success. This function never
* returns Glib::IO_STATUS_EOF.
* @throw Glib::IOChannelError
@@ -224,7 +224,7 @@ public:
/** Write a memory area of @a count bytes to the I/O channel.
* @param buf The start of the memory area.
* @param count The number of bytes to write.
- * @retval bytes_written The number of bytes written to the channel.
+ * @param[out] bytes_written The number of bytes written to the channel.
* @return The status of the operation.
* @throw Glib::IOChannelError
* @throw Glib::ConvertError