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