diff -r cc123f0d84af -r 00f876b129bc libpurple/circularbuffer.h --- a/libpurple/circularbuffer.h Fri Jan 31 17:56:27 2014 +0530 +++ b/libpurple/circularbuffer.h Fri Jan 31 18:14:33 2014 +0530 @@ -65,11 +65,11 @@ * Creates a new circular buffer. This will not allocate any memory for the * actual buffer until data is appended to it. * - * @param growsize The amount that the buffer should grow the first time data + * @growsize: The amount that the buffer should grow the first time data * is appended and every time more space is needed. Pass in * "0" to use the default of 256 bytes. * - * @return The new PurpleCircularBuffer. + * Returns: The new PurpleCircularBuffer. */ PurpleCircularBuffer *purple_circular_buffer_new(gsize growsize); @@ -77,9 +77,9 @@ * Append data to the PurpleCircularBuffer. This will grow the internal * buffer to fit the added data, if needed. * - * @param buf The PurpleCircularBuffer to which to append the data - * @param src pointer to the data to copy into the buffer - * @param len number of bytes to copy into the buffer + * @buf: The PurpleCircularBuffer to which to append the data + * @src: pointer to the data to copy into the buffer + * @len: number of bytes to copy into the buffer */ void purple_circular_buffer_append(PurpleCircularBuffer *buf, gconstpointer src, gsize len); @@ -90,20 +90,20 @@ * subsequent call after calling purple_circular_buffer_mark_read() may indicate * more data is available to read. * - * @param buf the PurpleCircularBuffer for which to determine the maximum + * @buf: the PurpleCircularBuffer for which to determine the maximum * contiguous bytes that can be read. * - * @return the number of bytes that can be read from the PurpleCircularBuffer + * Returns: the number of bytes that can be read from the PurpleCircularBuffer */ gsize purple_circular_buffer_get_max_read(const PurpleCircularBuffer *buf); /** * Mark the number of bytes that have been read from the buffer. * - * @param buf The PurpleCircularBuffer to mark bytes read from - * @param len The number of bytes to mark as read + * @buf: The PurpleCircularBuffer to mark bytes read from + * @len: The number of bytes to mark as read * - * @return TRUE if we successfully marked the bytes as having been read, FALSE + * Returns: TRUE if we successfully marked the bytes as having been read, FALSE * otherwise. */ gboolean purple_circular_buffer_mark_read(PurpleCircularBuffer *buf, gsize len); @@ -112,8 +112,8 @@ * Increases the buffer size by a multiple of grow size, so that it can hold at * least 'len' bytes. * - * @param buffer The PurpleCircularBuffer to grow. - * @param len The number of bytes the buffer should be able to hold. + * @buffer: The PurpleCircularBuffer to grow. + * @len: The number of bytes the buffer should be able to hold. */ void purple_circular_buffer_grow(PurpleCircularBuffer *buffer, gsize len); @@ -121,18 +121,18 @@ * Returns the number of bytes by which the buffer grows when more space is * needed. * - * @param buffer The PurpleCircularBuffer from which to get grow size. + * @buffer: The PurpleCircularBuffer from which to get grow size. * - * @return The grow size of the buffer. + * Returns: The grow size of the buffer. */ gsize purple_circular_buffer_get_grow_size(const PurpleCircularBuffer *buffer); /** * Returns the number of bytes of this buffer that contain unread data. * - * @param buffer The PurpleCircularBuffer from which to get used count. + * @buffer: The PurpleCircularBuffer from which to get used count. * - * @return The number of bytes that contain unread data. + * Returns: The number of bytes that contain unread data. */ gsize purple_circular_buffer_get_used(const PurpleCircularBuffer *buffer); @@ -142,16 +142,16 @@ * contiguous bytes that can be read from this output. After reading the data, * call purple_circular_buffer_mark_read() to mark the retrieved data as read. * - * @param buffer The PurpleCircularBuffer from which to get the output pointer. + * @buffer: The PurpleCircularBuffer from which to get the output pointer. * - * @return The output pointer for the buffer. + * Returns: The output pointer for the buffer. */ const gchar *purple_circular_buffer_get_output(const PurpleCircularBuffer *buffer); /** * Resets the buffer contents. * - * @param buffer The PurpleCircularBuffer to reset. + * @buffer: The PurpleCircularBuffer to reset. */ void purple_circular_buffer_reset(PurpleCircularBuffer *buffer);