[svn-commits] lathama: branch lathama/doxygencleanups r373383 - in /team/lathama/doxygencle...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Sat Sep 22 15:27:17 CDT 2012
Author: lathama
Date: Sat Sep 22 15:27:13 2012
New Revision: 373383
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=373383
Log:
Bringing in more of my branch. Mantis is old, bye bye...
Removed:
team/lathama/doxygencleanups/include/asterisk/doxygen/mantisworkflow.h
Modified:
team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen
team/lathama/doxygencleanups/include/asterisk/agi.h
team/lathama/doxygencleanups/include/asterisk/channel.h
team/lathama/doxygencleanups/include/asterisk/config.h
team/lathama/doxygencleanups/include/asterisk/doxyref.h
team/lathama/doxygencleanups/main/asterisk.c
team/lathama/doxygencleanups/main/channel.c
team/lathama/doxygencleanups/main/manager.c
team/lathama/doxygencleanups/res/res_timing_kqueue.c
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=373383&r1=373382&r2=373383
==============================================================================
--- team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen (original)
+++ team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen Sat Sep 22 15:27:13 2012
@@ -1384,7 +1384,52 @@
# The macro definition that is found in the sources will be used.
# Use the PREDEFINED tag if you want to use a different macro definition.
-EXPAND_AS_DEFINED =
+EXPAND_AS_DEFINED = \
+ AST_INLINE_API \
+ AST_DECLARE_STRING_FIELDS \
+ AST_STRING_FIELD \
+ AST_THREADSTORAGE \
+ AST_THREADSTORAGE_CUSTOM \
+ AST_MODULE_INFO \
+ AST_MODULE_INFO_STANDARD \
+ __AST_MUTEX_DEFINE \
+ AST_MUTEX_DEFINE_STATIC \
+ AST_MUTEX_DEFINE_STATIC_NOTRACKING \
+ __AST_RWLOCK_DEFINE \
+ AST_RWLOCK_DEFINE_STATIC \
+ AST_LIST_HEAD \
+ AST_RWLIST_HEAD \
+ AST_LIST_HEAD_NOLOCK \
+ AST_LIST_HEAD_STATIC \
+ AST_RWLIST_HEAD_STATIC \
+ AST_LIST_HEAD_NOLOCK_STATIC \
+ AST_LIST_ENTRY \
+ AST_RWLIST_ENTRY \
+ __ASTOBJ_HASH \
+ ASTOBJ_COMPONENTS_NOLOCK_FULL \
+ ASTOBJ_COMPONENTS_NOLOCK \
+ ASTOBJ_COMPONENTS_FULL \
+ ASTOBJ_COMPONENTS \
+ AST_IVR_DECLARE_MENU \
+ AST_DECLARE_APP_ARGS \
+ AST_DEFINE_APP_ARGS_TYPE \
+ AST_APP_ARG \
+ BEGIN_OPTIONS \
+ END_OPTIONS \
+ AST_APP_OPTIONS \
+ AST_APP_OPTION \
+ AST_APP_OPTION_ARG \
+ AST_DLLIST_HEAD \
+ AST_DLLIST_HEAD_STATIC \
+ AST_DLLIST_HEAD_NOLOCK \
+ AST_DLLIST_HEAD_NOLOCK_STATIC \
+ AST_RWDLLIST_HEAD \
+ AST_RWDLLIST_HEAD_STATIC \
+ AST_DLLIST_ENTRY \
+ AST_RWDLLIST_ENTRY \
+ AST_CLI_DEFINE \
+ AST_OPTIONAL_API \
+ AST_OPTIONAL_API_ATTR
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
Modified: team/lathama/doxygencleanups/include/asterisk/agi.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/include/asterisk/agi.h?view=diff&rev=373383&r1=373382&r2=373383
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/agi.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/agi.h Sat Sep 22 15:27:13 2012
@@ -67,8 +67,8 @@
*
* Registers an AGI command.
*
- * \par mod Pointer to the module_info structure for the module that is registering the command
- * \par cmd Pointer to the descriptor for the command
+ * \param mod Pointer to the module_info structure for the module that is registering the command
+ * \param cmd Pointer to the descriptor for the command
* \retval 1 on success
* \retval 0 the command is already registered
* \retval AST_OPTIONAL_API_UNAVAILABLE the module is not loaded.
@@ -82,8 +82,8 @@
*
* Unregisters an AGI command.
*
- * \par mod Pointer to the module_info structure for the module that is unregistering the command
- * \par cmd Pointer to the descriptor for the command
+ * \param mod Pointer to the module_info structure for the module that is unregistering the command
+ * \param cmd Pointer to the descriptor for the command
* \return 1 on success, 0 if the command was not already registered
*
*/
@@ -97,9 +97,9 @@
* Registers a group of AGI commands, provided as an array of struct agi_command
* entries.
*
- * \par mod Pointer to the module_info structure for the module that is registering the commands
- * \par cmd Pointer to the first entry in the array of command descriptors
- * \par len Length of the array (use the ARRAY_LEN macro to determine this easily)
+ * \param mod Pointer to the module_info structure for the module that is registering the commands
+ * \param cmd Pointer to the first entry in the array of command descriptors
+ * \param len Length of the array (use the ARRAY_LEN macro to determine this easily)
* \return 0 on success, -1 on failure, AST_OPTIONAL_API_UNAVAILABLE if res_agi is not loaded
*
* \note If any command fails to register, all commands previously registered during the operation
@@ -116,9 +116,9 @@
* Unregisters a group of AGI commands, provided as an array of struct agi_command
* entries.
*
- * \par mod Pointer to the module_info structure for the module that is unregistering the commands
- * \par cmd Pointer to the first entry in the array of command descriptors
- * \par len Length of the array (use the ARRAY_LEN macro to determine this easily)
+ * \param mod Pointer to the module_info structure for the module that is unregistering the commands
+ * \param cmd Pointer to the first entry in the array of command descriptors
+ * \param len Length of the array (use the ARRAY_LEN macro to determine this easily)
* \return 0 on success, -1 on failure, AST_OPTIONAL_API_UNAVAILABLE if res_agi is not loaded
*
* \note If any command fails to unregister, this function will continue to unregister the
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=373383&r1=373382&r2=373383
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/channel.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/channel.h Sat Sep 22 15:27:13 2012
@@ -1383,7 +1383,7 @@
* \brief Softly hangup up a channel
*
* \param chan channel to be soft-hung-up
- * \param cause Reason an AST_SOFTHANGUP_* reason code
+ * \param reason an AST_SOFTHANGUP_* reason code
*
* \details
* Call the protocol layer, but don't destroy the channel structure
@@ -1687,7 +1687,7 @@
/*!
* \brief Waits for activity on a group of channels
- * \param c chan an array of pointers to channels
+ * \param 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
@@ -2036,8 +2036,8 @@
/*!
* \brief Gives the string form of a given cause code.
*
- * \param cause State cause to get the description of
- * return the text form of the binary cause code given
+ * \param state cause to get the description of
+ * \return the text form of the binary cause code given
*/
const char *ast_cause2str(int state) attribute_pure;
@@ -2292,7 +2292,7 @@
* the clone channel into the original channel. Start by killing off the original
* channel's backend. I'm not sure we're going to keep this function, because
* while the features are nice, the cost is very high in terms of pure nastiness. XXX
- * \param original Channel to masquerade
+ * \param chan Channel to masquerade
*/
int ast_do_masquerade(struct ast_channel *chan);
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=373383&r1=373382&r2=373383
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/config.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/config.h Sat Sep 22 15:27:13 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 p_result pointer to the result. NULL is valid here, and can
+ * \param 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=373383&r1=373382&r2=373383
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/doxyref.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/doxyref.h Sat Sep 22 15:27:13 2012
@@ -27,8 +27,19 @@
*/
/*! \page system_requirements System Requirements
- *
- *
+ * \par Installing from source
+ * \par
+ * If installing from sources you can use the install_prereq script in the
+ * contrib directory for checking that you have the required tools and
+ * libraries.
+ * \code
+ * ./contrib/scripts/install_prereq
+ * \endcode
+ *
+ * \par Installing from packages
+ * \par
+ * If you would like to install from a prepared package for your platform
+ * please look at <a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+Packages">Asterisk Packages</a> for information.
*/
/*! \page downloading_asterisk Downloading Asterisk
@@ -43,35 +54,6 @@
/*! \page configuration_files Configuration Files
*
- * \li acl.conf.sample
- * \li cdr_tds.conf.sample
- * \li extconfig.conf.sample
- * \li minivm.conf.sample
- * \li res_pgsql.conf.sample
- * \li adsi.conf.sample
- * \li cel.conf.sample
- * \li extensions.ael.sample
- * \li misdn.conf.sample
- * \li res_pktccops.conf.sample
-agents.conf.sample cel_custom.conf.sample extensions.conf.sample modules.conf.sample res_snmp.conf.sample
-alarmreceiver.conf.sample cel_odbc.conf.sample extensions.lua.sample motif.conf.sample res_stun_monitor.conf.sample
-alsa.conf.sample cel_pgsql.conf.sample extensions_minivm.conf.sample musiconhold.conf.sample rtp.conf.sample
-amd.conf.sample cel_sqlite3_custom.conf.sample features.conf.sample muted.conf.sample say.conf.sample
-app_mysql.conf.sample cel_tds.conf.sample festival.conf.sample ooh323.conf.sample sip.conf.sample
-app_skel.conf.sample chan_dahdi.conf.sample followme.conf.sample osp.conf.sample sip_notify.conf.sample
-asterisk.adsi chan_mobile.conf.sample func_odbc.conf.sample oss.conf.sample skinny.conf.sample
-asterisk.conf.sample cli_aliases.conf.sample gtalk.conf.sample phone.conf.sample sla.conf.sample
-calendar.conf.sample cli.conf.sample h323.conf.sample phoneprov.conf.sample smdi.conf.sample
-ccss.conf.sample cli_permissions.conf.sample http.conf.sample queuerules.conf.sample telcordia-1.adsi
-codecs.conf.sample iax.conf.sample queues.conf.sample udptl.conf.sample
-cdr.conf.sample confbridge.conf.sample iaxprov.conf.sample res_config_mysql.conf.sample unistim.conf.sample
-cdr_custom.conf.sample config_test.conf.sample indications.conf.sample res_config_sqlite3.conf.sample users.conf.sample
-cdr_manager.conf.sample console.conf.sample jabber.conf.sample res_config_sqlite.conf.sample voicemail.conf.sample
-cdr_mysql.conf.sample dbsep.conf.sample jingle.conf.sample res_corosync.conf.sample vpb.conf.sample
-cdr_odbc.conf.sample dnsmgr.conf.sample logger.conf.sample res_curl.conf.sample xmpp.conf.sample
-cdr_pgsql.conf.sample dsp.conf.sample manager.conf.sample res_fax.conf.sample
-cdr_sqlite3_custom.conf.sample dundi.conf.sample meetme.conf.sample res_ldap.conf.sample
-cdr_syslog.conf.sample enum.conf.sample mgcp.conf.sample res_odbc.conf.sample
*
*/
@@ -96,11 +78,6 @@
*/
/*! \page subversion_usage Subversion usage
- *
- *
- */
-
-/*! \page community_support Community Support
*
*
*/
@@ -110,29 +87,23 @@
*
*/
-/*! \page
- *
- *
- */
-
-/*! \page
- *
- *
- */
-
-/*! \page
- *
- *
- */
-
-/*! \page
- *
- *
- */
-
-/*! \page
- *
- *
+/*! \page txt Text Files
+ * \verbinclude README-addons.txt
+ * \verbinclude README-SERIOUSLY.bestpractices.txt
+ * \verbinclude UPGRADE-10.txt
+ * \verbinclude UPGRADE-11.txt
+ * \verbinclude UPGRADE-1.2.txt
+ * \verbinclude UPGRADE-1.4.txt
+ * \verbinclude UPGRADE-1.6.txt
+ * \verbinclude UPGRADE-1.8.txt
+ * \verbinclude UPGRADE.txt
+ * \verbinclude Zaptel-to-DAHDI.txt
+ * \verbinclude LICENSE
+ * \verbinclude CHANGES
+ * \verbinclude README
+ * \verbinclude COPYING
+ * \verbinclude BUGS
+ * \verbinclude CREDITS
*/
/*!
@@ -239,16 +210,19 @@
/*!
* \page AstDebug Debugging
* \section debug Debugging
+ * \todo include backtrace txt that was removed
*/
/*!
* \page AstSpeech The Generic Speech Recognition API
* \section debug The Generic Speech Recognition API
+ * \todo include missing speechrec txt
*/
/*!
* \page DataStores Channel Data Stores
* \section debug Channel Data Stores
+ * \todo include missing datastores txt
*/
/*!
@@ -256,6 +230,7 @@
* \section ami AMI - The manager Interface
* \arg \link Config_ami Configuration file \endlink
* \arg \ref manager.c
+ * \todo include missing manager txt
*/
/*!
@@ -263,6 +238,8 @@
* \section realtime ARA - a generic API to storage and retrieval
* Implemented in \ref config.c
* Implemented in \ref pbx_realtime.c
+ * \todo include missing realtime txt
+ * \todo include missing extconfig txt
*/
/*!
@@ -291,6 +268,7 @@
* \arg \ref cdr_drivers
* \arg \ref Config_cdr CDR configuration files
*
+ * \todo include missing cdrdriver txt
*/
/*!
@@ -306,6 +284,7 @@
/*!
* \page AstVideo Video support in Asterisk
* \section sectAstVideo Video support in Asterisk
+ * \todo include missing video txt
*/
/*!
@@ -520,7 +499,7 @@
* \page Config_dahdi DAHDI configuration
* \section dahdiconf dahdi.conf
* \arg Implemented in \ref chan_dahdi.c
- * \verbinclude chan_dahdi.conf.sample
+ * \verbinclude dahdi.conf.sample
*/
/*!
@@ -613,7 +592,8 @@
/*!
* \page cdr_odbc Adaptive ODBC CDR driver configuration
- * \arg See also \ref cdrconf
+ * \li See also \ref cdrconf
+ * \verbinclude cdr_adaptive_odbc.conf.sample
* See also:
* \arg http://www.unixodbc.org
*/
@@ -818,6 +798,3 @@
* \addtogroup rtp_engines Module: RTP Engines
* \section rtp_engine_blah Asterisk RTP Engines
*/
-
-
-
Modified: team/lathama/doxygencleanups/main/asterisk.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/asterisk.c?view=diff&rev=373383&r1=373382&r2=373383
==============================================================================
--- team/lathama/doxygencleanups/main/asterisk.c (original)
+++ team/lathama/doxygencleanups/main/asterisk.c Sat Sep 22 15:27:13 2012
@@ -55,7 +55,7 @@
* There are many sources of support both free and commercial. If you need
* support for your installation try the commumity resources or contact Digium.
* Directly attempting to contact the developers may not yeild the best results.
- * \li \ref community_support Community Support
+ * \li \ref asterisk_community_resources Community Support
* \li \ref digium_support Digium Support
*
* \section community Community
@@ -68,21 +68,18 @@
* development on Asterisk then the following will be very helpful.
* \li \ref coding_guidelines Coding Guidlines
* \li \ref subversion_usage Subversion usage
- *
* \li \ref AsteriskArchitecture
- *
- * \par Additional documentation
* \li \ref Licensing
* \li \ref DevDoc
* \li \ref ConfigFiles
*
- * \section copyright Copyright and Authors
- *
- * Copyright (C) 1999 - 2012, Digium, Inc.
+ * \copyright Copyright (C) 1999 - 2012, Digium, Inc.
* Asterisk is a <a href="http://www.digium.com/en/company/view-policy.php?id=Trademark-Policy">registered trademark</a>
* of <a href="http://www.digium.com">Digium, Inc</a>.
*
* \author Mark Spencer <markster at digium.com>
+ *
+ * \par Listing of other authors
* \li \ref credits Credits
*/
@@ -93,8 +90,8 @@
* \li http://wiki.asterisk.org Asterisk Wiki
*
* \par Mailing Lists
+ * \par
* All lists: http://lists.digium.com/mailman/listinfo
- *
* \li aadk-commits SVN commits to the AADK repository
* \li asterisk-addons-commits SVN commits to the Asterisk addons project
* \li asterisk-announce [no description available]
@@ -133,15 +130,18 @@
* \li zaptel-commits SVN commits to the Zaptel project
*
* \par Forums
- * Forums are located at http://forums.asterisk.org/
+ * \li Forums are located at http://forums.asterisk.org/
*
* \par IRC
+ * \par
* Use http://www.freenode.net IRC server to connect with Asterisk
* developers and users in realtime.
*
- * \li #asterisk Asterisk Users Room
- * \li #asterisk-dev Asterisk Developers Room
+ * \li \verbatim #asterisk \endverbatim Asterisk Users Room
+ * \li \verbatim #asterisk-dev \endverbatim Asterisk Developers Room
*
+ * \par More
+ * \par
* If you would like to add a resource to this list please create an issue
* on the issue tracker with a patch.
*/
Modified: team/lathama/doxygencleanups/main/channel.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/channel.c?view=diff&rev=373383&r1=373382&r2=373383
==============================================================================
--- team/lathama/doxygencleanups/main/channel.c (original)
+++ team/lathama/doxygencleanups/main/channel.c Sat Sep 22 15:27:13 2012
@@ -814,7 +814,7 @@
*
* \note This function is not reentrant.
*
- * \param ast_channel_state state state
+ * \param state
*/
const char *ast_state2str(enum ast_channel_state state)
{
Modified: team/lathama/doxygencleanups/main/manager.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/manager.c?view=diff&rev=373383&r1=373382&r2=373383
==============================================================================
--- team/lathama/doxygencleanups/main/manager.c (original)
+++ team/lathama/doxygencleanups/main/manager.c Sat Sep 22 15:27:13 2012
@@ -1130,7 +1130,7 @@
};
/*! \brief In case you didn't read that giant block of text above the mansession_session struct, the
- * struct mansession is named this solely to keep the API the same in Asterisk. This structure really
+ * \ref struct mansession is named this solely to keep the API the same in Asterisk. This structure really
* represents data that is different from Manager action to Manager action. The mansession_session pointer
* contained within points to session-specific data.
*/
Modified: team/lathama/doxygencleanups/res/res_timing_kqueue.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/res/res_timing_kqueue.c?view=diff&rev=373383&r1=373382&r2=373383
==============================================================================
--- team/lathama/doxygencleanups/res/res_timing_kqueue.c (original)
+++ team/lathama/doxygencleanups/res/res_timing_kqueue.c Sat Sep 22 15:27:13 2012
@@ -3,7 +3,7 @@
*
* Copyright (C) 2010, Digium, Inc.
*
- * Tilghman Lesher \verbatim <tlesher AT digium DOT com> \endverbatim
+ * Tilghman Lesher <tlesher AT digium DOT com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
More information about the svn-commits
mailing list