/soc/2013/ankitkv/gobjectification: 97a1341f4601: Added doc comm...

[Ankit Vani]

Changeset: 97a1341f46010ef811c8b86826c1ecdec35a49c1
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2013-11-16 00:34 +0530
Branch:	 soc.2013.gobjectification
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/97a1341f4601

Description:

Added doc comments for PurpleCirclularBufferPrivate members

diffstat:

 libpurple/circularbuffer.c |  16 +++++++++++++++-
 1 files changed, 15 insertions(+), 1 deletions(-)

diffs (31 lines):

diff --git a/libpurple/circularbuffer.c b/libpurple/circularbuffer.c
--- a/libpurple/circularbuffer.c
+++ b/libpurple/circularbuffer.c
@@ -34,12 +34,26 @@
  * Structs
  *****************************************************************************/
 typedef struct {
+	/** A pointer to the starting address of our chunk of memory. */
 	gchar *buffer;
+
+	/** The incremental amount to increase this buffer by when
+	 *  the buffer is not big enough to hold incoming data, in bytes. */
 	gsize growsize;
+
+	/** The length of this buffer, in bytes. */
 	gsize buflen;
+
+	/** The number of bytes of this buffer that contain unread data. */
 	gsize bufused;
+
+	/** A pointer to the next byte where new incoming data is
+	 *  buffered to. */
 	gchar *input;
-	gchar *output;
+
+	/** A pointer to the next byte of buffered data that should be
+	 *  read by the consumer. */
+	gchar *output;	
 } PurpleCircularBufferPrivate;
 
 /******************************************************************************