Mercurial > pidgin.yaz
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 <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Fri, 10 Feb 2006 06:07:19 +0000 |
parents | 33bef17125c2 |
children | cc84c3a2fe93 |
comparison
equal
deleted
inserted
replaced
13211:ca559e2b1d0a | 13212:64bae3cbec8d |
---|---|
38 | 38 |
39 /** | 39 /** |
40 * Creates a new circular buffer. This will not allocate any memory for the | 40 * Creates a new circular buffer. This will not allocate any memory for the |
41 * actual buffer until data is appended to it. | 41 * actual buffer until data is appended to it. |
42 * | 42 * |
43 * @param growsize The size that the buffer should grow by the first time data | 43 * @param growsize The amount that the buffer should grow the first time data |
44 * is appended and every time more space is needed. | 44 * is appended and every time more space is needed. Pass in |
45 * "0" to use the default of 256 bytes. | |
45 * | 46 * |
46 * @return The new GaimCircBuffer. This should be freed with | 47 * @return The new GaimCircBuffer. This should be freed with |
47 * gaim_circ_buffer_destroy when you are done with it | 48 * gaim_circ_buffer_destroy when you are done with it |
48 */ | 49 */ |
49 GaimCircBuffer *gaim_circ_buffer_new(gsize growsize); | 50 GaimCircBuffer *gaim_circ_buffer_new(gsize growsize); |
55 * @param buf The GaimCircBuffer to free | 56 * @param buf The GaimCircBuffer to free |
56 */ | 57 */ |
57 void gaim_circ_buffer_destroy(GaimCircBuffer *buf); | 58 void gaim_circ_buffer_destroy(GaimCircBuffer *buf); |
58 | 59 |
59 /** | 60 /** |
60 * Append data to the GaimCircBuffer. This will automatically grow the internal | 61 * Append data to the GaimCircBuffer. This will grow the internal |
61 * buffer to fit the added data. | 62 * buffer to fit the added data, if needed. |
62 * | 63 * |
63 * @param buf The GaimCircBuffer to which to append the data | 64 * @param buf The GaimCircBuffer to which to append the data |
64 * @param src pointer to the data to copy into the buffer | 65 * @param src pointer to the data to copy into the buffer |
65 * @param len number of bytes to copy into the buffer | 66 * @param len number of bytes to copy into the buffer |
66 */ | 67 */ |