From: Stephan Bosch Date: Sun, 17 Mar 2019 23:52:37 +0000 (+0100) Subject: lib: buffer - Improve header comment for buffer_insert() and buffer_delete(). X-Git-Tag: 2.2.36.4~8 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=1a9502032c094a0e7ea9c9335c0ec4c10752be5c;p=thirdparty%2Fdovecot%2Fcore.git lib: buffer - Improve header comment for buffer_insert() and buffer_delete(). --- diff --git a/src/lib/buffer.h b/src/lib/buffer.h index 3428e60dec..601d1b43be 100644 --- a/src/lib/buffer.h +++ b/src/lib/buffer.h @@ -51,10 +51,13 @@ void buffer_append(buffer_t *buf, const void *data, size_t data_size); /* Append character to buffer. */ void buffer_append_c(buffer_t *buf, unsigned char chr); -/* Insert data to buffer. */ +/* Insert the provided data into the buffer at position pos. If pos points past + the current buffer size, the gap is zero-filled. */ void buffer_insert(buffer_t *buf, size_t pos, const void *data, size_t data_size); -/* Delete data from buffer. */ +/* Delete data with the indicated size from the buffer at position pos. The + deleted block may cross the current buffer size boundary, which is ignored. + */ void buffer_delete(buffer_t *buf, size_t pos, size_t size); /* Fill buffer with zero bytes. */