changeset 13229:cc84c3a2fe93

[gaim-migrate @ 15594] Doco! committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Sat, 11 Feb 2006 18:55:04 +0000
parents dd1996c9f3b6
children 1841236cb091
files src/gaim_buffer.h
diffstat 1 files changed, 16 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- 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;
 
 /**