src/cx/buffer.h

changeset 1284
b2103354baed
parent 1181
183bf43aa9b9
--- a/src/cx/buffer.h	Fri Apr 11 15:12:20 2025 +0200
+++ b/src/cx/buffer.h	Fri Apr 11 16:45:20 2025 +0200
@@ -674,11 +674,10 @@
 /**
  * Writes a terminating zero to a buffer at the current position.
  *
- * On successful write, @em neither the position @em nor the size of the buffer is
- * increased.
+ * If successful, sets the size to the current position and advances the position by one.
  *
  * The purpose of this function is to have the written data ready to be used as
- * a C string.
+ * 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

mercurial