# HG changeset patch
# User Sascha Wilde <wilde@intevation.de>
# Date 1395505735 -3600
# Node ID d6a74464430b961dd67ad16bd0d57d2765e2e0c1
# Parent  080660b2ce7d0d9da3ba2a59f21d3502127cfe98
Fix doxygen documentation.

diff -r 080660b2ce7d -r d6a74464430b common/strhelp.h
--- a/common/strhelp.h	Fri Mar 21 17:46:09 2014 +0100
+++ b/common/strhelp.h	Sat Mar 22 17:28:55 2014 +0100
@@ -1,45 +1,50 @@
 #ifndef STRHELP_H
 #define STRHELP_H
-/* @file Helper functions for c strings and memory management
- *
- * strhelp contains terminating memory allocation functions and
- * some conveniance functions to work with c strings or arrays
- * of c strings.
+
+/**
+ * @file  strhelp.h
+ * @brief Helper functions for c strings and memory management
+ * @details strhelp contains terminating memory allocation functions and
+ * some conveniance functions to work with c strings or arrays of c
+ * strings.
  */
+
 void *xmalloc( size_t n );
 void *xrealloc( void *a, size_t n );
 void *xcalloc( size_t n, size_t m );
 char *xstrndup( const char *string, const size_t len );
 
 /**
- * strv_length:
- * @str_array: a %NULL-terminated array of strings
- *
- * Returns the length of the given %NULL-terminated
- * string array @str_array.
- *
- * Return value: length of @str_array.
- *
+ * @brief Returns the length of the given %NULL-terminated
+ * string array str_array.
+ * @param[in] str_array a %NULL-terminated array of strings 
+ * @returns length of str_array.
  */
 unsigned int strv_length (char **str_array);
 
-/* @brief append a string to a NULL terminated array of strings.
+/**
+ * @brief append a string to a NULL terminated array of strings.
  *
- * @param[inout] array pointer to the NULL terminated list of string pointers.
+ * @param[inout] pArray pointer to the NULL terminated list of string pointers.
  * @param[in] string pointer to the string to append to the list.
  * @param[in] len length of the string to append to the list
- * */
+ */
 void strv_append (char ***pArray, const char *string, const size_t len);
 
-/* @brief append a string to another string.
+/**
+ * @brief append a string to another string.
  *
  * @param[inout] pDst pointer to the string to be extended.
  * @param[inout] dst_len length of the dst string. Will be modified.
  * @param[in] appendage pointer to the string to append.
  * @param[in] len length of the string to append.
- * */
+ */
 void str_append_str (char **pDst, size_t *dst_len, const char *appendage,
                     const size_t len);
 
+/**
+ * @brief Frees the given %NULL-terminated string array.
+ * @param[inout] str_array a %NULL-terminated array of strings 
+ */
 void strv_free (char **str_array);
 #endif