diff options
author | Russell Bryant <russell@russellbryant.com> | 2007-06-07 23:07:25 +0000 |
---|---|---|
committer | Russell Bryant <russell@russellbryant.com> | 2007-06-07 23:07:25 +0000 |
commit | 1d57ccb6f70f41fb1a50fa9546b8a380bc234d5c (patch) | |
tree | 63511aee5f2aa3d7e507b9e82756c21260f94d8b /include/asterisk/strings.h | |
parent | 0ac54224864a78d53827944aa1ebb0e79b526a61 (diff) |
Fix a bunch of doxygen errors and document more things
(issue #9842, snuffy)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@68339 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/strings.h')
-rw-r--r-- | include/asterisk/strings.h | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/include/asterisk/strings.h b/include/asterisk/strings.h index 91a3b078a..ab610982c 100644 --- a/include/asterisk/strings.h +++ b/include/asterisk/strings.h @@ -47,7 +47,7 @@ static force_inline int ast_strlen_zero(const char *s) /*! \brief Gets a pointer to the first non-whitespace character in a string. \param ast_skip_blanks function being used - \param str the input string + \arg str the input string \return a pointer to the first non-whitespace character */ AST_INLINE_API( @@ -61,8 +61,8 @@ char *ast_skip_blanks(const char *str), /*! \brief Trims trailing whitespace characters from a string. - \param ast_trim_blanks function being used - \param str the input string + \param ast_skip_blanks function being used + \arg str the input string \return a pointer to the modified string */ AST_INLINE_API( @@ -88,7 +88,7 @@ char *ast_trim_blanks(char *str), /*! \brief Gets a pointer to first whitespace character in a string. \param ast_skip_noblanks function being used - \param str the input string + \arg str the input string \return a pointer to the first whitespace character */ AST_INLINE_API( @@ -102,7 +102,8 @@ char *ast_skip_nonblanks(char *str), /*! \brief Strip leading/trailing whitespace from a string. - \param s The string to be stripped (will be modified). + \param ast_strip function ast_strip being used. + \arg s The string to be stripped (will be modified). \return The stripped string. This functions strips all leading and trailing whitespace @@ -147,10 +148,9 @@ char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes); /*! \brief Size-limited null-terminating string copy. - \param ast_copy_string function being used - \param dst The destination buffer. - \param src The source string - \param size The size of the destination buffer + \arg dst The destination buffer. + \arg src The source string + \arg size The size of the destination buffer \return Nothing. This is similar to \a strncpy, with two important differences: @@ -183,9 +183,9 @@ void ast_copy_string(char *dst, const char *src, size_t size), This is a wrapper for snprintf, that properly handles the buffer pointer and buffer space available. - \param buffer current position in buffer to place string into (will be updated on return) - \param space remaining space in buffer (will be updated on return) - \param fmt printf-style format string + \arg buffer current position in buffer to place string into (will be updated on return) + \arg space remaining space in buffer (will be updated on return) + \arg fmt printf-style format string \return 0 on success, non-zero on failure. */ int ast_build_string(char **buffer, size_t *space, const char *fmt, ...) __attribute__ ((format (printf, 3, 4))); |