diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/asterisk/channel.h | 9 | ||||
| -rw-r--r-- | include/asterisk/doxyref.h | 9 | ||||
| -rw-r--r-- | include/asterisk/file.h | 6 | ||||
| -rw-r--r-- | include/asterisk/frame.h | 2 | ||||
| -rw-r--r-- | include/asterisk/lock.h | 2 | ||||
| -rw-r--r-- | include/asterisk/module.h | 4 |
6 files changed, 17 insertions, 15 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); diff --git a/include/asterisk/doxyref.h b/include/asterisk/doxyref.h index e9fb63110..49e282816 100644 --- a/include/asterisk/doxyref.h +++ b/include/asterisk/doxyref.h @@ -119,7 +119,7 @@ DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it pub * \arg \ref cdr_drivers * \arg \ref Config_cdr CDR configuration files * - * \verbinclude cdr.txt + * \verbinclude cdrdriver.txt */ /*! \page AstREADME README - the general administrator introduction @@ -427,14 +427,11 @@ DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it pub /*! \page SoundFiles Sound files * \section SecSound Asterisk Sound files - * Asterisk includes a large amount of sound files. Many of these + * Asterisk includes a large number of sound files. Many of these * are used by applications and demo scripts within asterisk. * * Additional sound files are available in the asterisk-addons - * repository on cvs.digium.com - * - * \section SoundList List of included sound files - * \verbinclude sounds.txt + * repository on svn.digium.com */ /*! \addtogroup cdr_drivers Module: CDR Drivers diff --git a/include/asterisk/file.h b/include/asterisk/file.h index bf7efef89..029bcf25d 100644 --- a/include/asterisk/file.h +++ b/include/asterisk/file.h @@ -218,7 +218,7 @@ int ast_filecopy(const char *oldname, const char *newname, const char *fmt); /*! Waits for a stream to stop or digit to be pressed */ /*! - * \param c channel to waitstram on + * \param c channel to waitstream on * \param breakon string of DTMF digits to break upon * Begins playback of a stream... * Wait for a stream to stop or for any one of a given digit to arrive, Returns 0 @@ -228,7 +228,7 @@ int ast_waitstream(struct ast_channel *c, const char *breakon); /*! Waits for a stream to stop or digit matching a valid one digit exten to be pressed */ /*! - * \param c channel to waitstram on + * \param c channel to waitstream on * \param context string of context to match digits to break upon * Begins playback of a stream... * Wait for a stream to stop or for any one of a valid extension digit to arrive, Returns 0 @@ -238,7 +238,7 @@ int ast_waitstream_exten(struct ast_channel *c, const char *context); /*! Same as waitstream but allows stream to be forwarded or rewound */ /*! - * \param c channel to waitstram on + * \param c channel to waitstream on * \param breakon string of DTMF digits to break upon * \param forward DTMF digit to fast forward upon * \param rewind DTMF digit to rewind upon diff --git a/include/asterisk/frame.h b/include/asterisk/frame.h index fa1c12891..cc3aa5d83 100644 --- a/include/asterisk/frame.h +++ b/include/asterisk/frame.h @@ -473,7 +473,7 @@ struct ast_frame *ast_smoother_read(struct ast_smoother *s); void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix); -/*! \par AudioCodecPref Audio Codec Preferences +/*! \page AudioCodecPref Audio Codec Preferences In order to negotiate audio codecs in the order they are configured in <channel>.conf for a device, we set up codec preference lists in addition to the codec capabilities setting. The capabilities diff --git a/include/asterisk/lock.h b/include/asterisk/lock.h index 2f63ee183..bcd2fdabe 100644 --- a/include/asterisk/lock.h +++ b/include/asterisk/lock.h @@ -22,7 +22,7 @@ * - See \ref LockDef */ -/* \page LockDef Asterisk thread locking models +/*! \page LockDef Asterisk thread locking models * * This file provides different implementation of the functions, * depending on the platform, the use of DEBUG_THREADS, and the way diff --git a/include/asterisk/module.h b/include/asterisk/module.h index 4ce6e9460..1d00f4504 100644 --- a/include/asterisk/module.h +++ b/include/asterisk/module.h @@ -77,9 +77,9 @@ enum ast_module_load_result { enum ast_module_load_result ast_load_resource(const char *resource_name); /*! - * \brief Unloads a module. + * \brief Unload a module. * \param resource_name The name of the module to unload. - * \param unload_mode The force flag. This should be set using one of the AST_FORCE flags. + * \param ast_module_unload_mode The force flag. This should be set using one of the AST_FORCE flags. * * This function unloads a module. It will only unload modules that are not in * use (usecount not zero), unless #AST_FORCE_FIRM or #AST_FORCE_HARD is |