Changeset 1249Tweet

Timestamp:

Oct 27, 2006, 10:40:24 PM (15 years ago)

Author:

Sam Hocevar

Message:

• Reworded documentation about buffer/string distinction.

File:

• libcaca/trunk/cucul/buffer.c (modified) (1 diff)

libcaca/trunk/cucul/buffer.c

@@ -32 +32 @@
  *  Create a \e libcucul buffer that points to the given memory area. The
  *  data is not duplicated and any changes made to the original memory area
- *  will appear in the buffer. If you are importing a string, the
- *  terminating zero must NOT be counted in size.
+ *  will appear in the buffer.
+ *
+ *  Keep in mind that buffers are not strings. When loading a C string, the
+ *  terminating '\0' must not be part of the buffer, hence \e size should
+ *  be computed with strlen(). Conversely, the '\0' is not appended to
+ *  exported buffers even when they could be parsed as strings.
  *
  *  \param data The memory area to load.