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/format.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/format.h')
| -rw-r--r-- | include/asterisk/format.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/asterisk/format.h b/include/asterisk/format.h index 61ddf9041..961b2c124 100644 --- a/include/asterisk/format.h +++ b/include/asterisk/format.h @@ -264,9 +264,9 @@ void ast_format_sdp_generate(const struct ast_format *format, unsigned int paylo * with optional format attributes represented by format specific key value pairs. * * \param format to set - * \param id, format id to set on format + * \param id format id to set on format * \param set_attributes, are there attributes to set on this format. 0 == false, 1 == True. - * \param var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END; + * \param ... var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END; * * \details Example usage. * ast_format_set(format, AST_FORMAT_ULAW, 0); // no capability attributes are needed for ULAW @@ -290,7 +290,7 @@ struct ast_format *ast_format_set(struct ast_format *format, enum ast_format_id * set additional format attributes to the structure. * * \param format to set - * \param var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END; + * \param ... var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END; * * \details Example usage. * ast_format_set(format, AST_FORMAT_SILK, 0); @@ -421,7 +421,7 @@ const char* ast_getformatname(const struct ast_format *format); /*! \brief Returns a string containing all formats pertaining to an format id. * \param buf a buffer for the output string * \param size size of buf (bytes) - * \param format id. + * \param id format id. * \return The return value is buf. */ char* ast_getformatname_multiple_byid(char *buf, size_t size, enum ast_format_id id); |