[svn-commits] jpeeler: branch jpeeler/doxygen-cleanup r180795 - in /team/jpeeler/doxygen-cl...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Mon Mar 9 23:54:25 CDT 2009
Author: jpeeler
Date: Mon Mar 9 23:54:21 2009
New Revision: 180795
URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=180795
Log:
some progress
Modified:
team/jpeeler/doxygen-cleanup/apps/app_meetme.c
team/jpeeler/doxygen-cleanup/apps/app_osplookup.c
team/jpeeler/doxygen-cleanup/apps/app_queue.c
team/jpeeler/doxygen-cleanup/apps/app_voicemail.c
team/jpeeler/doxygen-cleanup/include/asterisk/app.h
team/jpeeler/doxygen-cleanup/main/taskprocessor.c
Modified: team/jpeeler/doxygen-cleanup/apps/app_meetme.c
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/apps/app_meetme.c?view=diff&rev=180795&r1=180794&r2=180795
==============================================================================
--- team/jpeeler/doxygen-cleanup/apps/app_meetme.c (original)
+++ team/jpeeler/doxygen-cleanup/apps/app_meetme.c Mon Mar 9 23:54:21 2009
@@ -4743,9 +4743,9 @@
/*! \brief Choose the highest priority ringing trunk for a station
* \param station the station
- * \param remove remove the ringing trunk once selected
* \param trunk_ref a place to store the pointer to this stations reference to
* the selected trunk
+ * \param rm remove the ringing trunk once selected
* \return a pointer to the selected ringing trunk, or NULL if none found
* \note Assumes that sla.lock is locked
*/
Modified: team/jpeeler/doxygen-cleanup/apps/app_osplookup.c
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/apps/app_osplookup.c?view=diff&rev=180795&r1=180794&r2=180795
==============================================================================
--- team/jpeeler/doxygen-cleanup/apps/app_osplookup.c (original)
+++ team/jpeeler/doxygen-cleanup/apps/app_osplookup.c Mon Mar 9 23:54:21 2009
@@ -1183,7 +1183,7 @@
* \param recorded If failure reason has been recorded
* \param cause Asterisk hangup cause
* \param start Call start time
- * \param connect Call connect time
+ * \param connect_time Call connect time
* \param end Call end time
* \param release Who release first, 0 source, 1 destination
* \return 1 Success, 0 Failed, -1 Error
Modified: team/jpeeler/doxygen-cleanup/apps/app_queue.c
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/apps/app_queue.c?view=diff&rev=180795&r1=180794&r2=180795
==============================================================================
--- team/jpeeler/doxygen-cleanup/apps/app_queue.c (original)
+++ team/jpeeler/doxygen-cleanup/apps/app_queue.c Mon Mar 9 23:54:21 2009
@@ -701,8 +701,8 @@
#define ANNOUNCEPOSITION_YES 1 /*!< We announce position */
#define ANNOUNCEPOSITION_NO 2 /*!< We don't announce position */
-#define ANNOUNCEPOSITION_MORE_THAN 3 /*!< We say "Currently there are more than <limit>" */
-#define ANNOUNCEPOSITION_LIMIT 4 /*!< We not announce position more than <limit> */
+#define ANNOUNCEPOSITION_MORE_THAN 3 /*!< We say "Currently there are more than [limit]" */
+#define ANNOUNCEPOSITION_LIMIT 4 /*!< We not announce position more than [limit] */
struct call_queue {
AST_DECLARE_STRING_FIELDS(
@@ -4222,7 +4222,7 @@
/*! \brief Dump all members in a specific queue to the database
*
- * <pm_family>/<queuename> = <interface>;<penalty>;<paused>;<state_interface>[|...]
+ * [pm_family]/[queuename] = [interface];[penalty];[paused];[state_interface][|...]
*/
static void dump_queue_members(struct call_queue *pm_queue)
{
Modified: team/jpeeler/doxygen-cleanup/apps/app_voicemail.c
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/apps/app_voicemail.c?view=diff&rev=180795&r1=180794&r2=180795
==============================================================================
--- team/jpeeler/doxygen-cleanup/apps/app_voicemail.c (original)
+++ team/jpeeler/doxygen-cleanup/apps/app_voicemail.c Mon Mar 9 23:54:21 2009
@@ -1357,6 +1357,9 @@
* \brief Creates a file system path expression for a folder within the voicemail data folder and the appropriate context.
* \param dest The variable to hold the output generated path expression. This buffer should be of size PATH_MAX.
* \param len The length of the path string that was written out.
+ * \param context the context
+ * \param ext the extension
+ * \param folder the folder
*
* The path is constructed as
* VM_SPOOL_DIRcontext/ext/folder
@@ -1372,9 +1375,11 @@
* \brief Creates a file system path expression for a folder within the voicemail data folder and the appropriate context.
* \param dest The variable to hold the output generated path expression. This buffer should be of size PATH_MAX.
* \param len The length of the path string that was written out.
+ * \param dir the directory
+ * \param num the number with leading zeros added if necessary to make four digits
*
* The path is constructed as
- * VM_SPOOL_DIRcontext/ext/folder
+ * directory/msgXXXX
*
* \return zero on success, -1 on error.
*/
@@ -2084,6 +2089,7 @@
* \param recip
* \param fmt
* \param dir
+ * \param flag
*
* This works with IMAP storage based mailboxes.
*
@@ -3879,6 +3885,7 @@
* \brief Wraps a character sequence in double quotes, escaping occurences of quotes within the string.
* \param from The string to work with.
* \param to The string to write the modified quoted string. This buffer should be sufficiently larger than the from string, so as to allow it to be expanded by the surrounding quotes and escaping of internal quotes.
+ * \param len the number of characters to write in the to buffer
*
* \return The destination string with quotes wrapped on it (the to field).
*/
@@ -3946,6 +3953,7 @@
*
* \param start A string to be encoded
* \param end An expandable buffer for holding the result
+ * \param endsize size of buffer end
* \param preamble The length of the first line already used for this string,
* to ensure that each line maintains a maximum length of 76 chars.
* \param postamble the length of any additional characters appended to the
@@ -3997,12 +4005,14 @@
* \param cidnum The caller ID number.
* \param cidname The caller ID name.
* \param attach the name of the sound file to be attached to the email, if attach_user_voicemail == 1.
+ * \param attach2
* \param format The message sound file format. i.e. .wav
* \param duration The time of the message content, in seconds.
* \param attach_user_voicemail if 1, the sound file is attached to the email.
* \param chan
* \param category
* \param imap if == 1, indicates the target folder for the email notification to be sent to will be an IMAP mailstore. This causes additional mailbox headers to be set, which would facilitate searching for the email in the destination IMAP folder.
+ * \param flag
*
* The email body, and base 64 encoded attachement (if any) are stored to the file identified by *p. This method does not actually send the email. That is done by invoking the configure 'mailcmd' and piping this generated file into it, or with the sendemail() function.
*/
@@ -4675,6 +4685,7 @@
* \param recip
* \param fmt
* \param dir
+ * \param flag
*
* This is only used by file storage based mailboxes.
*
@@ -4781,7 +4792,7 @@
/**
* \brief Determines if the given folder has messages.
- * \param mailbox The @ delimited string for user at context. If no context is found, uses 'default' for the context.
+ * \param mailbox The @ delimited string for user\@context. If no context is found, uses 'default' for the context.
* \param folder the folder to look in
*
* This function is used when the mailbox is stored in a filesystem back end.
@@ -6055,11 +6066,12 @@
* \param vmu
* \param curdir
* \param curmsg
- * \param vmfmts
+ * \param vm_fmts
* \param context
* \param record_gain
* \param duration
* \param vms
+ * \param flag
*
* Presents a prompt for 1 to prepend the current message, 2 to forward the message without prepending, or * to return to the main menu.
*
@@ -6231,6 +6243,7 @@
* \param fmt
* \param cidnum The Caller ID phone number value.
* \param cidname The Caller ID name value.
+ * \param flag
*
* \return zero on success, -1 on error.
*/
@@ -6309,7 +6322,7 @@
/*!
* \brief Sends a voicemail message to a mailbox recipient.
- * \param ast_channel
+ * \param chan
* \param context
* \param vms
* \param sender
@@ -6318,6 +6331,7 @@
* Will be 0 when called to forward an existing message (option 8)
* Will be 1 when called to leave a message (option 3->5)
* \param record_gain
+ * \param urgent
*
* Reads the destination mailbox(es) from keypad input for CID, or if use_directory feature is enabled, the Directory.
*
Modified: team/jpeeler/doxygen-cleanup/include/asterisk/app.h
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/include/asterisk/app.h?view=diff&rev=180795&r1=180794&r2=180795
==============================================================================
--- team/jpeeler/doxygen-cleanup/include/asterisk/app.h (original)
+++ team/jpeeler/doxygen-cleanup/include/asterisk/app.h Mon Mar 9 23:54:21 2009
@@ -110,6 +110,7 @@
/*!
* \brief Set voicemail function callbacks
+ * \param[in] has_voicemail_func set function pointer
* \param[in] inboxcount2_func set function pointer
* \param[in] sayname_func set function pointer
* \param[in] inboxcount_func set function pointer
Modified: team/jpeeler/doxygen-cleanup/main/taskprocessor.c
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/main/taskprocessor.c?view=diff&rev=180795&r1=180794&r2=180795
==============================================================================
--- team/jpeeler/doxygen-cleanup/main/taskprocessor.c (original)
+++ team/jpeeler/doxygen-cleanup/main/taskprocessor.c Mon Mar 9 23:54:21 2009
@@ -84,10 +84,10 @@
/*! \brief tps_singletons is the astobj2 container for taskprocessor singletons */
static struct ao2_container *tps_singletons;
-/*! \brief CLI 'taskprocessor ping <blah>' operation requires a ping condition */
+/*! \brief CLI 'taskprocessor ping [blah]' operation requires a ping condition */
static ast_cond_t cli_ping_cond;
-/*! \brief CLI 'taskprocessor ping <blah>' operation requires a ping condition lock */
+/*! \brief CLI 'taskprocessor ping [blah]' operation requires a ping condition lock */
AST_MUTEX_DEFINE_STATIC(cli_ping_cond_lock);
/*! \brief The astobj2 hash callback for taskprocessors */
@@ -101,7 +101,7 @@
/*! \brief Destroy the taskprocessor when its refcount reaches zero */
static void tps_taskprocessor_destroy(void *tps);
-/*! \brief CLI 'taskprocessor ping <blah>' handler function */
+/*! \brief CLI 'taskprocessor ping [blah]' handler function */
static int tps_ping_handler(void *datap);
/*! \brief Remove the front task off the taskprocessor queue */
More information about the svn-commits
mailing list