/soc/2013/ankitkv/gobjectification: 312f92e61d21: Fixed some doc...

Ankit Vani a at nevitus.org
Fri Nov 15 14:08:37 EST 2013


Changeset: 312f92e61d21f71eb09fec3ac7a5b22069a6c2f8
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2013-11-16 00:36 +0530
Branch:	 soc.2013.gobjectification
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/312f92e61d21

Description:

Fixed some doc comments

diffstat:

 libpurple/circularbuffer.h |  7 +++----
 1 files changed, 3 insertions(+), 4 deletions(-)

diffs (24 lines):

diff --git a/libpurple/circularbuffer.h b/libpurple/circularbuffer.h
--- a/libpurple/circularbuffer.h
+++ b/libpurple/circularbuffer.h
@@ -69,8 +69,7 @@ GType purple_circular_buffer_get_type(vo
  *                 is appended and every time more space is needed.  Pass in
  *                 "0" to use the default of 256 bytes.
  *
- * @return The new PurpleCircBuffer. This should be freed with
- *         purple_circ_buffer_destroy when you are done with it
+ * @return The new PurpleCircBuffer.
  */
 PurpleCircularBuffer *purple_circular_buffer_new(gsize growsize);
 
@@ -88,8 +87,8 @@ void purple_circular_buffer_append(Purpl
  * Determine the maximum number of contiguous bytes that can be read from the
  * PurpleCircBuffer.
  * Note: This may not be the total number of bytes that are buffered - a
- * subsequent call after calling purple_circ_buffer_mark_read() may indicate more
- * data is available to read.
+ * subsequent call after calling purple_circular_buffer_mark_read() may indicate
+ * more data is available to read.
  *
  * @param buf the PurpleCircBuffer for which to determine the maximum contiguous
  *            bytes that can be read.



More information about the Commits mailing list