[svn-commits] oej: trunk r46434 - in /trunk: ./ apps/ channels/
formats/ include/asterisk/ ...
svn-commits at lists.digium.com
svn-commits at lists.digium.com
Mon Oct 30 09:33:03 MST 2006
Author: oej
Date: Mon Oct 30 10:33:02 2006
New Revision: 46434
URL: http://svn.digium.com/view/asterisk?rev=46434&view=rev
Log:
Issue 8246 Doxygen updates (kshumard)
THANK YOU!
Modified:
trunk/ (props changed)
trunk/apps/app_voicemail.c
trunk/channels/chan_sip.c
trunk/formats/format_ogg_vorbis.c
trunk/include/asterisk/channel.h
trunk/include/asterisk/doxyref.h
trunk/include/asterisk/file.h
trunk/include/asterisk/frame.h
trunk/include/asterisk/lock.h
trunk/include/asterisk/module.h
trunk/main/app.c
trunk/main/ast_expr2f.c
trunk/main/asterisk.c
Propchange: trunk/
------------------------------------------------------------------------------
Binary property 'branch-1.4-merged' - no diff available.
Modified: trunk/apps/app_voicemail.c
URL: http://svn.digium.com/view/asterisk/trunk/apps/app_voicemail.c?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/apps/app_voicemail.c (original)
+++ trunk/apps/app_voicemail.c Mon Oct 30 10:33:02 2006
@@ -936,6 +936,7 @@
/*! \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.
Modified: trunk/channels/chan_sip.c
URL: http://svn.digium.com/view/asterisk/trunk/channels/chan_sip.c?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/channels/chan_sip.c (original)
+++ trunk/channels/chan_sip.c Mon Oct 30 10:33:02 2006
@@ -678,7 +678,7 @@
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 */
Modified: trunk/formats/format_ogg_vorbis.c
URL: http://svn.digium.com/view/asterisk/trunk/formats/format_ogg_vorbis.c?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/formats/format_ogg_vorbis.c (original)
+++ trunk/formats/format_ogg_vorbis.c Mon Oct 30 10:33:02 2006
@@ -250,7 +250,8 @@
/*!
* \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)
{
@@ -276,9 +277,9 @@
/*!
* \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)
{
Modified: trunk/include/asterisk/channel.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/channel.h?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/include/asterisk/channel.h (original)
+++ trunk/include/asterisk/channel.h Mon Oct 30 10:33:02 2006
@@ -801,6 +801,8 @@
/*! \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);
@@ -928,9 +930,11 @@
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);
@@ -1014,7 +1018,7 @@
/*! 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
*/
@@ -1344,6 +1348,7 @@
/*!
\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);
Modified: trunk/include/asterisk/doxyref.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/doxyref.h?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/include/asterisk/doxyref.h (original)
+++ trunk/include/asterisk/doxyref.h Mon Oct 30 10:33:02 2006
@@ -119,7 +119,7 @@
* \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 @@
/*! \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
Modified: trunk/include/asterisk/file.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/file.h?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/include/asterisk/file.h (original)
+++ trunk/include/asterisk/file.h Mon Oct 30 10:33:02 2006
@@ -218,7 +218,7 @@
/*! 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 @@
/*! 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 @@
/*! 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
Modified: trunk/include/asterisk/frame.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/frame.h?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/include/asterisk/frame.h (original)
+++ trunk/include/asterisk/frame.h Mon Oct 30 10:33:02 2006
@@ -473,7 +473,7 @@
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
Modified: trunk/include/asterisk/lock.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/lock.h?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/include/asterisk/lock.h (original)
+++ trunk/include/asterisk/lock.h Mon Oct 30 10:33:02 2006
@@ -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
Modified: trunk/include/asterisk/module.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/module.h?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/include/asterisk/module.h (original)
+++ trunk/include/asterisk/module.h Mon Oct 30 10:33:02 2006
@@ -77,9 +77,9 @@
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
Modified: trunk/main/app.c
URL: http://svn.digium.com/view/asterisk/trunk/main/app.c?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/main/app.c (original)
+++ trunk/main/app.c Mon Oct 30 10:33:02 2006
@@ -99,8 +99,12 @@
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;
Modified: trunk/main/ast_expr2f.c
URL: http://svn.digium.com/view/asterisk/trunk/main/ast_expr2f.c?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/main/ast_expr2f.c (original)
+++ trunk/main/ast_expr2f.c Mon Oct 30 10:33:02 2006
@@ -2722,8 +2722,8 @@
/** 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.
*/
@@ -2884,7 +2884,7 @@
}
/** 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)
Modified: trunk/main/asterisk.c
URL: http://svn.digium.com/view/asterisk/trunk/main/asterisk.c?rev=46434&r1=46433&r2=46434&view=diff
==============================================================================
--- trunk/main/asterisk.c (original)
+++ trunk/main/asterisk.c Mon Oct 30 10:33:02 2006
@@ -144,7 +144,7 @@
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
More information about the svn-commits
mailing list