Added doc comments for PurpleCirclularBufferPrivate members

1 files changed, 15 insertions, 1 deletions

diff --git a/libpurple/circularbuffer.c b/libpurple/circularbuffer.c
index 0e75957d5e..e38bea23dc 100644
--- 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;
 
 /******************************************************************************