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/audiohook.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/audiohook.h')
| -rw-r--r-- | include/asterisk/audiohook.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/asterisk/audiohook.h b/include/asterisk/audiohook.h index 5e8fc1812..516c59f6d 100644 --- a/include/asterisk/audiohook.h +++ b/include/asterisk/audiohook.h @@ -154,10 +154,10 @@ struct ast_frame *ast_audiohook_read_frame(struct ast_audiohook *audiohook, size /*! \brief Reads a frame in from the audiohook structure in mixed audio mode and copies read and write frame data to provided arguments. * \param audiohook Audiohook structure * \param samples Number of samples wanted - * \param direction Direction the audio frame came from - * \param format Format of frame remote side wants back - * \param ast_frame read_frame - if available, we'll copy the read buffer to this. - * \param ast_frame write_frame - if available, we'll copy the write buffer to this. + * \param ast_format Format of frame remote side wants back + * \param read_frame if available, we'll copy the read buffer to this. + * \param write_frame if available, we'll copy the write buffer to this. + * \param direction * \return Returns frame on success, NULL on failure */ struct ast_frame *ast_audiohook_read_frame_all(struct ast_audiohook *audiohook, size_t samples, struct ast_format *format, struct ast_frame **read_frame, struct ast_frame **write_frame); |