Mercurial > trustbridge
changeset 118:d6a74464430b
Fix doxygen documentation.
author | Sascha Wilde <wilde@intevation.de> |
---|---|
date | Sat, 22 Mar 2014 17:28:55 +0100 (2014-03-22) |
parents | 080660b2ce7d |
children | 24ca8e2ceecf |
files | common/strhelp.h |
diffstat | 1 files changed, 23 insertions(+), 18 deletions(-) [+] |
line wrap: on
line diff
--- 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