diff src/gaim_buffer.h @ 13212:64bae3cbec8d

[gaim-migrate @ 15576] Mostly documentation. Is there any reason the if statement was written the way it was? This seems more clear to me. Also, gaim_buffer.c doesn't seem like the best name for this. I mean, it's a part of Gaim, does it really need "gaim" in the filename? circbuffer.c seems better to me. Anyone else have an opinion? Because you're wrong. No, just kidding. committer: Tailor Script <[e-mail]>

--- a/src/gaim_buffer.h	Fri Feb 10 05:14:46 2006 +0000
+++ b/src/gaim_buffer.h	Fri Feb 10 06:07:19 2006 +0000
@@ -40,8 +40,9 @@
  * Creates a new circular buffer.  This will not allocate any memory for the
  * actual buffer until data is appended to it.
  *
- * @param growsize The size that the buffer should grow by the first time data
- *                 is appended and every time more space is needed.
+ * @param growsize The amount that the buffer should grow the first time data
+ *                 is appended and every time more space is needed.  Pass in
+ *                 "0" to use the default of 256 bytes.
  *
  * @return The new GaimCircBuffer. This should be freed with
  *         gaim_circ_buffer_destroy when you are done with it
@@ -57,8 +58,8 @@
 void gaim_circ_buffer_destroy(GaimCircBuffer *buf);
 
 /**
- * Append data to the GaimCircBuffer.  This will automatically grow the internal
- * buffer to fit the added data.
+ * Append data to the GaimCircBuffer.  This will grow the internal
+ * buffer to fit the added data, if needed.
  *
  * @param buf The GaimCircBuffer to which to append the data
  * @param src pointer to the data to copy into the buffer