[svn-commits] lathama: branch lathama/doxygencleanups r373380 - in /team/lathama/doxygencle...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Sat Sep 22 12:55:16 CDT 2012
Author: lathama
Date: Sat Sep 22 12:55:07 2012
New Revision: 373380
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=373380
Log:
Slowly adding more fixes and updates.
Modified:
team/lathama/doxygencleanups/Makefile
team/lathama/doxygencleanups/addons/chan_mobile.c
team/lathama/doxygencleanups/apps/app_adsiprog.c
team/lathama/doxygencleanups/apps/app_followme.c
team/lathama/doxygencleanups/apps/app_queue.c
team/lathama/doxygencleanups/apps/app_voicemail.c
team/lathama/doxygencleanups/channels/chan_sip.c
team/lathama/doxygencleanups/channels/iax2-provision.c
team/lathama/doxygencleanups/codecs/speex/speex_resampler.h
team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen
team/lathama/doxygencleanups/include/asterisk/doxyref.h
team/lathama/doxygencleanups/include/asterisk/pbx.h
team/lathama/doxygencleanups/main/asterisk.c
team/lathama/doxygencleanups/res/res_timing_kqueue.c
team/lathama/doxygencleanups/utils/refcounter.c
Modified: team/lathama/doxygencleanups/Makefile
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/Makefile?view=diff&rev=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/Makefile (original)
+++ team/lathama/doxygencleanups/Makefile Sat Sep 22 12:55:07 2012
@@ -746,6 +746,7 @@
doxygen -u contrib/asterisk-ng-doxygen
(cat contrib/asterisk-ng-doxygen; echo "HAVE_DOT=$(HAVEDOT)"; \
echo "PROJECT_NUMBER=$(ASTERISKVERSION)") | doxygen -
+ rm -f contrib/asterisk-ng-doxygen.bak
install-logrotate:
if [ ! -d "$(DESTDIR)$(ASTETCDIR)/../logrotate.d" ]; then \
Modified: team/lathama/doxygencleanups/addons/chan_mobile.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/addons/chan_mobile.c?view=diff&rev=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/addons/chan_mobile.c (original)
+++ team/lathama/doxygencleanups/addons/chan_mobile.c Sat Sep 22 12:55:07 2012
@@ -1524,8 +1524,8 @@
}
/*!
- * \brief Read until '\r\n'.
- * This function consumes the '\r\n' but does not add it to buf.
+ * \brief Read until \verbatim '\r\n'. \endverbatim
+ * This function consumes the \verbatim'\r\n'\endverbatim but does not add it to buf.
*/
static int rfcomm_read_until_crlf(int rsock, char **buf, size_t count, size_t *in_count)
{
@@ -1552,7 +1552,7 @@
/*!
* \brief Read the remainder of an AT SMS prompt.
- * \note the entire parsed string is '\r\n> '
+ * \note the entire parsed string is \verbatim '\r\n> ' \endverbatim
*
* By the time this function is executed, only a ' ' is left to read.
*/
@@ -1570,7 +1570,7 @@
}
/*!
- * \brief Read until a \r\nOK\r\n message.
+ * \brief Read until a \verbatim \r\nOK\r\n \endverbatim message.
*/
static int rfcomm_read_until_ok(int rsock, char **buf, size_t count, size_t *in_count)
{
@@ -1667,7 +1667,7 @@
/*!
* \brief Read the remainder of a +CMGR message.
- * \note the entire parsed string is '+CMGR: ...\r\n...\r\n...\r\n...\r\nOK\r\n'
+ * \note the entire parsed string is \verbatim '+CMGR: ...\r\n...\r\n...\r\n...\r\nOK\r\n' \endverbatim
*/
static int rfcomm_read_cmgr(int rsock, char **buf, size_t count, size_t *in_count)
{
@@ -1686,7 +1686,7 @@
/*!
* \brief Read and AT result code.
- * \note the entire parsed string is '\r\n<result code>\r\n'
+ * \note the entire parsed string is \verbatim '\r\n<result code>\r\n' \endverbatim
*/
static int rfcomm_read_result(int rsock, char **buf, size_t count, size_t *in_count)
{
@@ -1724,7 +1724,7 @@
/*!
* \brief Read the remainder of an AT command.
- * \note the entire parsed string is '<at command>\r'
+ * \note the entire parsed string is \verbatim '<at command>\r' \endverbatim
*/
static int rfcomm_read_command(int rsock, char **buf, size_t count, size_t *in_count)
{
@@ -2132,7 +2132,7 @@
* \brief Parse a CLIP event.
* \param hfp an hfp_pvt struct
* \param buf the buffer to parse (null terminated)
- * @note buf will be modified when the CID string is parsed
+ * \note buf will be modified when the CID string is parsed
* \return NULL on error (parse error) or a pointer to the caller id
* information in buf
*/
@@ -2178,7 +2178,7 @@
* \brief Parse a CMTI notification.
* \param hfp an hfp_pvt struct
* \param buf the buffer to parse (null terminated)
- * @note buf will be modified when the CMTI message is parsed
+ * \note buf will be modified when the CMTI message is parsed
* \return -1 on error (parse error) or the index of the new sms message
*/
static int hfp_parse_cmti(struct hfp_pvt *hfp, char *buf)
@@ -2203,7 +2203,7 @@
* \param from_number a pointer to a char pointer which will store the from
* number
* \param text a pointer to a char pointer which will store the message text
- * @note buf will be modified when the CMGR message is parsed
+ * \note buf will be modified when the CMGR message is parsed
* \retval -1 parse error
* \retval 0 success
*/
@@ -2266,7 +2266,7 @@
* \brief Parse a CUSD answer.
* \param hfp an hfp_pvt struct
* \param buf the buffer to parse (null terminated)
- * @note buf will be modified when the CUSD string is parsed
+ * \note buf will be modified when the CUSD string is parsed
* \return NULL on error (parse error) or a pointer to the cusd message
* information in buf
*/
Modified: team/lathama/doxygencleanups/apps/app_adsiprog.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_adsiprog.c?view=diff&rev=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/apps/app_adsiprog.c (original)
+++ team/lathama/doxygencleanups/apps/app_adsiprog.c Sat Sep 22 12:55:07 2012
@@ -23,6 +23,14 @@
* \author Mark Spencer <markster at digium.com>
*
* \ingroup applications
+ */
+
+/*!
+ * \par Uses configuration files
+ * \verbinclude adsi.conf.sample
+ * \verbinclude asterisk.adsi
+ *
+ * \addtogroup configuration_file Configuration Files
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/apps/app_followme.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_followme.c?view=diff&rev=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/apps/app_followme.c (original)
+++ team/lathama/doxygencleanups/apps/app_followme.c Sat Sep 22 12:55:07 2012
@@ -23,9 +23,15 @@
*
* \author BJ Weschke <bweschke at btwtech.com>
*
- * \arg See \ref Config_followme
*
* \ingroup applications
+ */
+
+/*!
+ * \par Uses configuration files
+ * \verbinclude followme.conf.sample
+ *
+ * \addtogroup configuration_file
*/
/*** MODULEINFO
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=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/apps/app_queue.c (original)
+++ team/lathama/doxygencleanups/apps/app_queue.c Sat Sep 22 12:55:07 2012
@@ -54,6 +54,13 @@
* by Matthew Enger <m.enger at xi.com.au>
*
* \ingroup applications
+ */
+
+/*!
+ * \par Uses configuration files
+ * \verbinclude queues.conf.sample
+ *
+ * \addtogroup configuration_file
*/
/*** MODULEINFO
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=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/apps/app_voicemail.c (original)
+++ team/lathama/doxygencleanups/apps/app_voicemail.c Sat Sep 22 12:55:07 2012
@@ -21,20 +21,27 @@
* \author Mark Spencer <markster at digium.com>
* \brief Comedian Mail - Voicemail System
*
- * \extref unixODBC (http://www.unixodbc.org/)
- * \extref A source distribution of University of Washington's IMAP c-client
+ * unixODBC (http://www.unixodbc.org/)
+ * A source distribution of University of Washington's IMAP c-client
* (http://www.washington.edu/imap/)
*
* \par See also
* \arg \ref Config_vm
* \note For information about voicemail IMAP storage, https://wiki.asterisk.org/wiki/display/AST/IMAP+Voicemail+Storage
- * \ingroup applications
- * \note This module requires res_adsi to load. This needs to be optional
+ * \ingroup applications
+ * \todo This module requires res_adsi to load. This needs to be optional
* during compilation.
*
- * \note This file is now almost impossible to work with, due to all \#ifdefs.
+ * \todo This file is now almost impossible to work with, due to all \#ifdefs.
* Feels like the database code before realtime. Someone - please come up
* with a plan to clean this up.
+ */
+
+/*!
+ * \par Uses configuration files
+ * \verbinclude voicemail.conf.sample
+ *
+ * \addtogroup configuration_file
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/channels/chan_sip.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_sip.c?view=diff&rev=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_sip.c (original)
+++ team/lathama/doxygencleanups/channels/chan_sip.c Sat Sep 22 12:55:07 2012
@@ -90,6 +90,14 @@
* \par Hanging up
* The PBX issues a hangup on both incoming and outgoing calls through
* the sip_hangup() function
+ */
+
+/*!
+ * \par Uses configuration files
+ * \verbinclude sip.conf.sample
+ * \verbinclude sip_notify.conf.sample
+ *
+ * \addtogroup configuration_file
*/
/*!
@@ -729,7 +737,6 @@
Default setttings are used as a channel setting and as a default when
configuring devices
*/
-/*@{*/
static char default_language[MAX_LANGUAGE]; /*!< Default language setting for new channels */
static char default_callerid[AST_MAX_EXTENSION]; /*!< Default caller ID for sip messages */
static char default_mwi_from[80]; /*!< Default caller ID for MWI updates */
@@ -749,7 +756,6 @@
static char default_zone[MAX_TONEZONE_COUNTRY]; /*!< Default tone zone for channels created from the SIP driver */
static unsigned int default_transports; /*!< Default Transports (enum sip_transport) that are acceptable */
static unsigned int default_primary_transport; /*!< Default primary Transport (enum sip_transport) for outbound connections to devices */
-/*@}*/
static struct sip_settings sip_cfg; /*!< SIP configuration data.
\note in the future we could have multiple of these (per domain, per device group etc) */
Modified: team/lathama/doxygencleanups/channels/iax2-provision.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/iax2-provision.c?view=diff&rev=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/channels/iax2-provision.c (original)
+++ team/lathama/doxygencleanups/channels/iax2-provision.c Sat Sep 22 12:55:07 2012
@@ -262,10 +262,8 @@
memset(&ied, 0, sizeof(ied));
ast_mutex_lock(&provlock);
- if (!(ast_db_get("iax/provisioning/cache", template, tmp, sizeof(tmp)))) {
- ast_log(LOG_ERROR, "ast_db_get failed to retrieve iax/provisioning/cache\n");
- ast_mutex_unlock(&provlock);
- return -1;
+ if (ast_db_get("iax/provisioning/cache", template, tmp, sizeof(tmp))) {
+ ast_log(LOG_ERROR, "ast_db_get failed to retrieve iax/provisioning/cache/%s\n", template);
}
if (sscanf(tmp, "v%30x", version) != 1) {
if (strcmp(tmp, "u")) {
Modified: team/lathama/doxygencleanups/codecs/speex/speex_resampler.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/codecs/speex/speex_resampler.h?view=diff&rev=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/codecs/speex/speex_resampler.h (original)
+++ team/lathama/doxygencleanups/codecs/speex/speex_resampler.h Sat Sep 22 12:55:07 2012
@@ -113,14 +113,15 @@
struct SpeexResamplerState_;
typedef struct SpeexResamplerState_ SpeexResamplerState;
-/** Create a new resampler with integer input and output rates.
- * @param nb_channels Number of channels to be processed
- * @param in_rate Input sampling rate (integer number of Hz).
- * @param out_rate Output sampling rate (integer number of Hz).
- * @param quality Resampling quality between 0 and 10, where 0 has poor quality
- * and 10 has very high quality.
- * @return Newly created resampler state
- * @retval NULL Error: not enough memory
+/** \brief Create a new resampler with integer input and output rates.
+ * \param nb_channels Number of channels to be processed
+ * \param in_rate Input sampling rate (integer number of Hz).
+ * \param out_rate Output sampling rate (integer number of Hz).
+ * \param quality Resampling quality between 0 and 10, where 0 has poor quality
+ * and 10 has very high quality.
+ * \param err
+ * \return Newly created resampler state
+ * \retval NULL Error: not enough memory
*/
SpeexResamplerState *speex_resampler_init(spx_uint32_t nb_channels,
spx_uint32_t in_rate,
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=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen (original)
+++ team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen Sat Sep 22 12:55:07 2012
@@ -300,7 +300,7 @@
EXTRACT_ALL = YES
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
EXTRACT_PRIVATE = NO
@@ -612,7 +612,7 @@
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
-EXCLUDE = doc/doxygen \
+EXCLUDE = doc/api \
menuselect \
res/pjproject \
addons/ooh323c/src
@@ -789,7 +789,7 @@
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
-HTML_OUTPUT = doxygen
+HTML_OUTPUT = api
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
@@ -1228,7 +1228,7 @@
# 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 =
+MAN_OUTPUT =
# The MAN_EXTENSION tag determines the extension that is added to
# the generated man pages (default is the subroutine's section .3)
@@ -1376,9 +1376,8 @@
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
-PREDEFINED = \
- __GNUC__ \
- __attribute__(x)=
+PREDEFINED = __GNUC__ \
+ __attribute__(x)=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
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=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/doxyref.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/doxyref.h Sat Sep 22 12:55:07 2012
@@ -1,7 +1,7 @@
/*
* Asterisk -- An open source telephony toolkit.
*
- * Copyright (C) 1999 - 2009, Digium, Inc.
+ * Copyright (C) 1999 - 2012, Digium, Inc.
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
@@ -17,15 +17,93 @@
/*!
* \file
*
- * This is the main header file used for generating miscellaneous developer
- * documentation using doxygen. This also pulls in all of the documentation
- * that is in include/asterisk/doxygen/.
+ * This is the main header file used for generating miscellaneous documentation
+ * using Doxygen. This also utilizes the documentation in
+ * include/asterisk/doxygen/ header files.
*/
/*
- * The following is for Doxygen Developer's documentation generated
- * by running "make progdocs" with doxygen installed on your
- * system.
+ * Doxygen Pages
+ */
+
+/*! \page system_requirements System Requirements
+ *
+ *
+ */
+
+/*! \page downloading_asterisk Downloading Asterisk
+ *
+ *
+ */
+
+/*! \page installing_asterisk Installing Asterisk
+ *
+ *
+ */
+
+/*! \page configuration_files Configuration Files
+ *
+ *
+ */
+
+/*! \page managing_configurations Managing Configurations
+ *
+ *
+ */
+
+/*! \page running_asterisk Running Asterisk
+ *
+ *
+ */
+
+/*! \page digium_support Digium Support
+ *
+ *
+ */
+
+/*! \page coding_guidelines Coding Guidlines
+ *
+ *
+ */
+
+/*! \page subversion_usage Subversion usage
+ *
+ *
+ */
+
+/*! \page
+ *
+ *
+ */
+
+/*! \page
+ *
+ *
+ */
+
+/*! \page
+ *
+ *
+ */
+
+/*! \page
+ *
+ *
+ */
+
+/*! \page
+ *
+ *
+ */
+
+/*! \page
+ *
+ *
+ */
+
+/*! \page
+ *
+ *
*/
/*!
@@ -58,6 +136,7 @@
* \arg \ref AstSpeech
*
* \section debugconfig Debugging and Configuration References
+ * \arg \ref AstREADME : General Administrator README file
* \arg \ref AstDebug : Hints on debugging
* \arg \ref extref
* \arg \ref ConfigFiles
@@ -128,19 +207,39 @@
* \li ast_channel_alloc()
*/
+/*!
+ * \page AstDebug Debugging
+ * \section debug Debugging
+ * \verbinclude backtrace.txt
+ */
+
+/*!
+ * \page AstSpeech The Generic Speech Recognition API
+ * \section debug The Generic Speech Recognition API
+ * \verbinclude speechrec.txt
+ */
+
+/*!
+ * \page DataStores Channel Data Stores
+ * \section debug Channel Data Stores
+ * \verbinclude datastores.txt
+ */
/*!
* \page AstAMI AMI - The Manager Interface
* \section ami AMI - The manager Interface
* \arg \link Config_ami Configuration file \endlink
* \arg \ref manager.c
+ * \verbinclude manager.txt
*/
/*!
* \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
+ * \verbinclude realtime.txt
+ * \verbinclude extconfig.txt
*/
/*!
@@ -169,6 +268,7 @@
* \arg \ref cdr_drivers
* \arg \ref Config_cdr CDR configuration files
*
+ * \verbinclude cdrdriver.txt
*/
/*!
@@ -184,6 +284,7 @@
/*!
* \page AstVideo Video support in Asterisk
* \section sectAstVideo Video support in Asterisk
+ * \verbinclude video.txt
*/
/*!
@@ -285,7 +386,9 @@
* \arg \link cdr_custom Custom CDR driver configuration \endlink
* \arg \link cdr_ami Manager CDR driver configuration \endlink
* \arg \link cdr_odbc ODBC CDR driver configuration \endlink
+ * \arg \link cdr_adaptive_odbc Adaptive ODBC CDR driver configuration \endlink
* \arg \link cdr_pgsql PostgreSQL CDR driver configuration \endlink
+ * \arg \link cdr_radius RADIUS CDR driver configuration \endlink
* \arg \link cdr_sqlite SQLite 2 CDR driver configuration \endlink
* \arg \link cdr_sqlite3_custom SQLite 3 CDR driver configuration \endlink
* \arg \link cdr_syslog Syslog CDR driver configuration \endlink
@@ -490,12 +593,28 @@
*/
/*!
+ * \page cdr_odbc Adaptive ODBC CDR driver configuration
+ * \arg See also \ref cdrconf
+ * \arg Implemented in \ref cdr_adaptive_odbc.c
+ * \verbinclude cdr_adaptive_odbc.conf.sample
+ * See also:
+ * \arg http://www.unixodbc.org
+ */
+
+/*!
* \page cdr_pgsql PostgreSQL CDR driver configuration
* \arg See also \ref cdrconf
* \arg Implemented in \ref cdr_pgsql.c
* See also:
* \arg http://www.postgresql.org
* \verbinclude cdr_pgsql.conf.sample
+ */
+
+/*!
+ * \page cdr_radius RADIUS CDR driver configuration
+ * \arg See also \ref cdrconf
+ * \arg Implemented in \ref cdr_radius.c
+ * \verbinclude cdr_radius.conf.sample
*/
/*!
@@ -539,7 +658,9 @@
* \arg \link cdr_custom Custom CDR driver configuration \endlink
* \arg \link cdr_ami Manager CDR driver configuration \endlink
* \arg \link cdr_odbc ODBC CDR driver configuration \endlink
+ * \arg \link cdr_adaptive_odbc Adaptive ODBC CDR driver configuration \endlink
* \arg \link cdr_pgsql PostgreSQL CDR driver configuration \endlink
+ * \arg \link cdr_radius RADIUS CDR driver configuration \endlink
* \arg \link cdr_sqlite SQLite 2 CDR driver configuration \endlink
* \arg \link cdr_sqlite3_custom SQLite 3 CDR driver configuration \endlink
* \arg \link cdr_syslog Syslog CDR driver configuration \endlink
@@ -602,6 +723,34 @@
*
* Additional sound files are available in the asterisk-addons
* repository on svn.digium.com
+ */
+
+/*!
+ * \page AstHTTP AMI over HTTP support
+ * The http.c file includes support for manager transactions over
+ * http.
+ * \section ami AMI - The manager Interface
+ * \arg \link Config_ami Configuration file \endlink
+ */
+
+/*!
+ * \page res_config_sqlite SQLite Resource driver configuration
+ * \arg Implemented in \ref res_config_sqlite.c
+ * \arg Configuration file:
+ * \verbinclude res_config_sqlite.conf
+ * \arg SQL tables:
+ * \arg See also:
+ * http://www.sqlite.org
+ */
+
+/*
+ * Doxygen Groups
+ */
+
+/*! \addtogroup configuration_file Configuration Files
+ * The following applications, resources and core files use a configuration
+ * file.
+ *
*/
/*!
@@ -662,22 +811,5 @@
* \section rtp_engine_blah Asterisk RTP Engines
*/
-/*!
- * \page AstHTTP AMI over HTTP support
- * The http.c file includes support for manager transactions over
- * http.
- * \section ami AMI - The manager Interface
- * \arg \link Config_ami Configuration file \endlink
- */
-
-/*!
- * \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/pbx.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/include/asterisk/pbx.h?view=diff&rev=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/pbx.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/pbx.h Sat Sep 22 12:55:07 2012
@@ -821,7 +821,7 @@
* \brief Add a context include
*
* \param con context to add the include to
- * \param include value to add
+ * \param value 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/main/asterisk.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/asterisk.c?view=diff&rev=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/main/asterisk.c (original)
+++ team/lathama/doxygencleanups/main/asterisk.c Sat Sep 22 12:55:07 2012
@@ -16,50 +16,134 @@
* at the top of the source tree.
*/
-/* Begin Doxygen Documentation */
/*!
- * \mainpage Asterisk -- The Open Source Telephony Project
+ * \mainpage Asterisk -- The Open Source Telephony Tool Kit
*
- * \par Welcome
+ * \section welcome Welcome
+ * This documentation created by the Doxygen project clearly explains the
+ * internals of the <a href="http://asterisk.org">Asterisk</a> Open Source
+ * Telephony Tool Kit. This documentation contains basic examples, developer
+ * documentation, support information, and information for upgrading. Effort
+ * is made to keep this documentation up to date and other resources exist in
+ * tandem with this documentation. Review all sources of reference if you have
+ * a question or concern.
+ *
+ * \section about About
+ * Asterisk is Open Source Software that forms an Open Source Tool Kit for
+ * creating part or the whole of a system for communication. The Asterisk
+ * software is used around the world for various solutions that enable phone,
+ * video, and all manner of communication. Asterisk development is also
+ * sponsored by Digium Inc. in Huntsville, AL. Asterisk was created by
+ * Mark Spencer who founded <a href="http://www.digium.com">Digium, Inc.</a>
+ * along with other Open Source Software like Pidgin (Formally GAIM).
*
- * This documentation created by the Doxygen project clearly explains the
- * internals of the Asterisk software. This documentation contains basic
- * examples, developer documentation, support information, and information
- * for upgrading.
+ * \section installation Installation
+ * To install Asterisk on your system there are a few steps depending
+ * on the platform and desired setup. Use these resources to keep moving!
+ * \li \ref system_requirements System Requirements
+ * \li \ref downloading_asterisk Downloading Asterisk
+ * \li \ref installing_asterisk Installing Asterisk
*
- *
- *
- * \par Developer Documentation for Asterisk
+ * \section configuration Configuration
+ * All software needs a little configuration, and Asterisk is no
+ * different. Learn about where and how Asterisk is configured in this section.
+ * \li \ref configuration_files Configuration Files
+ * \li \ref managing_configurations Managing Configurations
+ * \li \ref running_asterisk Running Asterisk
*
- * This is the main developer documentation for Asterisk. It is
- * generated by running "make progdocs" from the Asterisk source tree.
+ * \section support Support
+ * 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 digium_support Digium Support
*
- * In addition to the information available on the Asterisk source code,
- * please see the appendices for information on coding guidelines,
- * release management, commit policies, and more.
+ * \section community Community
+ * Asterisk is a big project and has a busy community. Look at the
+ * resources for questions and stick around to help answer questions.
+ * \li \ref asterisk_community_resources Asterisk Community Resources
*
- * \arg \ref AsteriskArchitecture
+ * \section development Development
+ * Many developers work on Asterisk everyday. If you need to do some
+ * 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
- * \arg \ref Licensing
- * \arg \ref DevDoc
- * \arg \ref ConfigFiles
+ * \li \ref Licensing
+ * \li \ref DevDoc
+ * \li \ref ConfigFiles
*
- * \section copyright Copyright and Author
+ * \section copyright Copyright and Authors
*
* 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>
+ * \li \ref credits Credits
+ */
+
+/*!
+ * \page asterisk_community_resources Asterisk Community Resources
+ * \par Websites
+ * \li http://www.asterisk.org Asterisk Homepage
+ * \li http://wiki.asterisk.org Asterisk Wiki
*
- * See http://www.asterisk.org for more information about
- * the Asterisk project. Please do not directly contact
- * any of the maintainers of this project for assistance;
- * the project provides a web site, mailing lists, and IRC
- * channels for your use.
+ * \par Mailing Lists
+ * All lists: http://lists.digium.com/mailman/listinfo
*
- * \todo Add pages for mailinglists, IRC, etc...
+ * \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]
+ * \li asterisk-biz Commercial and Business-Oriented Asterisk Discussion
+ * \li Asterisk-BSD Asterisk on BSD discussion
+ * \li asterisk-bugs [no description available]
+ * \li asterisk-commits SVN commits to the Asterisk project
+ * \li asterisk-dev Asterisk Developers Mailing List
+ * \li asterisk-doc Discussions regarding The Asterisk Documentation Project
+ * \li asterisk-embedded Asterisk Embedded Development
+ * \li asterisk-gui Asterisk GUI project discussion
+ * \li asterisk-gui-commits SVN commits to the Asterisk-GUI project
+ * \li asterisk-ha-clustering Asterisk High Availability and Clustering List - Non-Commercial Discussion
+ * \li Asterisk-i18n Discussion of Asterisk internationalization
+ * \li asterisk-r2 [no description available]
+ * \li asterisk-scf-commits Commits to the Asterisk SCF project code repositories
+ * \li asterisk-scf-committee Asterisk SCF Steering Committee discussions
+ * \li asterisk-scf-dev Asterisk SCF Developers Mailing List
+ * \li asterisk-scf-wiki-changes Changes to the Asterisk SCF space on wiki.asterisk.org
+ * \li asterisk-security Asterisk Security Discussion
+ * \li asterisk-speech-rec Use of speech recognition in Asterisk
+ * \li asterisk-ss7 [no description available]
+ * \li asterisk-users Asterisk Users Mailing List - Non-Commercial Discussion
+ * \li asterisk-video Development discussion of video media support in Asterisk
+ * \li asterisk-wiki-changes Changes to the Asterisk space on wiki.asterisk.org
+ * \li asterisknow AsteriskNOW Discussion
+ * \li dahdi-commits SVN commits to the DAHDI project
+ * \li digium-announce Digium Product Announcements
+ * \li Dundi Distributed Universal Number Discovery
+ * \li libiax2-commits SVN commits to the libiax2 project
+ * \li libpri-commits SVN commits to the libpri project
+ * \li libss7-commits SVN commits to the libss7 project
+ * \li svn-commits SVN commits to the Digium repositories
+ * \li Test-results Results from automated testing
+ * \li thirdparty-commits SVN commits to the Digium third-party software repository
+ * \li zaptel-commits SVN commits to the Zaptel project
+ *
+ * \par Forums
+ * Forums are located at http://forums.asterisk.org/
+ *
+ * \par IRC
+ * 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
+ *
+ * If you would like to add a resource to this list please create an issue
+ * on the issue tracker with a patch.
*/
/*! \file
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=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/res/res_timing_kqueue.c (original)
+++ team/lathama/doxygencleanups/res/res_timing_kqueue.c Sat Sep 22 12:55:07 2012
@@ -3,7 +3,7 @@
*
* Copyright (C) 2010, Digium, Inc.
*
- * Tilghman Lesher tlesher AT digium DOT com
+ * Tilghman Lesher \verbatim <tlesher AT digium DOT com> \endverbatim
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
@@ -18,9 +18,11 @@
/*!
* \file
- * \author Tilghman Lesher tlesher AT digium DOT com
+ * \author Tilghman Lesher \verbatim <tlesher AT digium DOT com> \endverbatim
*
* \brief kqueue timing interface
+ *
+ * \ingroup resource
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/utils/refcounter.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/utils/refcounter.c?view=diff&rev=373380&r1=373379&r2=373380
==============================================================================
--- team/lathama/doxygencleanups/utils/refcounter.c (original)
+++ team/lathama/doxygencleanups/utils/refcounter.c Sat Sep 22 12:55:07 2012
@@ -15,9 +15,10 @@
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
+
/*! \file
*
- * \brief A program to read in the /tmp/refs file generated
+ * \brief A program to read in the /tmp/refs file generated
* by astobj2 code when the REF_DEBUG macro is defined.
* It will read in the file line by line, and
* sort the data out by object, and check to see
@@ -28,15 +29,15 @@
* this program reads in the /tmp/refs file and
* generates no output. No news is good news.
* The contents of the /tmp/refs file looks like this:
- *
-0x84fd718 -1 astobj2.c:926:cd_cb_debug (deref object via container destroy) [@1]
-0x84fd718 =1 chan_sip.c:19760:build_user (allocate a user struct)
-0x84fd718 +1 chan_sip.c:21558:reload_config (link user into users table) [@1]
-0x84fd718 -1 chan_sip.c:2376:unref_user (Unref the result of build_user. Now, the table link is the only one left.) [@2]
-0x84fd718 **call destructor** astobj2.c:926:cd_cb_debug (deref object via container destroy)
- *
- *
- * \author Steve Murphy <murf at digium.com>
+ * \verbatim
+ * 0x84fd718 -1 astobj2.c:926:cd_cb_debug (deref object via container destroy) [@1]
+ * 0x84fd718 =1 chan_sip.c:19760:build_user (allocate a user struct)
+ * 0x84fd718 +1 chan_sip.c:21558:reload_config (link user into users table) [@1]
+ * 0x84fd718 -1 chan_sip.c:2376:unref_user (Unref the result of build_user. Now, the table link is the only one left.) [@2]
+ * 0x84fd718 **call destructor** astobj2.c:926:cd_cb_debug (deref object via container destroy)
+ * \endverbatim
+ *
+ * \author Steve Murphy <murf at digium.com>
*/
/*** MODULEINFO
More information about the svn-commits
mailing list