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/utils.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/utils.h')
| -rw-r--r-- | include/asterisk/utils.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/include/asterisk/utils.h b/include/asterisk/utils.h index a417cf4d3..014a62ec5 100644 --- a/include/asterisk/utils.h +++ b/include/asterisk/utils.h @@ -858,7 +858,6 @@ int ast_eid_cmp(const struct ast_eid *eid1, const struct ast_eid *eid2); /*! * \brief Get current thread ID - * \param None * \return the ID if platform is supported, else -1 */ int ast_get_tid(void); @@ -897,12 +896,14 @@ char *ast_utils_which(const char *binary, char *fullpath, size_t fullpath_size); * RAII_VAR(struct mything *, thing, mything_alloc(name), mything_cleanup); * ... * } + * \endcode * * \note This macro is especially useful for working with ao2 objects. A common idiom * would be a function that needed to look up an ao2 object and might have several error * conditions after the allocation that would normally need to unref the ao2 object. * With RAII_VAR, it is possible to just return and leave the cleanup to the destructor * function. For example: + * * \code * void do_stuff(const char *name) * { @@ -915,7 +916,7 @@ char *ast_utils_which(const char *binary, char *fullpath, size_t fullpath_size); * } * do_stuff_with_thing(thing); * } - * \encode + * \endcode */ #define RAII_VAR(vartype, varname, initval, dtor) \ auto void _dtor_ ## varname (vartype * v); \ |