aboutsummaryrefslogtreecommitdiffstats
path: root/include/asterisk/strings.h
diff options
context:
space:
mode:
authorrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2005-10-26 23:11:36 +0000
committerrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2005-10-26 23:11:36 +0000
commit4cc87ee6e1e0ad07889f178b9c843fdd55d826e8 (patch)
tree3daabf628fa6034d2213644799cc8dedace8fd20 /include/asterisk/strings.h
parent2a1fd152edcbcad451a31a94171be354f9cbc94d (diff)
clean up a lot of doxygen errors and warnings (issue #5522)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@6865 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/strings.h')
-rwxr-xr-xinclude/asterisk/strings.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/include/asterisk/strings.h b/include/asterisk/strings.h
index 715061216..370d4281c 100755
--- a/include/asterisk/strings.h
+++ b/include/asterisk/strings.h
@@ -37,6 +37,7 @@ static 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
\return a pointer to the first non-whitespace character
*/
@@ -51,6 +52,7 @@ char *ast_skip_blanks(char *str),
/*!
\brief Trims trailing whitespace characters from a string.
+ \param ast_trim_blanks function being used
\param str the input string
\return a pointer to the NULL following the string
*/
@@ -76,6 +78,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
\return a pointer to the first whitespace character
*/
@@ -135,6 +138,7 @@ 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
@@ -167,10 +171,10 @@ 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.
- \return 0 on success, non-zero on failure.
\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
+ \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)));