# HG changeset patch
# User Mark Doliner <mark@kingant.net>
# Date 1139684104 0
# Node ID cc84c3a2fe930717c945047dc99c649d837ccdf4
# Parent  dd1996c9f3b64ce9c922a38272e16ac5096558ec
[gaim-migrate @ 15594]
Doco!

committer: Tailor Script <tailor@pidgin.im>

diff -r dd1996c9f3b6 -r cc84c3a2fe93 src/gaim_buffer.h
--- a/src/gaim_buffer.h	Sat Feb 11 18:16:58 2006 +0000
+++ b/src/gaim_buffer.h	Sat Feb 11 18:55:04 2006 +0000
@@ -28,12 +28,28 @@
 #endif
 
 typedef struct _GaimCircBuffer {
+
+	/** 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 *inptr;
+
+	/** A pointer to the next byte of buffered data that should be
+	 *  by the consumer. */
 	gchar *outptr;
+
 } GaimCircBuffer;
 
 /**