comparison 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]>

13211:ca559e2b1d0a

/**
 * 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.
 *
 * @return The new GaimCircBuffer. This should be freed with
 *         gaim_circ_buffer_destroy when you are done with it
 */
GaimCircBuffer *gaim_circ_buffer_new(gsize growsize);

 * @param buf The GaimCircBuffer to free
 */
void gaim_circ_buffer_destroy(GaimCircBuffer *buf);

/**
 * Append data to the GaimCircBuffer.  This will automatically grow the internal
 * buffer to fit the added data.
 *
 * @param buf The GaimCircBuffer to which to append the data
 * @param src pointer to the data to copy into the buffer
 * @param len number of bytes to copy into the buffer
 */

13212:64bae3cbec8d

/**
 * Creates a new circular buffer.  This will not allocate any memory for the
 * actual buffer until data is appended to it.
 *
 * @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
 */
GaimCircBuffer *gaim_circ_buffer_new(gsize growsize);

 * @param buf The GaimCircBuffer to free
 */
void gaim_circ_buffer_destroy(GaimCircBuffer *buf);

/**
 * 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
 * @param len number of bytes to copy into the buffer
 */