Merge a bunch of doxygen updates to header files. This includes changes to

use the \retval tag for documenting return values, fixing various warnings
when generating the documentation, and various other things.
(closes issue #10203, snuffy)


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@75164 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Russell Bryant
2007-07-16 02:51:56 +00:00
parent 5a32541671
commit 8d1e53958c
26 changed files with 566 additions and 410 deletions

View File

@@ -113,7 +113,8 @@ struct ast_jb
* appropriate internal jb flags to the channels, determining further behaviour
* of the bridged jitterbuffers.
*
* \return zero if there are no jitter buffers in use, non-zero if there are
* \retval zero if there are no jitter buffers in use
* \retval non-zero if there are
*/
int ast_jb_do_usecheck(struct ast_channel *c0, struct ast_channel *c1);
@@ -150,7 +151,8 @@ int ast_jb_get_when_to_wakeup(struct ast_channel *c0, struct ast_channel *c1, in
* Dropped by the jb implementation frames are considered successfuly enqueued as
* far as they should not be delivered at all.
*
* \return zero if the frame was queued, -1 if not.
* \retval 0 if the frame was queued
* \retval -1 if not
*/
int ast_jb_put(struct ast_channel *chan, struct ast_frame *f);