Mercurial > hg > ucx / file diff

--- a/src/cx/buffer.h	Thu Dec 11 23:07:24 2025 +0100
+++ b/src/cx/buffer.h	Thu Dec 11 23:47:46 2025 +0100
@@ -545,14 +545,14 @@
 /**
  * Writes a terminating zero to a buffer at the current position.
  *
- * If successful, sets the size to the current position and advances
- * the position by one.
+ * If successful, also sets the size to the current position and shrinks the buffer.
  *
  * The purpose of this function is to have the written data ready to be used as
  * a C string with the buffer's size being the length of that string.
  *
  * @param buffer the buffer to write to
  * @return zero, if the terminator could be written, non-zero otherwise
+ * @see cxBufferShrink()
  */
 cx_attr_nonnull
 CX_EXPORT int cxBufferTerminate(CxBuffer *buffer);