diff options
| author | Matthew Jordan <mjordan@digium.com> | 2012-08-30 14:23:28 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2012-08-30 14:23:28 +0000 |
| commit | 8018b879a2a77a9408b7c848dc550c8f1ae5a15a (patch) | |
| tree | ca11d0062aa2dabe13e1ff45a2e95ceb96ba39f1 /include/asterisk/config.h | |
| parent | 4781be6e934065ab0de59455c24e757a17f3f0e8 (diff) | |
Clean up doxygen warnings
This patch fixes numerous doxygen warnings across Asterisk. It also updates
the makefile to regenerate the doxygen configuration on the local system
before running doxygen to help prevent warnings/errors on the local system.
Much thanks to Andrew for tackling one of the Asterisk janitor projects!
(issue ASTERISK-20259)
Reported by: Andrew Latham
Patches:
doxygen_partial.diff uploaded by Andrew Latham (license 5985)
make_progdocs.diff uploaded by Andrew Latham (license 5985)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@371989 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/config.h')
| -rw-r--r-- | include/asterisk/config.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/asterisk/config.h b/include/asterisk/config.h index 1f4ce2970..cd29bb362 100644 --- a/include/asterisk/config.h +++ b/include/asterisk/config.h @@ -193,7 +193,7 @@ struct ast_variable *ast_category_root(struct ast_config *config, char *cat); * \brief Sorts categories in a config in the order of a numerical value contained within them. * * \param config The config structure you wish to sort - * \param variable Which numerical value you wish to sort by + * \param comparator variable Which numerical value you wish to sort by * \param descending If true, we sort highest to lowest instead of lowest to highest * * \details @@ -741,9 +741,9 @@ enum ast_parse_flags { * * \param arg the string to parse. It is not modified. * \param flags combination of ast_parse_flags to specify the - * return type and additional checks. + * return type and additional checks. * \param result pointer to the result. NULL is valid here, and can - * be used to perform only the validity checks. + * be used to perform only the validity checks. * \param ... extra arguments are required according to flags. * * \retval 0 in case of success, != 0 otherwise. @@ -841,7 +841,7 @@ int ast_rq_is_int(require_type type), * \param chunk Data to be decoded * \return The decoded data, in the original buffer * \since 1.8 - * \warn This function modifies the original buffer + * \warning This function modifies the original buffer */ char *ast_realtime_decode_chunk(char *chunk); |