From: Stephan Bosch <stephan.bosch@dovecot.fi>
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.3.8~85
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=3a3e4e8e8d6ef4fee9eaf21bec2a810682a4b5a9;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 c8a0ea8f62..423fb9ba70 100644
--- a/src/lib/buffer.h
+++ b/src/lib/buffer.h
@@ -52,10 +52,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. */