string.c: Add missing \return in documentation

[paraslash.git] / string.c

diff --git a/string.c b/string.c
index 47c5417df576a56c1d710137c02182a3b7600fa5..7db262bb8f0e200d8fb07372772f8bd5ae4f04b4 100644 (file)
--- 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 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)
  */
  *
  * \sa calloc(3)
  */


@@ -103,8 +103,8 @@ __must_check __malloc void *para_calloc(size_t size)
  *
  * \param s string to be duplicated
  *
  *
  * \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.
  *
  * \return A pointer to the duplicated string. If \p s was the NULL pointer,
  * an pointer to an empty string is returned.