[svn-commits] lathama: branch lathama/doxygencleanups r373381 - in /team/lathama/doxygencle...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Sat Sep 22 14:18:50 CDT 2012
Author: lathama
Date: Sat Sep 22 14:18:46 2012
New Revision: 373381
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=373381
Log:
Syncing in more of my branch. Starting to look good.
Modified:
team/lathama/doxygencleanups/addons/chan_mobile.c
team/lathama/doxygencleanups/apps/app_minivm.c
team/lathama/doxygencleanups/apps/app_queue.c
team/lathama/doxygencleanups/cel/cel_odbc.c
team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen
team/lathama/doxygencleanups/doc/README.txt
team/lathama/doxygencleanups/include/asterisk/doxyref.h
team/lathama/doxygencleanups/main/astfd.c
team/lathama/doxygencleanups/res/res_config_pgsql.c
team/lathama/doxygencleanups/res/res_config_sqlite.c
team/lathama/doxygencleanups/tests/test_gosub.c
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=373381&r1=373380&r2=373381
==============================================================================
--- team/lathama/doxygencleanups/addons/chan_mobile.c (original)
+++ team/lathama/doxygencleanups/addons/chan_mobile.c Sat Sep 22 14:18:46 2012
@@ -1758,8 +1758,8 @@
* \endverbatim
*
* These formats correspond to AT result codes, AT commands, and the AT SMS
- * prompt respectively. When messages are read the leading and trailing '\r'
- * and '\n' characters are discarded. If the given buffer is not large enough
+ * prompt respectively. When messages are read the leading and trailing \verbatim '\r' \endverbatim
+ * and \verbatim '\n' \endverbatim characters are discarded. If the given buffer is not large enough
* to hold the response, what does not fit in the buffer will be dropped.
*
* \note The rfcomm connection to the device is asynchronous, so there is no
Modified: team/lathama/doxygencleanups/apps/app_minivm.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_minivm.c?view=diff&rev=373381&r1=373380&r2=373381
==============================================================================
--- team/lathama/doxygencleanups/apps/app_minivm.c (original)
+++ team/lathama/doxygencleanups/apps/app_minivm.c Sat Sep 22 14:18:46 2012
@@ -26,7 +26,6 @@
* based on the Comedian Mail voicemail system (app_voicemail.c).
*
* \par See also
- * \arg \ref Config_minivm
* \arg \ref Config_minivm_examples
* \arg \ref App_minivm
*
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=373381&r1=373380&r2=373381
==============================================================================
--- team/lathama/doxygencleanups/apps/app_queue.c (original)
+++ team/lathama/doxygencleanups/apps/app_queue.c Sat Sep 22 14:18:46 2012
@@ -5808,7 +5808,7 @@
/*! \brief Dump all members in a specific queue to the database
* \code
* <pm_family>/<queuename> = <interface>;<penalty>;<paused>;<state_interface>[|...]
- * \code
+ * \endcode
*/
static void dump_queue_members(struct call_queue *pm_queue)
{
Modified: team/lathama/doxygencleanups/cel/cel_odbc.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/cel/cel_odbc.c?view=diff&rev=373381&r1=373380&r2=373381
==============================================================================
--- team/lathama/doxygencleanups/cel/cel_odbc.c (original)
+++ team/lathama/doxygencleanups/cel/cel_odbc.c Sat Sep 22 14:18:46 2012
@@ -22,7 +22,7 @@
*
* \brief ODBC CEL backend
*
- * \author Tilghman Lesher <tlesher AT digium DOT com>
+ * \author Tilghman Lesher \verbatim <tlesher AT digium DOT com> \endverbatim
* \ingroup cel_drivers
*/
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=373381&r1=373380&r2=373381
==============================================================================
--- team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen (original)
+++ team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen Sat Sep 22 14:18:46 2012
@@ -547,7 +547,7 @@
# parameters in a documented function, or documenting parameters that
# don't exist or using markup commands wrongly.
-WARN_IF_DOC_ERROR = YES
+WARN_IF_DOC_ERROR = NO
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
@@ -570,7 +570,7 @@
# and error messages should be written. If left blank the output is written
# to stderr.
-WARN_LOGFILE =
+WARN_LOGFILE = doxygen.log
#---------------------------------------------------------------------------
# configuration options related to the input files
Modified: team/lathama/doxygencleanups/doc/README.txt
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/doc/README.txt?view=diff&rev=373381&r1=373380&r2=373381
==============================================================================
--- team/lathama/doxygencleanups/doc/README.txt (original)
+++ team/lathama/doxygencleanups/doc/README.txt Sat Sep 22 14:18:46 2012
@@ -1,10 +1,14 @@
The vast majority of the Asterisk project documentation has been moved to the
project wiki:
- http://wiki.asterisk.org/
+ https://wiki.asterisk.org/
Asterisk release tarballs contain an export of the wiki in PDF and plain text
form, which you can find in:
doc/AST.pdf
doc/AST.txt
+
+Asterisk uses the Doxygen documentation software. Run "make progdocs" and open
+the resulting documentation index at doc/api/index.html in a webbrowser or copy
+the directory to a directory served by a webserver for remote access.
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=373381&r1=373380&r2=373381
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/doxyref.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/doxyref.h Sat Sep 22 14:18:46 2012
@@ -43,6 +43,35 @@
/*! \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
*
*/
@@ -71,13 +100,13 @@
*
*/
-/*! \page
- *
- *
- */
-
-/*! \page
- *
+/*! \page community_support Community Support
+ *
+ *
+ */
+
+/*! \page credits Credits
+ * \verbinclude CREDITS
*
*/
@@ -210,19 +239,16 @@
/*!
* \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
*/
/*!
@@ -230,7 +256,6 @@
* \section ami AMI - The manager Interface
* \arg \link Config_ami Configuration file \endlink
* \arg \ref manager.c
- * \verbinclude manager.txt
*/
/*!
@@ -238,8 +263,6 @@
* \section realtime ARA - a generic API to storage and retrieval
* Implemented in \ref config.c
* Implemented in \ref pbx_realtime.c
- * \verbinclude realtime.txt
- * \verbinclude extconfig.txt
*/
/*!
@@ -268,7 +291,6 @@
* \arg \ref cdr_drivers
* \arg \ref Config_cdr CDR configuration files
*
- * \verbinclude cdrdriver.txt
*/
/*!
@@ -284,7 +306,6 @@
/*!
* \page AstVideo Video support in Asterisk
* \section sectAstVideo Video support in Asterisk
- * \verbinclude video.txt
*/
/*!
@@ -386,9 +407,7 @@
* \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
@@ -501,7 +520,7 @@
* \page Config_dahdi DAHDI configuration
* \section dahdiconf dahdi.conf
* \arg Implemented in \ref chan_dahdi.c
- * \verbinclude dahdi.conf.sample
+ * \verbinclude chan_dahdi.conf.sample
*/
/*!
@@ -595,8 +614,6 @@
/*!
* \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
*/
@@ -608,13 +625,6 @@
* 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
*/
/*!
@@ -658,9 +668,7 @@
* \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
Modified: team/lathama/doxygencleanups/main/astfd.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/astfd.c?view=diff&rev=373381&r1=373380&r2=373381
==============================================================================
--- team/lathama/doxygencleanups/main/astfd.c (original)
+++ team/lathama/doxygencleanups/main/astfd.c Sat Sep 22 14:18:46 2012
@@ -20,7 +20,7 @@
*
* \brief Debugging routines for file descriptor leaks
*
- * \author Tilghman Lesher <tlesher at digium.com>
+ * \author Tilghman Lesher \verbatim <tlesher at digium.com> \endverbatim
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/res/res_config_pgsql.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/res/res_config_pgsql.c?view=diff&rev=373381&r1=373380&r2=373381
==============================================================================
--- team/lathama/doxygencleanups/res/res_config_pgsql.c (original)
+++ team/lathama/doxygencleanups/res/res_config_pgsql.c Sat Sep 22 14:18:46 2012
@@ -139,7 +139,7 @@
* \return -2 on query failure that resulted in disconnection
* \return 0 on success
*
- * \example see pgsql_exec for full example
+ * \note see pgsql_exec for full example
*/
static int _pgsql_exec(const char *database, const char *tablename, const char *sql, PGresult **result)
{
Modified: team/lathama/doxygencleanups/res/res_config_sqlite.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/res/res_config_sqlite.c?view=diff&rev=373381&r1=373380&r2=373381
==============================================================================
--- team/lathama/doxygencleanups/res/res_config_sqlite.c (original)
+++ team/lathama/doxygencleanups/res/res_config_sqlite.c Sat Sep 22 14:18:46 2012
@@ -36,7 +36,7 @@
*
* \section conf_sec Configuration
*
- * The main configuration file is res_config_sqlite.conf. It must be readable or
+ * The main configuration file is res_config_sqlite.conf.sample It must be readable or
* res_config_sqlite will fail to start. It is suggested to use the sample file
* in this package as a starting point. The file has only one section
* named <code>general</code>. Here are the supported parameters :
Modified: team/lathama/doxygencleanups/tests/test_gosub.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/tests/test_gosub.c?view=diff&rev=373381&r1=373380&r2=373381
==============================================================================
--- team/lathama/doxygencleanups/tests/test_gosub.c (original)
+++ team/lathama/doxygencleanups/tests/test_gosub.c Sat Sep 22 14:18:46 2012
@@ -20,7 +20,7 @@
* \file
* \brief Gosub tests
*
- * \author\verbatim Tilghman Lesher <tlesher AT digium DOT com> \endverbatim
+ * \author Tilghman Lesher \verbatim <tlesher AT digium DOT com> \endverbatim
*
* \ingroup tests
*/
More information about the svn-commits
mailing list