diff options
author | oej <oej@f38db490-d61c-443f-a65b-d21fe96a405b> | 2006-10-30 16:27:34 +0000 |
---|---|---|
committer | oej <oej@f38db490-d61c-443f-a65b-d21fe96a405b> | 2006-10-30 16:27:34 +0000 |
commit | 961ed4851e33ad8ee83ceadd5910c03cfe338a44 (patch) | |
tree | 83975a680d96b8a3392611411c7e8398094d818c /include/asterisk/channel.h | |
parent | e0e1cd85985ee346aad8d30e7f77c7bdac9d625a (diff) |
Issue #8246 - Doxygen fixes from kshumard.
An extra big thankyou is given to everyone that contributes to doxygen!
THANK YOU!
git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.4@46433 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/channel.h')
-rw-r--r-- | include/asterisk/channel.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h index 0d06ef613..a08a013a4 100644 --- a/include/asterisk/channel.h +++ b/include/asterisk/channel.h @@ -798,6 +798,8 @@ struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n, int *f /*! \brief Waits for input on a group of channels Wait for input on an array of channels for a given # of milliseconds. \return Return channel with activity, or NULL if none has activity. + \param chan an array of pointers to channels + \param n number of channels that are to be waited upon \param ms time "ms" is modified in-place, if applicable */ struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms); @@ -925,9 +927,11 @@ struct ast_channel *ast_walk_channel_by_exten_locked(const struct ast_channel *c int ast_waitfordigit(struct ast_channel *c, int ms); /*! \brief Wait for a digit - Same as ast_waitfordigit() with audio fd for outputing read audio and ctrlfd to monitor for reading. + Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading. * \param c channel to wait for a digit on * \param ms how many milliseconds to wait + * \param audiofd audio file descriptor to write to if audio frames are received + * \param ctrlfd control file descriptor to monitor for reading * \return Returns 1 if ctrlfd becomes available */ int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd); @@ -1004,7 +1008,7 @@ int ast_str2cause(const char *name) attribute_pure; /*! Gives the string form of a given channel state */ /*! - * \param state state to get the name of + * \param ast_channel_state state to get the name of * Give a name to a state * Returns the text form of the binary state given */ @@ -1334,6 +1338,7 @@ int ast_channel_whisper_start(struct ast_channel *chan); /*! \brief Feed an audio frame into the whisper buffer on a channel \param chan The channel to whisper onto + \param f The frame to to whisper onto chan \return 0 for success, non-zero for failure */ int ast_channel_whisper_feed(struct ast_channel *chan, struct ast_frame *f); |