From: Andre Noll <maan@systemlinux.org>
Date: Thu, 1 Feb 2007 23:31:40 +0000 (+0100)
Subject: string.c: Add missing \return in documentation
X-Git-Tag: v0.2.15~45
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=dc3552c32ea6c65b9894cac0631f3591c21c06e8;hp=41c4f81a98b916d134c1dcd4593e1c013041a06b;ds=sidebyside

string.c: Add missing \return in documentation
---

diff --git a/string.c b/string.c
index 47c5417d..7db262bb 100644
--- a/string.c
+++ b/string.c
@@ -85,8 +85,8 @@ __must_check __malloc void *para_malloc(size_t size)
  *
  * A wrapper for calloc(3) which exits on errors.
  *
- * A pointer to the allocated and zeroed-out memory, which is suitably aligned
- * for any kind  of variable.
+ * \return A pointer to the allocated and zeroed-out memory, which is suitably
+ * aligned for any kind  of variable.
  *
  * \sa calloc(3)
  */
@@ -103,8 +103,8 @@ __must_check __malloc void *para_calloc(size_t size)
  *
  * \param s string to be duplicated
  *
- * A wrapper for strdup(3). It calls exit(EXIT_FAILURE) on errors, i.e. there
- * is no need to check the return value in the caller.
+ * A wrapper for strdup(3). It calls \p exit(EXIT_FAILURE) on errors, i.e.
+ * there is no need to check the return value in the caller.
  *
  * \return A pointer to the duplicated string. If \p s was the NULL pointer,
  * an pointer to an empty string is returned.