kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-11-16 14:58:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen Updates - Title update

Browse Source 
Update and extend the configuration_file group and enable linking. Commit other cleanups from multi-version Doxygen testing.  Update title that was left behind many years ago.

(issue ASTERISK-20259)


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@375182 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Andrew Latham
2012-10-18 14:17:40 +00:00
parent 68c63d7965
commit 6c20cf2d8a
34 changed files with 132 additions and 379 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/asterisk.h
View File

@@ -1,5 +1,5 @@
/*
* Asterisk -- A telephony toolkit for Linux.
* Asterisk -- An open source telephony toolkit.
*
* General Definitions for Asterisk top level program
*

2
include/asterisk/compat.h
View File

@@ -1,5 +1,5 @@
/*
* Asterisk -- A telephony toolkit for Linux.
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 1999-2006, Digium, Inc.
*

1
include/asterisk/doxygen/architecture.h
View File

@@ -24,7 +24,6 @@
/*!
\page AsteriskArchitecture Asterisk Architecture Overview
\author Russell Bryant <russell@digium.com>
\AsteriskTrunkWarning
<hr>

2
include/asterisk/doxygen/asterisk-git-howto.h
View File

@@ -21,8 +21,6 @@
/*!
* \page AsteriskGitHowto How to setup a local GIT mirror of the Asterisk SVN repository
*
* \AsteriskTrunkWarning
*
* <hr>
*
* \section Introduction Introduction

4
include/asterisk/doxygen/commits.h
View File

@@ -21,8 +21,6 @@
/*!
* \page CommitMessages Guidelines for Commit Messages
*
* \AsteriskTrunkWarning
*
* <hr>
*
* \section CommitMsgFormatting Commit Message Formatting
@@ -114,5 +112,3 @@
* see the following page on %asterisk.org:
* \arg http://www.asterisk.org/developers/svn-branching-merging
*/

2
include/asterisk/doxygen/licensing.h
View File

@@ -22,7 +22,7 @@
* \page Licensing Asterisk Licensing Information
*
* \section license Asterisk License
* \verbinclude LICENSE
* \note See the LICENSE file for up to date info
*
* \section otherlicenses Licensing of 3rd Party Code
*

4
include/asterisk/doxygen/releases.h
View File

@@ -21,8 +21,6 @@
/*!
* \page ReleaseStatus Asterisk Release Status
*
* @AsteriskTrunkWarning
*
* \section warranty Warranty
* The following warranty applies to all open source releases of Asterisk:
*
@@ -124,8 +122,6 @@
/*!
* \page ReleasePolicies Asterisk Release and Commit Policies
*
* \AsteriskTrunkWarning
*
* \section releasestatus Asterisk Release Status
*
* For more information on the current status of each Asterisk release series,

2
include/asterisk/doxygen/reviewboard.h
View File

@@ -21,8 +21,6 @@
/*!
* \page Reviewboard Reviewboard Usage and Guidelines
*
* \AsteriskTrunkWarning
*
* <hr>
*
* \section ReviewboardGuidelines Usage Guidelines

343
include/asterisk/doxyref.h
View File

@@ -58,7 +58,6 @@
* \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
@@ -130,24 +129,6 @@
* \li ast_channel_alloc()
*/
/*!
* \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
*/
/*!
* \page AstAMI AMI - The Manager Interface
* \section ami AMI - The manager Interface
@@ -180,7 +161,7 @@
* \par References
* \arg DUNDi is documented at http://www.dundi.com
* \arg Implemented in \ref pbx_dundi.c and \ref dundi-parser.c
* \arg Configuration in \link Config_dun dundi.conf \endlink
* \arg Configuration in \ref dundi.conf
*/
/*!
@@ -194,11 +175,6 @@
* \todo include missing cdrdriver txt
*/
/*!
* \page AstREADME README
* \verbinclude README
*/
/*!
* \page AstCREDITS CREDITS
* \verbinclude CREDITS
@@ -271,63 +247,6 @@
* with the list starting at varshead in struct ast_channel
*/
/*!
* \page AstENUM ENUM
* \section enumreadme ENUM
* \arg Configuration: \ref Config_enum
* \arg \ref enum.c
* \arg \ref func_enum.c
*
*/
/*!
* \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
* \arg \link Config_oss OSS (sound card) configuration \endlink
* \arg \link Config_alsa ALSA (sound card) configuration \endlink
* \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
* \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
* \arg \link cdr_tds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink
* \section miscconf Miscellenaous configuration files
* \arg \link Config_adsi ADSI configuration \endlink
* \arg \link Config_ami AMI - Manager configuration \endlink
* \arg \link Config_ara Realtime configuration \endlink
* \arg \link Config_codec Codec configuration \endlink
* \arg \link Config_dun DUNDi configuration \endlink
* \arg \link Config_enum ENUM configuration \endlink
* \arg \link Config_moh Music on Hold configuration \endlink
* \arg \link Config_vm Voicemail configuration \endlink
* \arg \link res_config_sqlite SQLite Resource driver configuration \endlink
*/
/*!
* \page Config_mod Modules configuration
* All res_ resource modules are loaded with globals on, which means
@@ -335,15 +254,6 @@
*
* 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
*/
/*!
@@ -352,101 +262,6 @@
* \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
@@ -455,136 +270,6 @@
* \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_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
* \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
@@ -605,20 +290,6 @@
* \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
@@ -637,16 +308,6 @@
* \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
*/
@@ -671,7 +332,7 @@
*/
/*!
* \addtogroup applications Module: Dial plan applications
* \addtogroup applications Dial plan applications
* \section app_generic Asterisk Dial Plan Applications
* \brief Applications support the dialplan. They register dynamically with
* \see ast_register_application() and unregister with

3
include/asterisk/module.h
View File

@@ -25,8 +25,7 @@
* provide and some other module related functions.
*/
/*!
* \li The Modules library uses the configuration file \ref modules.conf
/*! \li \ref module.h uses the configuration file \ref modules.conf
* \addtogroup configuration_file
*/

2
include/asterisk/paths.h
View File

@@ -1,5 +1,5 @@
/*
* Asterisk -- A telephony toolkit for Linux.
* Asterisk -- An open source telephony toolkit.
*
* Paths to configurable Asterisk directories
*

2
include/asterisk/smdi.h
View File

@@ -1,5 +1,5 @@
/*
* Asterisk -- A telephony toolkit for Linux.
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2005-2008, Digium, Inc.
*

2
include/asterisk/udptl.h
View File

@@ -1,5 +1,5 @@
/*
* Asterisk -- A telephony toolkit for Linux.
* Asterisk -- An open source telephony toolkit.
*
* UDPTL support for T.38
*