[svn-commits] lathama: branch lathama/doxygencleanups r373370 - in /team/lathama/doxygencle...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Fri Sep 21 15:14:37 CDT 2012
Author: lathama
Date: Fri Sep 21 15:14:33 2012
New Revision: 373370
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=373370
Log:
sync up some fixes
Modified:
team/lathama/doxygencleanups/apps/app_queue.c
team/lathama/doxygencleanups/apps/app_voicemail.c
team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen
team/lathama/doxygencleanups/include/asterisk/channel.h
team/lathama/doxygencleanups/include/asterisk/config.h
team/lathama/doxygencleanups/include/asterisk/doxyref.h
team/lathama/doxygencleanups/include/asterisk/format.h
team/lathama/doxygencleanups/include/asterisk/pbx.h
team/lathama/doxygencleanups/include/asterisk/xmpp.h
team/lathama/doxygencleanups/main/asterisk.c
team/lathama/doxygencleanups/main/pbx.c
Modified: team/lathama/doxygencleanups/apps/app_queue.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_queue.c?view=diff&rev=373370&r1=373369&r2=373370
==============================================================================
--- team/lathama/doxygencleanups/apps/app_queue.c (original)
+++ team/lathama/doxygencleanups/apps/app_queue.c Fri Sep 21 15:14:33 2012
@@ -1197,8 +1197,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(
@@ -5799,8 +5799,9 @@
/*! \brief Dump all members in a specific queue to the database
- *
+ * \code
* <pm_family>/<queuename> = <interface>;<penalty>;<paused>;<state_interface>[|...]
+ * \code
*/
static void dump_queue_members(struct call_queue *pm_queue)
{
Modified: team/lathama/doxygencleanups/apps/app_voicemail.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_voicemail.c?view=diff&rev=373370&r1=373369&r2=373370
==============================================================================
--- team/lathama/doxygencleanups/apps/app_voicemail.c (original)
+++ team/lathama/doxygencleanups/apps/app_voicemail.c Fri Sep 21 15:14:33 2012
@@ -1053,7 +1053,7 @@
*
* \note the "move" parameter is only honored for IMAP voicemail presently
* \retval 0 Success
- * \revval other Failure
+ * \retval other Failure
*/
static int save_to_folder(struct ast_vm_user *vmu, struct vm_state *vms, int msg, int box, int *newmsg, int move);
@@ -4804,7 +4804,7 @@
* \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
+ * \param flag, msg_id
*
* 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.
*/
@@ -5630,7 +5630,7 @@
* \param recip
* \param fmt
* \param dir
- * \param flag
+ * \param flag, dest_folder
*
* This is only used by file storage based mailboxes.
*
@@ -5746,7 +5746,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.
@@ -15089,6 +15089,7 @@
* \param msg_ids An array of message identifiers
* \param num_msgs The number of identifiers in msg_ids
* \param msg_nums [out] The message indexes corresponding to the given
+ * \param vmu
* message IDs
* \pre vms must have open_mailbox() called on it prior to this function.
*
Modified: team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen?view=diff&rev=373370&r1=373369&r2=373370
==============================================================================
--- team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen (original)
+++ team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen Fri Sep 21 15:14:33 2012
@@ -170,7 +170,7 @@
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
-TAB_SIZE = 4
+TAB_SIZE = 3
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
@@ -298,9 +298,9 @@
# Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
-EXTRACT_ALL = NO
-
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
EXTRACT_PRIVATE = NO
@@ -540,14 +540,14 @@
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
-WARN_IF_UNDOCUMENTED = NO
+WARN_IF_UNDOCUMENTED = YES
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
# parameters in a documented function, or documenting parameters that
# don't exist or using markup commands wrongly.
-WARN_IF_DOC_ERROR = NO
+WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
@@ -1222,13 +1222,13 @@
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
# generate man pages
-GENERATE_MAN = YES
+GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `man' will be used as the default path.
-MAN_OUTPUT = doc
+MAN_OUTPUT =
# The MAN_EXTENSION tag determines the extension that is added to
# the generated man pages (default is the subroutine's section .3)
Modified: team/lathama/doxygencleanups/include/asterisk/channel.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/include/asterisk/channel.h?view=diff&rev=373370&r1=373369&r2=373370
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/channel.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/channel.h Fri Sep 21 15:14:33 2012
@@ -1687,7 +1687,7 @@
/*!
* \brief Waits for activity on a group of channels
- * \param chan an array of pointers to channels
+ * \param c chan an array of pointers to channels
* \param n number of channels that are to be waited upon
* \param fds an array of fds to wait upon
* \param nfds the number of fds to wait upon
Modified: team/lathama/doxygencleanups/include/asterisk/config.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/include/asterisk/config.h?view=diff&rev=373370&r1=373369&r2=373370
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/config.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/config.h Fri Sep 21 15:14:33 2012
@@ -742,7 +742,7 @@
* \param arg the string to parse. It is not modified.
* \param flags combination of ast_parse_flags to specify the
* return type and additional checks.
- * \param result pointer to the result. NULL is valid here, and can
+ * \param p_result pointer to the result. NULL is valid here, and can
* be used to perform only the validity checks.
* \param ... extra arguments are required according to flags.
*
Modified: team/lathama/doxygencleanups/include/asterisk/doxyref.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/include/asterisk/doxyref.h?view=diff&rev=373370&r1=373369&r2=373370
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/doxyref.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/doxyref.h Fri Sep 21 15:14:33 2012
@@ -127,20 +127,6 @@
* \li ast_channel_alloc()
*/
-/*!
- * \page AstDebug Debugging
- * \section debug Debugging
- */
-
-/*!
- * \page AstSpeech The Generic Speech Recognition API
- * \section debug The Generic Speech Recognition API
- */
-
-/*!
- * \page DataStores Channel Data Stores
- * \section debug Channel Data Stores
- */
/*!
* \page AstAMI AMI - The Manager Interface
@@ -153,7 +139,7 @@
* \page AstARA ARA - The Asterisk Realtime Interface
* \section realtime ARA - a generic API to storage and retrieval
* Implemented in \ref config.c
- * Implemented in \ref pbx_realtime.c
+ * Implemented in \ref pbx_realtime.c
*/
/*!
@@ -662,6 +648,7 @@
* \page res_config_sqlite SQLite Resource driver configuration
* \arg Implemented in \ref res_config_sqlite.c
* \arg Configuration file:
+ * \verbinclude res_config_sqlite.conf.sample
* \arg SQL tables:
* \arg See also:
* http://www.sqlite.org
Modified: team/lathama/doxygencleanups/include/asterisk/format.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/include/asterisk/format.h?view=diff&rev=373370&r1=373369&r2=373370
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/format.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/format.h Fri Sep 21 15:14:33 2012
@@ -265,7 +265,7 @@
*
* \param format to set
* \param id format id to set on format
- * \param set_attributes, are there attributes to set on this format. 0 == false, 1 == True.
+ * \param set_attributes are there attributes to set on this format. 0 == false, 1 == True.
* \param ... var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END;
*
* \details Example usage.
Modified: team/lathama/doxygencleanups/include/asterisk/pbx.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/include/asterisk/pbx.h?view=diff&rev=373370&r1=373369&r2=373370
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/pbx.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/pbx.h Fri Sep 21 15:14:33 2012
@@ -821,7 +821,7 @@
* \brief Add a context include
*
* \param con context to add the include to
- * \param value include include to add
+ * \param include value to add
* \param registrar who registered the context
*
* Adds an include taking a struct ast_context as the first parameter
Modified: team/lathama/doxygencleanups/include/asterisk/xmpp.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/include/asterisk/xmpp.h?view=diff&rev=373370&r1=373369&r2=373370
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/xmpp.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/xmpp.h Fri Sep 21 15:14:33 2012
@@ -234,7 +234,7 @@
*
* \param client Pointer to the client
* \param nickname Nickname to use
- * \param Address Address of the room
+ * \param address Address of the room
* \param message Message itself
*
* \retval 0 on success
Modified: team/lathama/doxygencleanups/main/asterisk.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/asterisk.c?view=diff&rev=373370&r1=373369&r2=373370
==============================================================================
--- team/lathama/doxygencleanups/main/asterisk.c (original)
+++ team/lathama/doxygencleanups/main/asterisk.c Fri Sep 21 15:14:33 2012
@@ -1,5 +1,5 @@
/*
- * Asterisk - An open source telephony toolkit.
+ * Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 1999 - 2012, Digium, Inc.
*
Modified: team/lathama/doxygencleanups/main/pbx.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/pbx.c?view=diff&rev=373370&r1=373369&r2=373370
==============================================================================
--- team/lathama/doxygencleanups/main/pbx.c (original)
+++ team/lathama/doxygencleanups/main/pbx.c Fri Sep 21 15:14:33 2012
@@ -8799,7 +8799,7 @@
};
/*! /brief Build timing
*
- * /param i, info
+ * /param i info
* /param info_in
*
*/
More information about the svn-commits
mailing list