/*! \brief basically mkdir -p $dest/$context/$ext/$folder
* \param dest String. base directory.
+ * \param len Length of dest.
* \param context String. Ignored if is null or empty string.
* \param ext String. Ignored if is null or empty string.
* \param folder String. Ignored if is null or empty string.
AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
-/*! \brief sip_auth: Creadentials for authentication to other SIP services */
+/*! \brief sip_auth: Credentials for authentication to other SIP services */
struct sip_auth {
char realm[AST_MAX_EXTENSION]; /*!< Realm in which these credentials are valid */
char username[256]; /*!< Username */
/*!
* \brief Write out any pending encoded data.
- * \param s A OGG/Vorbis filestream.
+ * \param s An OGG/Vorbis filestream.
+ * \param f The file to write to.
*/
static void write_stream(struct vorbis_desc *s, FILE *f)
{
/*!
* \brief Write audio data from a frame to an OGG/Vorbis filestream.
- * \param fs A OGG/Vorbis filestream.
- * \param f An frame containing audio to be written to the filestream.
- * \return -1 ifthere was an error, 0 on success.
+ * \param fs An OGG/Vorbis filestream.
+ * \param f A frame containing audio to be written to the filestream.
+ * \return -1 if there was an error, 0 on success.
*/
static int ogg_vorbis_write(struct ast_filestream *fs, struct ast_frame *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);
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);
/*! 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
*/
/*!
\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);
* \arg \ref cdr_drivers
* \arg \ref Config_cdr CDR configuration files
*
- * \verbinclude cdr.txt
+ * \verbinclude cdrdriver.txt
*/
/*! \page AstREADME README - the general administrator introduction
/*! \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
/*! 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
/*! 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
/*! 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
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
* - 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
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
return res;
}
-/*! \param timeout set timeout to 0 for "standard" timeouts. Set timeout to -1 for
- "ludicrous time" (essentially never times out) */
+/*! \param c The channel to read from
+ * \param prompt The file to stream to the channel
+ * \param s The string to read in to. Must be at least the size of your length
+ * \param maxlen How many digits to read (maximum)
+ * \param timeout set timeout to 0 for "standard" timeouts. Set timeout to -1 for
+ * "ludicrous time" (essentially never times out) */
int ast_app_getdata(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout)
{
int res,to,fto;
/** Setup the input buffer state to scan the given bytes. The next call to ast_yylex() will
* scan from a @e copy of @a bytes.
- * @param bytes the byte buffer to scan
- * @param len the number of bytes in the buffer pointed to by @a bytes.
+ * @param yybytes the byte buffer to scan
+ * @param _yybytes_len the number of bytes in the buffer pointed to by @a bytes.
* @param yyscanner The scanner object.
* @return the newly allocated buffer state object.
*/
}
/** Set the current column.
- * @param line_number
+ * @param column_no
* @param yyscanner The scanner object.
*/
void ast_yyset_column (int column_no , yyscan_t yyscanner)
ast_verbose("certain conditions. Type 'show license' for details.\n"); \
ast_verbose("=========================================================================\n")
-/*! \defgroup main_options
+/*! \defgroup main_options Main Configuration Options
\brief Main configuration options from \ref Config_ast "asterisk.conf" or
the operating system command line when starting Asterisk
Some of them can be changed in the CLI
projects / asterisk/asterisk.git / commitdiff