doc: Avoid \0 in comments.
authorAndre Noll <maan@systemlinux.org>
Wed, 14 Mar 2012 13:41:50 +0000 (14:41 +0100)
committerAndre Noll <maan@systemlinux.org>
Wed, 14 Mar 2012 13:41:50 +0000 (14:41 +0100)
Doxygen treats \0 as a command, spits out a warning and produces
no output.

string.c

index a1f2a43..aa3bcbd 100644 (file)
--- a/string.c
+++ b/string.c
@@ -128,7 +128,8 @@ __must_check __malloc char *para_strdup(const char *s)
  * function calls exit() if insufficient memory is available, while vasprintf()
  * returns -1 in this case.
  *
- * \return Number of bytes written, not including the terminating '\0'.
+ * \return Number of bytes written, not including the terminating \p NULL
+ * character.
  *
  * \sa printf(3), vsnprintf(3), va_start(3), vasprintf(3), \ref xasprintf().
  */