summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnkit Vani <a@nevitus.org>2013-11-16 00:34:04 +0530
committerAnkit Vani <a@nevitus.org>2013-11-16 00:34:04 +0530
commitbdf833c00dd3f427a26ff0659662f73b1471c97b (patch)
tree660b1f8921f760c8c8a022258a770018a4bbb418
parent91611d9207cb4774e074f8f3aaab74088e9bda79 (diff)
downloadpidgin-bdf833c00dd3f427a26ff0659662f73b1471c97b.tar.gz
Added doc comments for PurpleCirclularBufferPrivate members
-rw-r--r--libpurple/circularbuffer.c16
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;
/******************************************************************************