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/framehook.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/framehook.h')
| -rw-r--r-- | include/asterisk/framehook.h | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/include/asterisk/framehook.h b/include/asterisk/framehook.h index 0b2e6cd95..52993b55c 100644 --- a/include/asterisk/framehook.h +++ b/include/asterisk/framehook.h @@ -219,9 +219,9 @@ struct ast_framehook_interface { * \brief Attach an framehook onto a channel for frame interception. * \since 1.8 * - * \param ast_channel, The channel to attach the hook on to. - * \param framehook interface, The framehook's callback functions and stored data. -* + * \param chan ast_channel The channel to attach the hook on to. + * \param i framehook interface, The framehook's callback functions and stored data. + * * \pre XXX The Channel must be locked during this function all. * * \note The data pointer is never touched by the framehook API except to @@ -242,8 +242,8 @@ int ast_framehook_attach(struct ast_channel *chan, struct ast_framehook_interfac * the framehook will be detached and destroyed during channel * destruction. * - * \param The channel the framehook is attached to - * \param The framehook's id + * \param chan The channel the framehook is attached to + * \param framehook_id The framehook's id * * \retval 0 success * \retval -1 framehook did not exist on the channel. This means the @@ -258,7 +258,7 @@ int ast_framehook_detach(struct ast_channel *chan, int framehook_id); * * \pre XXX The Channel must be locked during this function all. * - * \param channel containing the framehook list to destroy. + * \param chan channel containing the framehook list to destroy. * \retval 0 success * \retval -1 failure */ @@ -274,7 +274,7 @@ int ast_framehook_list_destroy(struct ast_channel *chan); * * \pre XXX The Channel must be locked during this function all. * - * \param framehook list to push event to. + * \param framehooks list to push event to. * \param frame being pushed to the framehook list. * * \return The resulting frame after being viewed and modified by the framehook callbacks. @@ -291,7 +291,7 @@ struct ast_frame *ast_framehook_list_read_event(struct ast_framehook_list *frame * * \pre XXX The Channel must be locked during this function all. * - * \param framehook list to push event to. + * \param framehooks list to push event to. * \param frame being pushed to the framehook list. * * \return The resulting frame after being viewed and modified by the framehook callbacks. @@ -303,7 +303,7 @@ struct ast_frame *ast_framehook_list_write_event(struct ast_framehook_list *fram * \since 1.8 * \pre XXX The Channel must be locked during this function all. * - * \param the framehook list + * \param framehooks the framehook list * \retval 0, not empty * \retval 1, is empty */ |