096901cd2afcd2a2294107d8f74ae26d750a1ee9
[asterisk/asterisk.git] / include / asterisk / doxyref.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2009, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! 
18  * \file
19  *
20  * This is the main header file used for generating miscellaneous developer
21  * documentation using doxygen.  This also pulls in all of the documentation
22  * that is in include/asterisk/doxygen/.
23  */
24
25 /* 
26  * The following is for Doxygen Developer's documentation generated
27  * by running "make progdocs" with doxygen installed on your
28  * system.
29  */
30
31 /*! 
32  * \page DevDoc Asterisk Developer's Documentation - Appendices
33  *
34  * \section devpolicy Development and Release Policies
35  * \arg \ref CodeGuide : The must-read document for all developers
36  * \arg \ref CommitMessages : Information on formatting and special tags for commit messages
37  * \arg \ref ReleaseStatus : The current support level for various Asterisk releases
38  * \arg \ref ReleasePolicies : Asterisk Release and Commit Policies
39  * \arg \ref Reviewboard : Reviewboard Usage and Guidelines
40  * \arg \ref MantisWorkflow : Workflow Guidelines for Asterisk Open Source Issue Tracker
41  * \arg \ref AsteriskGitHowto : How to setup a local GIT mirror of the Asterisk SVN repository
42  * \arg \ref AstCREDITS : A Thank You to contributors (unfortunately out of date)
43  *
44  * \section apisandinterfaces Asterisk APIs and Interfaces
45  * \arg \ref AstAPI
46  * \arg \ref AstAPIChanges
47  * \arg \ref Def_Channel : What's a channel, anyway?
48  * \arg \ref channel_drivers : Existing channel drivers
49  * \arg \ref AstAMI : The Call management socket API
50  * \arg \ref AstARA : A generic data storage and retrieval API for Asterisk
51  * \arg \ref AstDUNDi : A way to find phone services dynamically by using the DUNDi protocol
52  * \arg \ref AJI_intro : The Asterisk Jabber Interface
53  * \arg \ref AstCDR
54  * \arg \ref AstVar
55  * \arg \ref AstVideo
56  * \arg \ref AstENUM : The IETF way to redirect from phone numbers to VoIP calls
57  * \arg \ref AstHTTP
58  * \arg \ref AstSpeech
59  *
60  * \section debugconfig Debugging and Configuration References
61  * \arg \ref AstREADME : General Administrator README file
62  * \arg \ref AstDebug : Hints on debugging
63  * \arg \ref extref 
64  * \arg \ref ConfigFiles
65  * \arg \ref SoundFiles included in the Asterisk distribution
66  *
67  * \section weblinks Web sites
68  * \arg \b Main:  Asterisk Developer's website http://www.asterisk.org/developers/
69  * \arg \b Bugs: The Issue Tracker https://issues.asterisk.org
70  * \arg \b Lists: List Server http://lists.digium.com
71  * \arg \b Wiki: The Asterisk Wiki      http://www.voip-info.org
72  * \arg \b Docs: The Asterisk Documentation Project http://www.asteriskdocs.org
73  * \arg \b Digium: The Asterisk Company http://www.digium.com
74  */
75
76 /*! 
77  * \page CodeGuide Coding Guidelines
78  * \AsteriskTrunkWarning
79  * \section Coding Guidelines
80  * This file is in the /doc directory in your Asterisk source tree.
81  * Make sure to stay up to date with the latest guidelines.
82  * \verbinclude CODING-GUIDELINES
83  */
84
85 /*! 
86  * \page AstAPI Asterisk API
87  * \section Asteriskapi Asterisk API
88  * Some generic documents on the Asterisk architecture
89  *
90  * \arg \ref AstThreadStorage
91  * \arg \ref DataStores
92  * \arg \ref AstExtState
93  * \arg \ref AstDataRetrieval
94  *
95  * \subsection model_txt Generic Model
96  * \verbinclude model.txt
97  * \subsection channel_txt Channels
98  * \arg See \ref Def_Channel
99  */
100
101 /*! 
102  * \page AstAPIChanges Asterisk API Changes
103  *
104  * \section Changes161 Version 1.6.1
105  * \li ast_install_vm_functions()
106  * \li vmwi_generate()
107  * \li ast_channel_datastore_alloc()
108  * \li ast_channel_datastore_free()
109  * \li ast_channel_cmpwhentohangup()
110  * \li ast_channel_setwhentohangup()
111  * \li ast_settimeout()
112  * \li ast_datastore_alloc()
113  * \li ast_datastore_free()
114  * \li ast_device_state_changed()
115  * \li ast_device_state_changed_literal()
116  * \li ast_dnsmgr_get()
117  * \li ast_dnsmgr_lookup()
118  * \li ast_dsp_set_digitmode()
119  * \li ast_get_txt()
120  * \li ast_event_unsubscribe()
121  * \li localized_context_find_or_create()
122  * \li localized_merge_contexts_and_delete()
123  * \li ast_console_puts_mutable()
124  * \li ast_rtp_get_quality()
125  * \li ast_tcptls_client_start()
126  * \li ast_tcptls_server_start()
127  * \li ast_tcptls_server_stop()
128  *
129  * \section Changes162 Version 1.6.2
130  *
131  * \section Changes18 Version 1.8
132  * \li ast_channel_alloc()
133  */
134
135 /*! 
136  * \page AstDebug Debugging
137  * \section debug Debugging
138  * \verbinclude backtrace.txt
139  */
140
141 /*!
142  * \page AstSpeech The Generic Speech Recognition API
143  * \section debug The Generic Speech Recognition API
144  * \verbinclude speechrec.txt
145  */
146
147 /*! 
148  * \page DataStores Channel Data Stores
149  * \section debug Channel Data Stores
150  * \verbinclude datastores.txt
151  */
152
153 /*! 
154  * \page AstAMI AMI - The Manager Interface
155  * \section ami AMI - The manager Interface
156  * \arg \link Config_ami Configuration file \endlink
157  * \arg \ref manager.c
158  * \verbinclude manager.txt
159  */
160
161 /*!
162  * \page AstARA ARA - The Asterisk Realtime Interface
163  * \section realtime ARA - a generic API to storage and retrieval
164  * Implemented in \ref config.c 
165  * Implemented in \ref pbx_realtime.c 
166  * \verbinclude realtime.txt
167  * \verbinclude extconfig.txt
168  */
169
170 /*! 
171  * \page AstDUNDi DUNDi
172  *
173  * DUNDi is a peer-to-peer system for locating Internet gateways to telephony 
174  * services. Unlike traditional centralized services (such as the remarkably 
175  * simple and concise ENUM standard), DUNDi is fully-distributed with no 
176  * centralized authority whatsoever.
177  *
178  * DUNDi is not itself a Voice-over IP signaling or media protocol. Instead, 
179  * it publishes routes which are in turn accessed via industry standard 
180  * protocols such as IAX, SIP and H.323. 
181  *
182  * \par References
183  * \arg DUNDi is documented at http://www.dundi.com
184  * \arg Implemented in \ref pbx_dundi.c and \ref dundi-parser.c
185  * \arg Configuration in \link Config_dun dundi.conf \endlink
186  */
187
188 /*! 
189  * \page AstCDR CDR - Call Data Records and billing
190  * \section cdr Call Data Records
191  * \par See also
192  * \arg \ref cdr.c
193  * \arg \ref cdr_drivers
194  * \arg \ref Config_cdr CDR configuration files
195  *
196  * \verbinclude cdrdriver.txt
197  */
198
199 /*! 
200  * \page AstREADME README
201  * \verbinclude README
202  */
203  
204 /*! 
205  * \page AstCREDITS CREDITS
206  * \verbinclude CREDITS
207  */
208
209 /*! 
210  * \page AstVideo Video support in Asterisk
211  * \section sectAstVideo Video support in Asterisk
212  * \verbinclude video.txt
213  */
214
215 /*! 
216  * \page AstVar Globally predefined channel variables
217  * \section globchan Globally predefined channel variables
218  *
219  * More and more of these variables are being replaced by dialplan functions.
220  * Some still exist though and some that does still exist needs to move to
221  * dialplan functions.
222  *
223  * See also
224  * - \ref pbx_retrieve_variable()
225  * - \ref AstChanVar
226  *
227  *  \verbinclude channelvariables.tex
228  */
229
230 /*! 
231  * \page AstChanVar Asterisk Dialplan Variables
232  *      Asterisk Dialplan variables are divided into three groups:
233  *      - Predefined global variables, handled by the PBX core
234  *      - Global variables, that exist for the duration of the pbx execution
235  *      - Channel variables, that exist during a channel
236  *
237  * Global variables are reachable in all channels, all of the time.
238  * Channel variables are only reachable within the channel.
239  *
240  * For more information on the predefined variables, see \ref AstVar
241  * 
242  * Global and Channel variables:
243  * - Names are Case insensitive
244  * - Names that start with a character, but are alphanumeric
245  * - Global variables are defined and reached with the GLOBAL() dialplan function
246  *   and the set application, like
247  *
248  *      exten => 1234,1,set(GLOBAL(myvariable)=tomteluva)
249  *
250  *      - \ref func_global.c
251  *
252  * - Channel variables are defined with the set() dialplan application
253  *
254  *      exten => 1234,1,set(xmasattribute=tomtegröt)
255  *
256  * - Some channels also supports setting channel variables with the \b setvar=
257  *   configuraiton option for a device or line.
258  *
259  * \section AstChanVar_globalvars Global Variables
260  * Global variables can also be set in the [globals] section of extensions.conf. The
261  * setting \b clearglobalvars in extensions.conf [general] section affects whether
262  * or not the global variables defined in \b globals are reset at dialplan reload.
263  * 
264  * There are CLI commands to change and read global variables. This can be handy
265  * to reset counters at midnight from an external script.
266  *
267  * \section AstChanVar_devnotes Developer notes
268  * Variable handling is managed within \ref pbx.c
269  * You need to include pbx.h to reach these functions.
270  *      - \ref pbx_builtin_setvar_helper()
271  *      - \ref pbx_builtin_getvar_helper()
272  *
273  * The variables is a linked list stored in the channel data structure
274  * with the list starting at varshead in struct ast_channel
275  */
276
277 /*! 
278  * \page AstENUM ENUM
279  * \section enumreadme ENUM
280  * \arg Configuration: \ref Config_enum
281  * \arg \ref enum.c
282  * \arg \ref func_enum.c
283  *
284  * \verbinclude enum.txt
285  */
286
287 /*! 
288  * \page ConfigFiles Configuration files
289  * \section config Main configuration files
290  * \arg \link Config_ast asterisk.conf - the main configuration file \endlink
291  * \arg \link Config_ext extensions.conf - The Dial Plan \endlink
292  * \arg \link Config_mod modules.conf - which modules to load and not to load \endlink
293  * \arg \link Config_fea features.conf - call features (transfer, parking, etc) \endlink
294  * \section chanconf Channel configuration files
295  * \arg \link Config_iax IAX2 configuration  \endlink
296  * \arg \link Config_sip SIP configuration  \endlink
297  * \arg \link Config_mgcp MGCP configuration  \endlink
298  * \arg \link Config_rtp RTP configuration  \endlink
299  * \arg \link Config_dahdi DAHDI configuration  \endlink
300  * \arg \link Config_oss OSS (sound card) configuration  \endlink
301  * \arg \link Config_alsa ALSA (sound card) configuration  \endlink
302  * \arg \link Config_agent Agent (proxy channel) configuration  \endlink
303  * \arg \link Config_misdn MISDN Experimental ISDN BRI channel configuration  \endlink
304  * \arg \link Config_h323 H.323 configuration  \endlink
305  * \section appconf Application configuration files
306  * \arg \link Config_mm Meetme (conference bridge) configuration  \endlink
307  * \arg \link Config_qu Queue system configuration  \endlink
308  * \arg \link Config_vm Voicemail configuration  \endlink
309  * \arg \link Config_followme Followme configuration  \endlink
310  * \section cdrconf CDR configuration files
311  * \arg \link Config_cdr CDR configuration  \endlink
312  * \arg \link cdr_csv Default CDR driver configuration \endlink
313  * \arg \link cdr_custom Custom CDR driver configuration \endlink
314  * \arg \link cdr_ami Manager CDR driver configuration \endlink
315  * \arg \link cdr_odbc ODBC CDR driver configuration \endlink
316  * \arg \link cdr_adaptive_odbc Adaptive ODBC CDR driver configuration \endlink
317  * \arg \link cdr_pgsql PostgreSQL CDR driver configuration \endlink
318  * \arg \link cdr_radius RADIUS CDR driver configuration \endlink
319  * \arg \link cdr_sqlite SQLite 2 CDR driver configuration \endlink
320  * \arg \link cdr_sqlite3_custom SQLite 3 CDR driver configuration \endlink
321  * \arg \link cdr_syslog Syslog CDR driver configuration \endlink
322  * \arg \link cdr_tds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink
323  * \section miscconf Miscellenaous configuration files
324  * \arg \link Config_adsi ADSI configuration  \endlink
325  * \arg \link Config_ami AMI - Manager configuration  \endlink
326  * \arg \link Config_ara Realtime configuration  \endlink
327  * \arg \link Config_codec Codec configuration  \endlink
328  * \arg \link Config_dun DUNDi configuration  \endlink
329  * \arg \link Config_enum ENUM configuration  \endlink
330  * \arg \link Config_moh Music on Hold configuration  \endlink
331  * \arg \link Config_vm Voicemail configuration  \endlink
332  * \arg \link res_config_sqlite SQLite Resource driver configuration \endlink
333  */
334
335 /*! 
336  * \page Config_ast Asterisk.conf
337  * \verbinclude asterisk-conf.txt
338  */
339
340 /*! 
341  * \page Config_mod Modules configuration
342  * All res_ resource modules are loaded with globals on, which means
343  * that non-static functions are callable from other modules.
344  *
345  * If you want your non res_* module to export functions to other modules
346  * you have to include it in the [global] section.
347  * \verbinclude modules.conf.sample
348  */
349
350 /*! 
351  * \page Config_fea Call features configuration
352  * \par See also
353  * \arg \ref features.c : Call feature implementation
354  * \section featconf features.conf
355  * \verbinclude features.conf.sample
356  */
357
358 /*! 
359  * \page Config_followme Followme: An application for simple follow-me calls
360  * \section followmeconf Followme.conf
361  * - See app_followme.c
362  * \verbinclude followme.conf.sample
363  */
364
365 /*! 
366  * \page Config_ext Extensions.conf - the Dial Plan
367  * \section dialplan Extensions.conf 
368  * \verbinclude extensions.conf.sample
369  */
370
371 /*! 
372  * \page Config_iax IAX2 configuration
373  * IAX2 is implemented in \ref chan_iax2.c
374  * \arg \link Config_iax iax.conf Configuration file example \endlink
375  * \section iaxreadme IAX readme file
376  * \verbinclude iax.txt
377  * \section Config_iax IAX Configuration example
378  * \verbinclude iax.conf.sample
379  * \section iaxjitter IAX Jitterbuffer information
380  * \verbinclude jitterbuffer.txt
381  */
382
383 /*! 
384  * \page Config_iax IAX configuration
385  * \arg Implemented in \ref chan_iax2.c
386  * \section iaxconf iax.conf
387  * \verbinclude iax.conf.sample
388  */
389
390 /*! 
391  * \page Config_sip SIP configuration
392  * Also see \ref Config_rtp RTP configuration
393  * \arg Implemented in \ref chan_sip.c
394  * \section sipconf sip.conf
395  * \verbinclude sip.conf.sample
396  *
397  * \arg \b Back \ref chanconf
398  */
399
400 /*! 
401  * \page Config_mgcp MGCP configuration
402  * Also see \ref Config_rtp RTP configuration
403  * \arg Implemented in \ref chan_mgcp.c
404  * \section mgcpconf mgcp.conf
405  * \verbinclude mgcp.conf.sample
406  */
407
408 /*! 
409  * \page README_misdn MISDN documentation
410  * \arg See \ref Config_misdn
411  * \section mISDN configuration
412  * \verbinclude misdn.txt
413  */
414
415 /*! 
416  * \page Config_misdn MISDN configuration
417  * \arg Implemented in \ref chan_misdn.c
418  * \arg \ref README_misdn
419  * \arg See the mISDN home page: http://www.isdn4linux.de/mISDN/
420  * \section misdnconf misdn.conf
421  * \verbinclude misdn.conf.sample
422  */
423
424 /*! 
425  * \page Config_vm VoiceMail configuration
426  * \section vmconf voicemail.conf
427  * \arg Implemented in \ref app_voicemail.c
428  * \verbinclude voicemail.conf.sample
429  */
430
431 /*! 
432  * \page Config_dahdi DAHDI configuration
433  * \section dahdiconf dahdi.conf
434  * \arg Implemented in \ref chan_dahdi.c
435  * \verbinclude dahdi.conf.sample
436  */
437
438 /*! 
439  * \page Config_h323 H.323 channel driver information
440  * This is the configuration of the H.323 channel driver within the Asterisk
441  * distribution. There's another one, called OH323, in asterisk-addons
442  * \arg Implemented in \ref chan_h323.c
443  * \section h323conf h323.conf
444  * \ref chan_h323.c
445  */
446
447 /*! 
448  * \page Config_oss OSS configuration
449  * \section ossconf oss.conf
450  * \arg Implemented in \ref chan_oss.c
451  * \verbinclude oss.conf.sample
452  */
453
454 /*! 
455  * \page Config_alsa ALSA configuration
456  * \section alsaconf alsa.conf
457  * \arg Implemented in \ref chan_alsa.c
458  * \verbinclude alsa.conf.sample
459  */
460
461 /*! 
462  * \page Config_agent Agent configuration
463  * \section agentconf agents.conf
464  * The agent channel is a proxy channel for queues
465  * \arg Implemented in \ref chan_agent.c
466  * \verbinclude agents.conf.sample
467  */
468
469 /*! 
470  * \page Config_rtp RTP configuration
471  * \arg Implemented in \ref rtp.c
472  * Used in \ref chan_sip.c and \ref chan_mgcp.c (and various H.323 channels)
473  * \section rtpconf rtp.conf
474  * \verbinclude rtp.conf.sample
475  */
476
477 /*! 
478  * \page Config_dun DUNDi Configuration
479  * \arg See also \ref AstDUNDi
480  * \section dundiconf dundi.conf
481  * \verbinclude dundi.conf.sample
482  */
483
484 /*! 
485  * \page Config_enum ENUM Configuration
486  * \section enumconf enum.conf
487  * \arg See also \ref enumreadme
488  * \arg Implemented in \ref func_enum.c and \ref enum.c
489  * \verbinclude enum.conf.sample
490  */
491
492 /*!
493  * \page cdr_csv Default CDR driver configuration
494  * \par See also
495  * \arg \ref cdrconf
496  * \arg Implemented in \ref cdr_csv.c
497  * \verbinclude cdr_csv.conf.sample
498  */
499
500 /*! 
501  * \page cdr_custom Custom CDR Configuration
502  * \par See also 
503  * \arg \ref cdrconf
504  * \arg Implemented in \ref cdr_custom.c
505  * \verbinclude cdr_custom.conf.sample
506  */
507
508 /*! 
509  * \page cdr_ami Manager CDR driver configuration
510  * \par See also 
511  * \arg \ref cdrconf
512  * \arg \ref AstAMI
513  * \arg Implemented in \ref cdr_manager.c
514  * \verbinclude cdr_manager.conf.sample
515  */
516
517 /*! 
518  * \page cdr_odbc ODBC CDR driver configuration
519  * \arg See also \ref cdrconf
520  * \arg Implemented in \ref cdr_odbc.c
521  * \verbinclude cdr_odbc.conf.sample
522  * See also:
523  * \arg http://www.unixodbc.org
524  */
525
526 /*! 
527  * \page cdr_odbc Adaptive ODBC CDR driver configuration
528  * \arg See also \ref cdrconf
529  * \arg Implemented in \ref cdr_adaptive_odbc.c
530  * \verbinclude cdr_adaptive_odbc.conf.sample
531  * See also:
532  * \arg http://www.unixodbc.org
533  */
534
535 /*! 
536  * \page cdr_pgsql PostgreSQL CDR driver configuration
537  * \arg See also \ref cdrconf
538  * \arg Implemented in \ref cdr_pgsql.c
539  * See also:
540  * \arg http://www.postgresql.org
541  * \verbinclude cdr_pgsql.conf.sample
542  */
543
544 /*!
545  * \page cdr_radius RADIUS CDR driver configuration
546  * \arg See also \ref cdrconf
547  * \arg Implemented in \ref cdr_radius.c
548  * \verbinclude cdr_radius.conf.sample
549  */
550
551 /*! 
552  * \page cdr_sqlite SQLite 2 CDR driver configuration
553  * \arg See also \ref cdrconf
554  * \arg Implemented in \ref cdr_sqlite.c
555  * See also:
556  * \arg http://www.sqlite.org
557  */
558
559 /*!
560  * \page cdr_sqlite3_custom SQLite 3 CDR driver configuration
561  * \arg See also \ref cdrconf
562  * \arg Implemented in \ref cdr_sqlite3_custom.c
563  * See also:
564  * \arg http://www.sqlite.org
565  * \verbinclude cdr_sqlite3_custom.conf.sample
566  */
567
568 /*!
569  * \page cdr_syslog Syslog CDR driver configuration
570  * \arg See also \ref cdrconf
571  * \arg \ref cdr_syslog.c
572  * \verbinclude cdr_syslog.conf.sample
573  */
574
575 /*! 
576  * \page cdr_tds FreeTDS CDR driver configuration
577  * \arg See also \ref cdrconf
578  * See also:
579  * \arg http://www.freetds.org
580  * \verbinclude cdr_tds.conf.sample
581  */
582
583 /*! 
584  * \page Config_cdr CDR configuration
585  * \par See also
586  * \arg \ref cdr_drivers
587  * \arg \link Config_cdr CDR configuration  \endlink  
588  * \arg \link cdr_csv Default CDR driver configuration \endlink
589  * \arg \link cdr_custom Custom CDR driver configuration \endlink
590  * \arg \link cdr_ami Manager CDR driver configuration \endlink
591  * \arg \link cdr_odbc ODBC CDR driver configuration \endlink
592  * \arg \link cdr_adaptive_odbc Adaptive ODBC CDR driver configuration \endlink
593  * \arg \link cdr_pgsql PostgreSQL CDR driver configuration \endlink
594  * \arg \link cdr_radius RADIUS CDR driver configuration \endlink
595  * \arg \link cdr_sqlite SQLite 2 CDR driver configuration \endlink
596  * \arg \link cdr_sqlite3_custom SQLite 3 CDR driver configuration \endlink
597  * \arg \link cdr_syslog Syslog CDR driver configuration \endlink
598  * \arg \link cdr_tds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink
599  * \verbinclude cdr.conf.sample
600  */
601
602 /*! 
603  * \page Config_moh Music on Hold Configuration
604  * \arg Implemented in \ref res_musiconhold.c
605  * \section mohconf musiconhold.conf
606  * \verbinclude musiconhold.conf.sample
607  */
608
609 /*! 
610  * \page Config_adsi ADSI Configuration
611  * \section adsiconf adsi.conf
612  * \verbinclude adsi.conf.sample
613  */
614
615 /*! 
616  * \page Config_codec CODEC Configuration
617  * \section codecsconf codecs.conf
618  * \verbinclude codecs.conf.sample
619  */
620
621 /*! 
622  * \page Config_ara REALTIME Configuration
623  * \arg See also: \arg \link AstARA \endlink
624  * \section extconf extconfig.conf
625  * \verbinclude extconfig.conf.sample
626  */
627
628 /*! 
629  * \page Config_ami AMI configuration
630  * \arg See also: \arg \link AstAMI \endlink
631  * \section amiconf manager.conf
632  * \verbinclude manager.conf.sample
633  */
634
635 /*! 
636  * \page Config_qu ACD - Queue system configuration
637  * \arg Implemented in \ref app_queue.c
638  * \section quconf queues.conf
639  * \verbinclude queues.conf.sample
640  */
641
642 /*! 
643  * \page Config_mm Meetme - The conference bridge configuration
644  * \arg Implemented in \ref app_meetme.c
645  * \section mmconf meetme.conf
646  * \verbinclude meetme.conf.sample
647  */
648
649 /*! 
650  * \page SoundFiles Sound files
651  * \section SecSound Asterisk Sound files
652  * Asterisk includes a large number of sound files. Many of these
653  * are used by applications and demo scripts within asterisk.
654  *
655  * Additional sound files are available in the asterisk-addons
656  * repository on svn.digium.com
657  */
658
659 /*! 
660  * \addtogroup cdr_drivers Module: CDR Drivers
661  * \section CDR_generic Asterisk CDR Drivers
662  * \brief CDR drivers are loaded dynamically, each loaded CDR driver produce 
663  *        a billing record for each call.
664  * \arg \ref Config_mod "Modules Configuration"
665  * \arg \ref Config_cdr "CDR Configuration"
666  */
667
668
669 /*! 
670  * \addtogroup channel_drivers Module: Asterisk Channel Drivers
671  * \section channel_generic Asterisk Channel Drivers
672  * \brief Channel drivers are loaded dynamically. 
673  * \arg \ref Config_mod "Modules Configuration"
674  */
675
676 /*! 
677  * \addtogroup applications Module: Dial plan applications
678  * \section app_generic Asterisk Dial Plan Applications
679  * \brief Applications support the dialplan. They register dynamically with 
680  *        \see ast_register_application() and unregister with 
681  *        \see ast_unregister_application()
682  * \par See also
683  * \arg \ref functions
684  */
685
686 /*! 
687  * \addtogroup functions Module: Dial plan functions
688  * \section func_generic Asterisk Dial Plan Functions
689  * \brief Functions support the dialplan.  They do not change any property of a channel
690  *        or touch a channel in any way.
691  * \par See also
692  * \arg \ref applications
693  *  
694  */
695
696 /*! 
697  * \addtogroup codecs Module: Codecs
698  * \section codec_generic Asterisk Codec Modules
699  * Codecs are referenced in configuration files by name 
700  * \par See also 
701  * \arg \ref formats 
702  */
703
704 /*! 
705  * \addtogroup formats Module: Media File Formats 
706  * \section codec_generic Asterisk Format drivers
707  * Formats are modules that read or write media files to disk.
708  * \par See also
709  * \arg \ref codecs 
710  */
711
712 /*! 
713  * \addtogroup rtp_engines Module: RTP Engines
714  * \section rtp_engine_blah Asterisk RTP Engines
715  */
716
717 /*! 
718  * \page AstHTTP AMI over HTTP support
719  * The http.c file includes support for manager transactions over
720  * http.
721  * \section ami AMI - The manager Interface
722  * \arg \link Config_ami Configuration file \endlink
723  */
724
725 /*! 
726  * \page res_config_sqlite SQLite Resource driver configuration
727  * \arg Implemented in \ref res_config_sqlite.c
728  * \arg Configuration file:
729  * \verbinclude res_config_sqlite.conf
730  * \arg SQL tables:
731  * \verbinclude res_config_sqlite.txt
732  * \arg See also:
733  * http://www.sqlite.org
734  */
735
736