diff options
Diffstat (limited to 'include/asterisk/doxyref.h')
| -rwxr-xr-x | include/asterisk/doxyref.h | 286 |
1 files changed, 286 insertions, 0 deletions
diff --git a/include/asterisk/doxyref.h b/include/asterisk/doxyref.h new file mode 100755 index 000000000..f87a98b40 --- /dev/null +++ b/include/asterisk/doxyref.h @@ -0,0 +1,286 @@ +/* + * 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 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 + * \arg \ref AstAPI + * \arg \ref AstDebug + * \arg \ref AstAMI + * \arg \ref AstARA + * \arg \ref AstDUNDi + * \arg \ref AstCDR + * \arg \ref AstREADME + * \arg \ref AstCREDITS + * \arg \ref AstVar + * \arg \ref AstENUM + * \arg \ref ConfigFiles + */ + +/*! \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 + * This programmer's documentation covers the generic API. + * \subsection generic Generic Model + * \verbinclude model.txt + * \subsection channel Channels + * \verbinclude channel.txt + */ +/*! \page AstDebug Debugging + * \section debug Debugging + * \verbinclude README.backtrace + */ +/*! \page AstAMI AMI - The Manager Interface + * \section ami AMI - The manager Interface + * \arg \link Config_ami Configuration file \endlink + * \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 README.realtime + * \verbinclude README.extconfig + */ +/*! \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. + + \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 + * \verbinclude README.cdr + * \arg \ref Config_cdr CDR configuration files + */ +/*! \page AstREADME README - the general administrator introduction + * \verbinclude README + */ + +/*! \page AstCREDITS CREDITS + * \verbinclude CREDITS + */ + +/*! \page AstVar Global channel variables + * \section globchan Global Channel Variables + * \verbinclude README.variables + */ + +/*! \page AstENUM ENUM + * \section enumreadme ENUM + * \arg Configuration: \ref Config_enum + * \verbinclude README.enum + */ + +/*! \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 configurations + * \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 + * \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 + * \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 + */ + +/*! \page Config_ast Asterisk.conf + * \verbinclude README.asterisk.conf + */ +/*! \page Config_mod Modules configuration + * \verbinclude modules.conf.sample + */ + +/*! \page Config_fea Call features configuration + * \section featconf features.conf + * \verbinclude features.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 iaxreadme README file \endlink + * \arg \link iaxconfig iax.conf Configuration file example \endlink + * \section iaxreadme IAX readme file + * \verbinclude README.iax + * \section iaxconfig IAX Configuration example + * \verbinclude iax.conf.sample + * \section iaxjitter IAX Jitterbuffer information + * \verbinclude README.jitterbuffer + */ + +/*! \page Config_sip SIP configuration + * Also see \ref Config_rtp RTP configuration + * \ref chan_sip.c + * \section sipconf sip.conf + * \verbinclude sip.conf.sample + */ + +/*! \page Config_mgcp MGCP configuration + * Also see \ref Config_rtp RTP configuration + * \ref chan_mgcp.c + * \section mgcpconf mgcp.conf + * \verbinclude mgcp.conf.sample + */ + + +/*! \page Config_vm VoiceMail configuration + * \section vmconf voicemail.conf + * \ref app_voicemail.c + * \verbinclude voicemail.conf.sample + */ + +/*! \page Config_zap Zaptel configuration + * \section zapconf zapata.conf + * \ref chan_zap.c + * \verbinclude zapata.conf.sample + */ + +/*! \page Config_oss OSS configuration + * \section ossconf oss.conf + * \ref chan_oss.c + * \verbinclude oss.conf.sample + */ + +/*! \page Config_alsa ALSA configuration + * \section alsaconf alsa.conf + * \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 + * \ref chan_agent.c + * \verbinclude agents.conf.sample + */ + +/*! \page Config_rtp RTP configuration + * \ref rtp.c + * \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 + * \arg See also \ref enumreadme + * \section enumconf enum.conf + * \verbinclude enum.conf.sample + */ +/*! \page Config_cdr CDR configuration + * \arg \link cdrconf Main CDR Configuration \endlink + * \arg \link cdrcustom Custom CDR driver configuration \endlink + * \arg \link cdrami Manager CDR driver configuration \endlink + * \arg \link cdrodbc ODBC CDR driver configuration \endlink + * \arg \link cdrpgsql Postgres CDR driver configuration \endlink + * \arg \link cdrtds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink + * \section cdrconf Main CDR configuration + * \verbinclude cdr.conf.sample + * \section cdrcustom Custom CDR driver configuration + * \verbinclude cdr_custom.conf.sample + * \section cdrami Manager CDR driver configuration + * \verbinclude cdr_manager.conf.sample + * \section cdrodbc ODBC CDR driver configuration + * Based on http://www.unixodbc.org + * \verbinclude cdr_odbc.conf.sample + * \section cdrpgsql Postgres CDR driver configuration + * \verbinclude cdr_pgsql.conf.sample + * \verbinclude cdr_tds.conf.sample + * \section cdrtds FreeTDS CDR driver configuration + * \verbinclude cdr_tds.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: \AstARA + * \section extconf extconfig.conf + * \verbinclude extconfig.conf.sample + */ + +/*! \page Config_ami AMI configuration + * \arg See also: \AstAMI + * \section amiconf manager.conf + * \verbinclude manager.conf.sample + */ + +/*! \page Config_qu ACD - Queue system configuration + * \section quconf queues.conf + * \verbinclude queues.conf.sample + */ + +/*! \page Config_mm Meetme - The conference bridge configuration + * \section mmconf meetme.conf + * \verbinclude meetme.conf.sample + */ + |