doxyref.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2012, Digium, Inc.
00005  *
00006  * See http://www.asterisk.org for more information about
00007  * the Asterisk project. Please do not directly contact
00008  * any of the maintainers of this project for assistance;
00009  * the project provides a web site, mailing lists and IRC
00010  * channels for your use.
00011  *
00012  * This program is free software, distributed under the terms of
00013  * the GNU General Public License Version 2. See the LICENSE file
00014  * at the top of the source tree.
00015  */
00016 
00017 /*! 
00018  * \file
00019  *
00020  * This is the main header file used for generating miscellaneous documentation
00021  * using Doxygen.  This also utilizes the documentation in 
00022  * include/asterisk/doxygen/ header files.
00023  */
00024 
00025 /* 
00026  * The following is for Doxygen Developer's documentation generated
00027  * by running "make progdocs" with doxygen installed on your
00028  * system.
00029  */
00030 
00031 /*! 
00032  * \page DevDoc Asterisk Developer's Documentation - Appendices
00033  *
00034  * \section devpolicy Development and Release Policies
00035  * \arg \ref CodeGuide : The must-read document for all developers
00036  * \arg \ref CommitMessages : Information on formatting and special tags for commit messages
00037  * \arg \ref ReleaseStatus : The current support level for various Asterisk releases
00038  * \arg \ref ReleasePolicies : Asterisk Release and Commit Policies
00039  * \arg \ref Reviewboard : Reviewboard Usage and Guidelines
00040  * \arg \ref MantisWorkflow : Workflow Guidelines for Asterisk Open Source Issue Tracker
00041  * \arg \ref AsteriskGitHowto : How to setup a local GIT mirror of the Asterisk SVN repository
00042  * \arg \ref AstCREDITS : A Thank You to contributors (unfortunately out of date)
00043  *
00044  * \section apisandinterfaces Asterisk APIs and Interfaces
00045  * \arg \ref AstAPI
00046  * \arg \ref AstAPIChanges
00047  * \arg \ref Def_Channel : What's a channel, anyway?
00048  * \arg \ref channel_drivers : Existing channel drivers
00049  * \arg \ref AstAMI : The Call management socket API
00050  * \arg \ref AstARA : A generic data storage and retrieval API for Asterisk
00051  * \arg \ref AstDUNDi : A way to find phone services dynamically by using the DUNDi protocol
00052  * \arg \ref AJI_intro : The Asterisk Jabber Interface
00053  * \arg \ref AstCDR
00054  * \arg \ref AstVar
00055  * \arg \ref AstVideo
00056  * \arg \ref AstENUM : The IETF way to redirect from phone numbers to VoIP calls
00057  * \arg \ref AstHTTP
00058  * \arg \ref AstSpeech
00059  *
00060  * \section debugconfig Debugging and Configuration References
00061  * \arg \ref AstDebug : Hints on debugging
00062  * \arg \ref extref 
00063  * \arg \ref ConfigFiles
00064  * \arg \ref SoundFiles included in the Asterisk distribution
00065  *
00066  * \section weblinks Web sites
00067  * \arg \b Main:  Asterisk Developer's website http://www.asterisk.org/developers/
00068  * \arg \b Bugs: The Issue Tracker https://issues.asterisk.org
00069  * \arg \b Lists: List Server http://lists.digium.com
00070  * \arg \b Wiki: The Asterisk Wiki  http://wiki.asterisk..org
00071  * \arg \b Docs: The Asterisk Documentation Project http://www.asteriskdocs.org
00072  * \arg \b Digium: The Asterisk Company http://www.digium.com
00073  */
00074 
00075 /*! 
00076  * \page CodeGuide Coding Guidelines
00077  * \AsteriskTrunkWarning
00078  * \section Coding Guidelines
00079  * This file is in the /doc directory in your Asterisk source tree.
00080  * Make sure to stay up to date with the latest guidelines.
00081  * \verbinclude CODING-GUIDELINES
00082  */
00083 
00084 /*! 
00085  * \page AstAPI Asterisk API
00086  * \section Asteriskapi Asterisk API
00087  * Some generic documents on the Asterisk architecture
00088  *
00089  * \arg \ref AstThreadStorage
00090  * \arg \ref DataStores
00091  * \arg \ref AstExtState
00092  * \arg \ref AstDataRetrieval
00093  *
00094  * \subsection channel_txt Channels
00095  * \arg See \ref Def_Channel
00096  */
00097 
00098 /*! 
00099  * \page AstAPIChanges Asterisk API Changes
00100  *
00101  * \section Changes161 Version 1.6.1
00102  * \li vmwi_generate()
00103  * \li ast_channel_datastore_alloc()
00104  * \li ast_channel_datastore_free()
00105  * \li ast_channel_cmpwhentohangup()
00106  * \li ast_channel_setwhentohangup()
00107  * \li ast_settimeout()
00108  * \li ast_datastore_alloc()
00109  * \li ast_datastore_free()
00110  * \li ast_device_state_changed()
00111  * \li ast_device_state_changed_literal()
00112  * \li ast_dnsmgr_get()
00113  * \li ast_dnsmgr_lookup()
00114  * \li ast_dsp_set_digitmode()
00115  * \li ast_get_txt()
00116  * \li ast_event_unsubscribe()
00117  * \li localized_context_find_or_create()
00118  * \li localized_merge_contexts_and_delete()
00119  * \li ast_console_puts_mutable()
00120  * \li ast_rtp_get_quality()
00121  * \li ast_tcptls_client_start()
00122  * \li ast_tcptls_server_start()
00123  * \li ast_tcptls_server_stop()
00124  *
00125  * \section Changes162 Version 1.6.2
00126  *
00127  * \section Changes18 Version 1.8
00128  * \li ast_channel_alloc()
00129  */
00130 
00131 /*! 
00132  * \page AstAMI AMI - The Manager Interface
00133  * \section ami AMI - The manager Interface
00134  * \arg \link Config_ami Configuration file \endlink
00135  * \arg \ref manager.c
00136  * \todo include missing manager txt
00137  */
00138 
00139 /*!
00140  * \page AstARA ARA - The Asterisk Realtime Interface
00141  * \section realtime ARA - a generic API to storage and retrieval
00142  * Implemented in \ref config.c 
00143  * Implemented in \ref pbx_realtime.c 
00144  * \todo include missing realtime txt
00145  * \todo include missing extconfig txt
00146  */
00147 
00148 /*! 
00149  * \page AstDUNDi DUNDi
00150  *
00151  * DUNDi is a peer-to-peer system for locating Internet gateways to telephony 
00152  * services. Unlike traditional centralized services (such as the remarkably 
00153  * simple and concise ENUM standard), DUNDi is fully-distributed with no 
00154  * centralized authority whatsoever.
00155  *
00156  * DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, 
00157  * it publishes routes which are in turn accessed via industry standard 
00158  * protocols such as IAX, SIP and H.323. 
00159  *
00160  * \par References
00161  * \arg DUNDi is documented at http://www.dundi.com
00162  * \arg Implemented in \ref pbx_dundi.c and \ref dundi-parser.c
00163  * \arg Configuration in \ref dundi.conf
00164  */
00165 
00166 /*! 
00167  * \page AstCDR CDR - Call Data Records and billing
00168  * \section cdr Call Data Records
00169  * \par See also
00170  * \arg \ref cdr.c
00171  * \arg \ref cdr_drivers
00172  * \arg \ref Config_cdr CDR configuration files
00173  *
00174  * \todo include missing cdrdriver txt
00175  */
00176 
00177 /*! 
00178  * \page AstCREDITS CREDITS
00179  * \verbinclude CREDITS
00180  */
00181 
00182 /*! 
00183  * \page AstVideo Video support in Asterisk
00184  * \section sectAstVideo Video support in Asterisk
00185  * \todo include missing video txt
00186  */
00187 
00188 /*! 
00189  * \page AstVar Globally predefined channel variables
00190  * \section globchan Globally predefined channel variables
00191  *
00192  * More and more of these variables are being replaced by dialplan functions.
00193  * Some still exist though and some that does still exist needs to move to
00194  * dialplan functions.
00195  *
00196  * See also
00197  * - \ref pbx_retrieve_variable()
00198  * - \ref AstChanVar
00199  *
00200  */
00201 
00202 /*! 
00203  * \page AstChanVar Asterisk Dialplan Variables
00204  * Asterisk Dialplan variables are divided into three groups:
00205  * - Predefined global variables, handled by the PBX core
00206  * - Global variables, that exist for the duration of the pbx execution
00207  * - Channel variables, that exist during a channel
00208  *
00209  * Global variables are reachable in all channels, all of the time.
00210  * Channel variables are only reachable within the channel.
00211  *
00212  * For more information on the predefined variables, see \ref AstVar
00213  * 
00214  * Global and Channel variables:
00215  * - Names are Case insensitive
00216  * - Names that start with a character, but are alphanumeric
00217  * - Global variables are defined and reached with the GLOBAL() dialplan function
00218  *   and the set application, like
00219  *
00220  *    exten => 1234,1,set(GLOBAL(myvariable)=tomteluva)
00221  *
00222  *    - \ref func_global.c
00223  *
00224  * - Channel variables are defined with the set() dialplan application
00225  *
00226  * exten => 1234,1,set(xmasattribute=tomtegröt)
00227  *
00228  * - Some channels also supports setting channel variables with the \b setvar=
00229  *   configuraiton option for a device or line.
00230  *
00231  * \section AstChanVar_globalvars Global Variables
00232  * Global variables can also be set in the [globals] section of extensions.conf. The
00233  * setting \b clearglobalvars in extensions.conf [general] section affects whether
00234  * or not the global variables defined in \b globals are reset at dialplan reload.
00235  * 
00236  * There are CLI commands to change and read global variables. This can be handy
00237  * to reset counters at midnight from an external script.
00238  *
00239  * \section AstChanVar_devnotes Developer notes
00240  * Variable handling is managed within \ref pbx.c
00241  * You need to include pbx.h to reach these functions.
00242  * - \ref pbx_builtin_setvar_helper()
00243  *    - \ref pbx_builtin_getvar_helper()
00244  *
00245  * The variables is a linked list stored in the channel data structure
00246  * with the list starting at varshead in struct ast_channel
00247  */
00248 
00249 /*! 
00250  * \page Config_mod Modules configuration
00251  * All res_ resource modules are loaded with globals on, which means
00252  * that non-static functions are callable from other modules.
00253  *
00254  * If you want your non res_* module to export functions to other modules
00255  * you have to include it in the [global] section.
00256  */
00257 
00258 /*!
00259  * \page Config_ext Extensions.conf - the Dial Plan
00260  * \section dialplan Extensions.conf 
00261  * \verbinclude extensions.conf.sample
00262  */
00263 
00264 /*! 
00265  * \page Config_rtp RTP configuration
00266  * \arg Implemented in \ref rtp.c
00267  * Used in \ref chan_sip.c and \ref chan_mgcp.c (and various H.323 channels)
00268  * \section rtpconf rtp.conf
00269  * \verbinclude rtp.conf.sample
00270  */
00271 
00272 /*! 
00273  * \page Config_codec CODEC Configuration
00274  * \section codecsconf codecs.conf
00275  * \verbinclude codecs.conf.sample
00276  */
00277 
00278 /*! 
00279  * \page Config_ara REALTIME Configuration
00280  * \arg See also: \arg \link AstARA \endlink
00281  * \section extconf extconfig.conf
00282  * \verbinclude extconfig.conf.sample
00283  */
00284 
00285 /*! 
00286  * \page Config_ami AMI configuration
00287  * \arg See also: \arg \link AstAMI \endlink
00288  * \section amiconf manager.conf
00289  * \verbinclude manager.conf.sample
00290  */
00291 
00292 /*! 
00293  * \page SoundFiles Sound files
00294  * \section SecSound Asterisk Sound files
00295  * Asterisk includes a large number of sound files. Many of these
00296  * are used by applications and demo scripts within asterisk.
00297  *
00298  * Additional sound files are available in the asterisk-addons
00299  * repository on svn.digium.com
00300  */
00301 
00302 /*!
00303  * \page AstHTTP AMI over HTTP support
00304  * The http.c file includes support for manager transactions over
00305  * http.
00306  * \section ami AMI - The manager Interface
00307  * \arg \link Config_ami Configuration file \endlink
00308  */
00309 
00310 /*
00311  * Doxygen Groups
00312  */
00313 
00314 /*! \addtogroup configuration_file Configuration Files
00315  */
00316 
00317 /*! 
00318  * \addtogroup cdr_drivers Module: CDR Drivers
00319  * \section CDR_generic Asterisk CDR Drivers
00320  * \brief CDR drivers are loaded dynamically, each loaded CDR driver produce 
00321  *        a billing record for each call.
00322  * \arg \ref Config_mod "Modules Configuration"
00323  * \arg \ref Config_cdr "CDR Configuration"
00324  */
00325 
00326 /*! 
00327  * \addtogroup channel_drivers Module: Asterisk Channel Drivers
00328  * \section channel_generic Asterisk Channel Drivers
00329  * \brief Channel drivers are loaded dynamically. 
00330  * \arg \ref Config_mod "Modules Configuration"
00331  */
00332 
00333 /*! 
00334  * \addtogroup applications Dial plan applications
00335  * \section app_generic Asterisk Dial Plan Applications
00336  * \brief Applications support the dialplan. They register dynamically with 
00337  *        \see ast_register_application() and unregister with 
00338  *        \see ast_unregister_application()
00339  * \par See also
00340  * \arg \ref functions
00341  */
00342 
00343 /*! 
00344  * \addtogroup functions Module: Dial plan functions
00345  * \section func_generic Asterisk Dial Plan Functions
00346  * \brief Functions support the dialplan.  They do not change any property of a channel
00347  *        or touch a channel in any way.
00348  * \par See also
00349  * \arg \ref applications
00350  *  
00351  */
00352 
00353 /*! 
00354  * \addtogroup codecs Module: Codecs
00355  * \section codec_generic Asterisk Codec Modules
00356  * Codecs are referenced in configuration files by name 
00357  * \par See also 
00358  * \arg \ref formats 
00359  */
00360 
00361 /*! 
00362  * \addtogroup formats Module: Media File Formats 
00363  * \section codec_generic Asterisk Format drivers
00364  * Formats are modules that read or write media files to disk.
00365  * \par See also
00366  * \arg \ref codecs 
00367  */
00368 
00369 /*! 
00370  * \addtogroup rtp_engines Module: RTP Engines
00371  * \section rtp_engine_blah Asterisk RTP Engines
00372  */

Generated on Thu Apr 16 06:27:33 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6