[asterisk-commits] lathama: branch lathama/doxygencleanups r373401 - in /team/lathama/doxygencle...
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Sun Sep 23 09:02:17 CDT 2012
Author: lathama
Date: Sun Sep 23 09:02:12 2012
New Revision: 373401
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=373401
Log:
enable link to configurations form mainpage
Modified:
team/lathama/doxygencleanups/channels/chan_sip.c
team/lathama/doxygencleanups/contrib/doxygen.conf
team/lathama/doxygencleanups/include/asterisk/doxyref.h
team/lathama/doxygencleanups/main/asterisk.c
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=373401&r1=373400&r2=373401
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_sip.c (original)
+++ team/lathama/doxygencleanups/channels/chan_sip.c Sun Sep 23 09:02:12 2012
@@ -94,10 +94,18 @@
/*!
* \par Uses configuration files
- * \verbinclude sip.conf.sample
- * \verbinclude sip_notify.conf.sample
+ * \li \ref sip.conf
+ * \li \ref sip_notify.conf
*
* \addtogroup configuration_file
+ */
+
+/*! \page sip.conf sip.conf
+ * \verbinclude sip.conf.sample
+ */
+
+/*! \page sip_notify.conf sip_notify.conf
+ * \verbinclude sip_notify.conf.sample
*/
/*!
Modified: team/lathama/doxygencleanups/contrib/doxygen.conf
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/contrib/doxygen.conf?view=diff&rev=373401&r1=373400&r2=373401
==============================================================================
--- team/lathama/doxygencleanups/contrib/doxygen.conf (original)
+++ team/lathama/doxygencleanups/contrib/doxygen.conf Sun Sep 23 09:02:12 2012
@@ -631,7 +631,8 @@
EXCLUDE_PATTERNS = *.o \
*.o.d \
- .*
+ .* \
+ /api/
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
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=373401&r1=373400&r2=373401
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/doxyref.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/doxyref.h Sun Sep 23 09:02:12 2012
@@ -360,13 +360,11 @@
/*!
* \page ConfigFiles Configuration files
* \section config Main configuration files
- * \arg \link Config_ast asterisk.conf - the main configuration file \endlink
* \arg \link Config_ext extensions.conf - The Dial Plan \endlink
* \arg \link Config_mod modules.conf - which modules to load and not to load \endlink
* \arg \link Config_fea features.conf - call features (transfer, parking, etc) \endlink
* \section chanconf Channel configuration files
* \arg \link Config_iax IAX2 configuration \endlink
- * \arg \link Config_sip SIP configuration \endlink
* \arg \link Config_mgcp MGCP configuration \endlink
* \arg \link Config_rtp RTP configuration \endlink
* \arg \link Config_dahdi DAHDI configuration \endlink
@@ -375,11 +373,6 @@
* \arg \link Config_agent Agent (proxy channel) configuration \endlink
* \arg \link Config_misdn MISDN Experimental ISDN BRI channel configuration \endlink
* \arg \link Config_h323 H.323 configuration \endlink
- * \section appconf Application configuration files
- * \arg \link Config_mm Meetme (conference bridge) configuration \endlink
- * \arg \link Config_qu Queue system configuration \endlink
- * \arg \link Config_vm Voicemail configuration \endlink
- * \arg \link Config_followme Followme configuration \endlink
* \section cdrconf CDR configuration files
* \arg \link Config_cdr CDR configuration \endlink
* \arg \link cdr_csv Default CDR driver configuration \endlink
@@ -404,306 +397,6 @@
*/
/*!
- * \page Config_ast Asterisk.conf
- */
-
-/*!
- * \page Config_mod Modules configuration
- * All res_ resource modules are loaded with globals on, which means
- * that non-static functions are callable from other modules.
- *
- * If you want your non res_* module to export functions to other modules
- * you have to include it in the [global] section.
- * \verbinclude modules.conf.sample
- */
-
-/*!
- * \page Config_fea Call features configuration
- * \par See also
- * \arg \ref features.c : Call feature implementation
- * \section featconf features.conf
- * \verbinclude features.conf.sample
- */
-
-/*!
- * \page Config_followme Followme: An application for simple follow-me calls
- * \section followmeconf Followme.conf
- * - See app_followme.c
- * \verbinclude followme.conf.sample
- */
-
-/*!
- * \page Config_ext Extensions.conf - the Dial Plan
- * \section dialplan Extensions.conf
- * \verbinclude extensions.conf.sample
- */
-
-/*!
- * \page Config_iax IAX2 configuration
- * IAX2 is implemented in \ref chan_iax2.c
- * \arg \link Config_iax iax.conf Configuration file example \endlink
- * \section iaxreadme IAX readme file
- * \section Config_iax IAX Configuration example
- * \verbinclude iax.conf.sample
- * \section iaxjitter IAX Jitterbuffer information
- */
-
-/*!
- * \page Config_iax IAX configuration
- * \arg Implemented in \ref chan_iax2.c
- * \section iaxconf iax.conf
- * \verbinclude iax.conf.sample
- */
-
-/*!
- * \page Config_sip SIP configuration
- * Also see \ref Config_rtp RTP configuration
- * \arg Implemented in \ref chan_sip.c
- * \section sipconf sip.conf
- * \verbinclude sip.conf.sample
- *
- * \arg \b Back \ref chanconf
- */
-
-/*!
- * \page Config_mgcp MGCP configuration
- * Also see \ref Config_rtp RTP configuration
- * \arg Implemented in \ref chan_mgcp.c
- * \section mgcpconf mgcp.conf
- * \verbinclude mgcp.conf.sample
- */
-
-/*!
- * \page README_misdn MISDN documentation
- * \arg See \ref Config_misdn
- * \section mISDN configuration
- */
-
-/*!
- * \page Config_misdn MISDN configuration
- * \arg Implemented in \ref chan_misdn.c
- * \arg \ref README_misdn
- * \arg See the mISDN home page: http://www.isdn4linux.de/mISDN/
- * \section misdnconf misdn.conf
- * \verbinclude misdn.conf.sample
- */
-
-/*!
- * \page Config_vm VoiceMail configuration
- * \section vmconf voicemail.conf
- * \arg Implemented in \ref app_voicemail.c
- * \verbinclude voicemail.conf.sample
- */
-
-/*!
- * \page Config_dahdi DAHDI configuration
- * \section dahdiconf dahdi.conf
- * \arg Implemented in \ref chan_dahdi.c
- * \verbinclude dahdi.conf.sample
- */
-
-/*!
- * \page Config_h323 H.323 channel driver information
- * This is the configuration of the H.323 channel driver within the Asterisk
- * distribution. There's another one, called OH323, in asterisk-addons
- * \arg Implemented in \ref chan_h323.c
- * \section h323conf h323.conf
- * \ref chan_h323.c
- */
-
-/*!
- * \page Config_oss OSS configuration
- * \section ossconf oss.conf
- * \arg Implemented in \ref chan_oss.c
- * \verbinclude oss.conf.sample
- */
-
-/*!
- * \page Config_alsa ALSA configuration
- * \section alsaconf alsa.conf
- * \arg Implemented in \ref chan_alsa.c
- * \verbinclude alsa.conf.sample
- */
-
-/*!
- * \page Config_agent Agent configuration
- * \section agentconf agents.conf
- * The agent channel is a proxy channel for queues
- * \arg Implemented in \ref chan_agent.c
- * \verbinclude agents.conf.sample
- */
-
-/*!
- * \page Config_rtp RTP configuration
- * \arg Implemented in \ref rtp.c
- * Used in \ref chan_sip.c and \ref chan_mgcp.c (and various H.323 channels)
- * \section rtpconf rtp.conf
- * \verbinclude rtp.conf.sample
- */
-
-/*!
- * \page Config_dun DUNDi Configuration
- * \arg See also \ref AstDUNDi
- * \section dundiconf dundi.conf
- * \verbinclude dundi.conf.sample
- */
-
-/*!
- * \page Config_enum ENUM Configuration
- * \section enumconf enum.conf
- * \arg See also \ref enumreadme
- * \arg Implemented in \ref func_enum.c and \ref enum.c
- * \verbinclude enum.conf.sample
- */
-
-/*!
- * \page cdr_csv Default CDR driver configuration
- * \par See also
- * \arg \ref cdrconf
- * \arg Implemented in \ref cdr_csv.c
- * \verbinclude cdr.conf.sample
- */
-
-/*!
- * \page cdr_custom Custom CDR Configuration
- * \par See also
- * \arg \ref cdrconf
- * \arg Implemented in \ref cdr_custom.c
- * \verbinclude cdr_custom.conf.sample
- */
-
-/*!
- * \page cdr_ami Manager CDR driver configuration
- * \par See also
- * \arg \ref cdrconf
- * \arg \ref AstAMI
- * \arg Implemented in \ref cdr_manager.c
- * \verbinclude cdr_manager.conf.sample
- */
-
-/*!
- * \page cdr_odbc ODBC CDR driver configuration
- * \arg See also \ref cdrconf
- * \arg Implemented in \ref cdr_odbc.c
- * \verbinclude cdr_odbc.conf.sample
- * See also:
- * \arg http://www.unixodbc.org
- */
-
-/*!
- * \page cdr_odbc Adaptive ODBC CDR driver configuration
- * \li See also \ref cdrconf
- * \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_sqlite SQLite 2 CDR driver configuration
- * \arg See also \ref cdrconf
- * \arg Implemented in \ref cdr_sqlite.c
- * See also:
- * \arg http://www.sqlite.org
- */
-
-/*!
- * \page cdr_sqlite3_custom SQLite 3 CDR driver configuration
- * \arg See also \ref cdrconf
- * \arg Implemented in \ref cdr_sqlite3_custom.c
- * See also:
- * \arg http://www.sqlite.org
- * \verbinclude cdr_sqlite3_custom.conf.sample
- */
-
-/*!
- * \page cdr_syslog Syslog CDR driver configuration
- * \arg See also \ref cdrconf
- * \arg \ref cdr_syslog.c
- * \verbinclude cdr_syslog.conf.sample
- */
-
-/*!
- * \page cdr_tds FreeTDS CDR driver configuration
- * \arg See also \ref cdrconf
- * See also:
- * \arg http://www.freetds.org
- * \verbinclude cdr_tds.conf.sample
- */
-
-/*!
- * \page Config_cdr CDR configuration
- * \par See also
- * \arg \ref cdr_drivers
- * \arg \link Config_cdr CDR configuration \endlink
- * \arg \link cdr_csv Default CDR driver configuration \endlink
- * \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_pgsql PostgreSQL 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
- * \arg \link cdr_tds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink
- * \verbinclude cdr.conf.sample
- */
-
-/*!
- * \page Config_moh Music on Hold Configuration
- * \arg Implemented in \ref res_musiconhold.c
- * \section mohconf musiconhold.conf
- * \verbinclude musiconhold.conf.sample
- */
-
-/*!
- * \page Config_adsi ADSI Configuration
- * \section adsiconf adsi.conf
- * \verbinclude adsi.conf.sample
- */
-
-/*!
- * \page Config_codec CODEC Configuration
- * \section codecsconf codecs.conf
- * \verbinclude codecs.conf.sample
- */
-
-/*!
- * \page Config_ara REALTIME Configuration
- * \arg See also: \arg \link AstARA \endlink
- * \section extconf extconfig.conf
- * \verbinclude extconfig.conf.sample
- */
-
-/*!
- * \page Config_ami AMI configuration
- * \arg See also: \arg \link AstAMI \endlink
- * \section amiconf manager.conf
- * \verbinclude manager.conf.sample
- */
-
-/*!
- * \page Config_qu ACD - Queue system configuration
- * \arg Implemented in \ref app_queue.c
- * \section quconf queues.conf
- * \verbinclude queues.conf.sample
- */
-
-/*!
- * \page Config_mm Meetme - The conference bridge configuration
- * \arg Implemented in \ref app_meetme.c
- * \section mmconf meetme.conf
- * \verbinclude meetme.conf.sample
- */
-
-/*!
* \page SoundFiles Sound files
* \section SecSound Asterisk Sound files
* Asterisk includes a large number of sound files. Many of these
@@ -721,23 +414,11 @@
* \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.
*
*/
Modified: team/lathama/doxygencleanups/main/asterisk.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/asterisk.c?view=diff&rev=373401&r1=373400&r2=373401
==============================================================================
--- team/lathama/doxygencleanups/main/asterisk.c (original)
+++ team/lathama/doxygencleanups/main/asterisk.c Sun Sep 23 09:02:12 2012
@@ -47,7 +47,7 @@
* \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
+ * \li \ref configuration_file
* \li \ref managing_configurations
* \li \ref running_asterisk
*
More information about the asterisk-commits
mailing list