diff options
Diffstat (limited to 'trunk/include/asterisk/doxyref.h')
| -rw-r--r-- | trunk/include/asterisk/doxyref.h | 563 |
1 files changed, 563 insertions, 0 deletions
diff --git a/trunk/include/asterisk/doxyref.h b/trunk/include/asterisk/doxyref.h new file mode 100644 index 000000000..6fbe462ec --- /dev/null +++ b/trunk/include/asterisk/doxyref.h @@ -0,0 +1,563 @@ +/* + * Asterisk -- An open source telephony toolkit. + * + * Copyright (C) 1999 - 2005, Digium, Inc. + * + * Mark Spencer <markster@digium.com> + * + * 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. + * + * This program is free software, distributed under the terms of + * the GNU General Public License Version 2. See the LICENSE file + * at the top of the source tree. + */ + +/*! \file + * \brief This file generates Doxygen pages from files in the /doc + directory of the Asterisk source code tree + */ + +/* The following is for Doxygen Developer's documentation generated + * by running "make progdocs" with doxygen installed on your + * system. + */ +/*! \page DevDoc Asterisk Developer's Documentation - appendices + * \arg \ref CodeGuide : The must-read document for all developer's + * \arg \ref AstAPI + * \arg \ref Def_Channel : What's a channel, anyway? + * \arg \ref channel_drivers : Existing channel drivers + * \arg \ref AstDebug : Hints on debugging + * \arg \ref AstAMI : The Call management socket API + * \arg \ref AstARA : A generic data storage and retrieval API for Asterisk + * \arg \ref AstDUNDi : A way to find phone services dynamically by using the DUNDi protocol + * \arg \ref AJI_intro : The Asterisk Jabber Interface + * \arg \ref AstCDR + * \arg \ref AstREADME + * \arg \ref AstVar + * \arg \ref AstVideo + * \arg \ref AstENUM : The IETF way to redirect from phone numbers to VoIP calls + * \arg \ref AstHTTP + * \arg \ref AstSpeech + * \arg \ref ConfigFiles + * \arg \ref SoundFiles included in the Asterisk distribution + * \arg \ref AstCREDITS : A Thank You to contributors + * \arg \ref extref + \n\n + * \section weblinks Web sites + * \arg \b Main: Asterisk Developer's website http://www.asterisk.org/developers/ + * \arg \b Bugs: The Issue tracker http://bugs.digium.com + * \arg \b Lists: List server http://lists.digium.com + * \arg \b Wiki: The Asterisk Wiki http://www.voip-info.org + * \arg \b Docs: The Asterisk Documentation Project http://www.asteriskdocs.org + * \arg \b Digium: The Asterisk company http://www.digium.com + * + */ + +/*! \page CodeGuide Coding Guidelines + * \section Coding Guidelines + * This file is in the /doc directory in your Asterisk source tree. + * Make sure to stay up to date with the latest guidelines. + * \verbinclude CODING-GUIDELINES + */ + +/*! \page AstAPI Asterisk API + * \section Asteriskapi Asterisk API + * Some generic documents on the Asterisk architecture + * + * \arg \ref AstThreadStorage + * \arg \ref DataStores + * \arg \ref AstExtState + * + * \subsection model_txt Generic Model + * \verbinclude model.txt + * \subsection channel_txt Channels + * \arg See \ref Def_Channel + */ + +/*! \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 + * \verbinclude realtime.txt + * \verbinclude extconfig.txt + */ + +/*! \page AstDUNDi DUNDi +DUNDi is a peer-to-peer system for locating Internet gateways to telephony services. Unlike traditional centralized services (such as the remarkably simple and concise ENUM standard), DUNDi is fully-distributed with no centralized authority whatsoever. + +DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, it publishes routes which are in turn accessed via industry standard protocols such as IAX, SIP and H.323. + + \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 + */ + +/*! \page AstCDR CDR - Call Data Records and billing + * \section cdr Call Data Records + * \par See also + * \arg \ref cdr.c + * \arg \ref cdr_drivers + * \arg \ref Config_cdr CDR configuration files + * + * \verbinclude cdrdriver.txt + */ + +/*! \page AstREADME README - the general administrator introduction + * \verbinclude README + */ + +/*! \page AstCREDITS CREDITS + * \verbinclude CREDITS + */ + +/*! \page AstVideo Video support in Asterisk + * \section sectAstVideo Video support in Asterisk + * \verbinclude video.txt + */ + +/*! \page AstVar Globally predefined channel variables + * \section globchan Globally predefined channel variables + * + * More and more of these variables are being replaced by dialplan functions. + * Some still exist though and some that does still exist needs to move to + * dialplan functions. + * + * See also + * - \ref pbx_retrieve_variable() + * - \ref AstChanVar + * + * \verbinclude channelvariables.txt + + */ + +/*! \page AstChanVar Asterisk Dialplan Variables + * Asterisk Dialplan variables are divided into three groups: + * - Predefined global variables, handled by the PBX core + * - Global variables, that exist for the duration of the pbx execution + * - Channel variables, that exist during a channel + * + * Global variables are reachable in all channels, all of the time. + * Channel variables are only reachable within the channel. + * + * For more information on the predefined variables, see \ref AstVar + * + * Global and Channel variables: + * - Names are Case insensitive + * - Names that start with a character, but are alphanumeric + * - Global variables are defined and reached with the GLOBAL() dialplan function + * and the set application, like + * + * exten => 1234,1,set(GLOBAL(myvariable)=tomteluva) + * + * - \ref func_global.c + * + * - Channel variables are defined with the set() dialplan application + * + * exten => 1234,1,set(xmasattribute=tomtegröt) + * + * - Some channels also supports setting channel variables with the \b setvar= + * configuraiton option for a device or line. + * + * \section AstChanVar_globalvars Global Variables + * Global variables can also be set in the [globals] section of extensions.conf. The + * setting \b clearglobalvars in extensions.conf [general] section affects whether + * or not the global variables defined in \b globals are reset at dialplan reload. + * + * There are CLI commands to change and read global variables. This can be handy + * to reset counters at midnight from an external script. + * + * \section AstChanVar_devnotes Developer notes + * Variable handling is managed within \ref pbx.c + * You need to include pbx.h to reach these functions. + * - \ref pbx_builtin_setvar_helper() + * - \ref pbx_builtin_getvar_helper() + * + * The variables is a linked list stored in the channel data structure + * 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 + * + * \verbinclude enum.txt + */ + +/*! \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_zap Zaptel 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_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 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_ast Asterisk.conf + * \verbinclude asterisk-conf.txt + */ +/*! \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 res_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 + * \verbinclude iax.txt + * \section Config_iax IAX Configuration example + * \verbinclude iax.conf.sample + * \section iaxjitter IAX Jitterbuffer information + * \verbinclude jitterbuffer.txt + */ + +/*! \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 + * \verbinclude misdn.txt + */ + +/*! \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_zap Zaptel configuration + * \section zapconf zapata.conf + * \arg Implemented in \ref chan_zap.c + * \verbinclude zapata.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_custom Custom CDR Configuration + * \par See also + * \arg \ref cdrconf + * \arg \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 \ref cdr_manager.c + * \verbinclude cdr_manager.conf.sample + */ + +/*! \page cdr_odbc ODBC CDR driver configuration + * \arg See also \ref cdrconf + * \arg \ref cdr_odbc.c + * \verbinclude cdr_odbc.conf.sample + * See also: + * \arg http://www.unixodbc.org + */ + +/*! \page cdr_pgsql PostgreSQL CDR driver configuration + * \arg See also \ref cdrconf + * \arg \ref cdr_pgsql.c + * See also: + * \arg http://www.postgresql.org + * \verbinclude cdr_pgsql.conf.sample + */ + +/*! \page cdr_sqlite SQLite CDR driver configuration + * \arg See also \ref cdrconf + * \arg \ref cdr_sqlite.c + * See also: + * \arg http://www.sqlite.org + */ + +/*! \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_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 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 + * are used by applications and demo scripts within asterisk. + * + * Additional sound files are available in the asterisk-addons + * repository on svn.digium.com + */ + +/*! \addtogroup cdr_drivers Module: CDR Drivers + * \section CDR_generic Asterisk CDR Drivers + * \brief CDR drivers are loaded dynamically, each loaded CDR driver produce a billing record for each call. + * \arg \ref Config_mod "Modules Configuration" + * \arg \ref Config_cdr "CDR Configuration" + */ + + +/*! \addtogroup channel_drivers Module: Asterisk Channel Drivers + * \section channel_generic Asterisk Channel Drivers + * \brief Channel drivers are loaded dynamically. + * \arg \ref Config_mod "Modules Configuration" + */ + +/*! \addtogroup applications Module: 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 \see ast_unregister_application() + * \par See also + * \arg \ref functions + * + */ + +/*! \addtogroup functions Module: Dial plan functions + * \section func_generic Asterisk Dial Plan Functions + * \brief Functions support the dialplan. They do not change any property of a channel + * or touch a channel in any way. + * \par See also + * \arg \ref applications + * + */ + +/*! \addtogroup codecs Module: Codecs + * \section codec_generic Asterisk Codec Modules + * Codecs are referenced in configuration files by name + * \par See also + * \arg \ref formats + * + */ + +/*! \addtogroup formats Module: Media File Formats + * \section codec_generic Asterisk Format drivers + * Formats are modules that read or write media files to disk. + * \par See also + * \arg \ref codecs + */ + +/*! \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: + * \verbinclude res_config_sqlite.txt + * \arg See also: + * http://www.sqlite.org + */ |