Sapian
/
asterisk
mirror of http://gerrit.asterisk.org/asterisk
3
0
Fork 0
Code Issues Releases Wiki Activity

Doxygen Cleanup

Browse Source 
Start adding configuration file linking and pages.  Add module loading doxygen block.

(issue ASTERISK-20259)


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@374164 65c4cc65-6c06-0410-ace0-fbb531ad65f3
changes/78/78/1
Andrew Latham 13 years ago
parent b9eeff1521
commit 14be2a5514
10 changed files with 197 additions and 17 deletions
Show Stats Download Patch File Download Diff File

20
apps/app_adsiprog.c
Unescape View File

@ -25,6 +25,16 @@
* \ingroup applications
*/
/*!
* \li The application app_adsiprog uses the configuration file \ref adsi.conf
* \addtogroup configuration_file Configuration Files
*/
/*!
* \page adsi.conf adsi.conf
* \verbinclude adsi.conf.sample
*/
/*** MODULEINFO
<depend>res_adsi</depend>
<support_level>extended</support_level>
@ -1585,6 +1595,16 @@ static int unload_module(void)
return ast_unregister_application(app);
}
/*!
* \brief Load the module
*
* Module loading including tests for configuration or dependencies.
* This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
* or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
* tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
* configuration file or other non-critical problem return
* AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
*/
static int load_module(void)
{
if (ast_register_application_xml(app, adsi_exec))

24
apps/app_alarmreceiver.c
Unescape View File

@ -30,6 +30,16 @@
* \ingroup applications
*/
/*!
* \li The application app_alarmreceiver uses the configuration file \ref alarmreceiver.conf
* \addtogroup configuration_file Configuration Files
*/
/*!
* \page alarmreceiver.conf alarmreceiver.conf
* \verbinclude alarmreceiver.conf.sample
*/
/*** MODULEINFO
<support_level>extended</support_level>
***/
@ -724,11 +734,15 @@ static int unload_module(void)
return ast_unregister_application(app);
}
/**
* \brief Register Alarm Receiver App
*
* \retval 0 success
* \retval -1 failure
/*!
* \brief Load the module
*
* Module loading including tests for configuration or dependencies.
* This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
* or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
* tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
* configuration file or other non-critical problem return
* AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
*/
static int load_module(void)
{

22
apps/app_amd.c
Unescape View File

@ -24,6 +24,18 @@
* \brief Answering machine detection
*
* \author Claude Klimos (claude.klimos@aheeva.com)
*
* \ingroup applications
*/
/*!
* \li The application app_amd uses the configuration file \ref amd.conf
* \addtogroup configuration_file Configuration Files
*/
/*!
* \page amd.conf amd.conf
* \verbinclude amd.conf.sample
*/
/*** MODULEINFO
@ -487,6 +499,16 @@ static int unload_module(void)
return ast_unregister_application(app);
}
/*!
* \brief Load the module
*
* Module loading including tests for configuration or dependencies.
* This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
* or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
* tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
* configuration file or other non-critical problem return
* AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
*/
static int load_module(void)
{
if (load_config(0))

21
apps/app_confbridge.c
Unescape View File

@ -28,6 +28,16 @@
* \ingroup applications
*/
/*!
* \li The application app_confbridge uses the configuration file \ref confbridge.conf
* \addtogroup configuration_file Configuration Files
*/
/*!
* \page confbridge.conf confbridge.conf
* \verbinclude confbridge.conf.sample
*/
/*** MODULEINFO
<support_level>core</support_level>
***/
@ -2827,7 +2837,16 @@ static int unload_module(void)
return res;
}
/*! \brief Called when module is being loaded */
/*!
* \brief Load the module
*
* Module loading including tests for configuration or dependencies.
* This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
* or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
* tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
* configuration file or other non-critical problem return
* AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
*/
static int load_module(void)
{
int res = 0;

20
apps/app_festival.c
Unescape View File

@ -27,6 +27,16 @@
* \ingroup applications
*/
/*!
* \li The application app_festival uses the configuration file \ref festival.conf
* \addtogroup configuration_file Configuration Files
*/
/*!
* \page festival.conf festival.conf
* \verbinclude festival.conf.sample
*/
/*** MODULEINFO
<support_level>extended</support_level>
***/
@ -537,6 +547,16 @@ static int unload_module(void)
return ast_unregister_application(app);
}
/*!
* \brief Load the module
*
* Module loading including tests for configuration or dependencies.
* This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
* or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
* tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
* configuration file or other non-critical problem return
* AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
*/
static int load_module(void)
{
struct ast_flags config_flags = { 0 };

22
apps/app_followme.c
Unescape View File

@ -23,11 +23,19 @@
*
* \author BJ Weschke <bweschke@btwtech.com>
*
* \arg See \ref Config_followme
*
* \ingroup applications
*/
/*!
* \li The application app_followme uses the configuration file \ref followme.conf
* \addtogroup configuration_file Configuration Files
*/
/*!
* \page followme.conf followme.conf
* \verbinclude followme.conf.sample
*/
/*** MODULEINFO
<depend>chan_local</depend>
<support_level>core</support_level>
@ -1555,6 +1563,16 @@ static int unload_module(void)
return 0;
}
/*!
* \brief Load the module
*
* Module loading including tests for configuration or dependencies.
* This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
* or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
* tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
* configuration file or other non-critical problem return
* AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
*/
static int load_module(void)
{
if(!reload_followme(0))

22
apps/app_meetme.c
Unescape View File

@ -29,6 +29,16 @@
* \ingroup applications
*/
/*!
* \li The application app_meetme uses configuration file \ref meetme.conf
* \addtogroup configuration_file Configuration Files
*/
/*!
* \page meetme.conf meetme.conf
* \verbinclude meetme.conf.sample
*/
/*** MODULEINFO
<depend>dahdi</depend>
<defaultenabled>no</defaultenabled>
@ -7572,8 +7582,16 @@ static int unload_module(void)
return res;
}
/*!
* \brief Load the module
*
* Module loading including tests for configuration or dependencies.
* This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
* or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
* tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
* configuration file or other non-critical problem return
* AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
*/
static int load_module(void)
{
int res = 0;

21
apps/app_queue.c
Unescape View File

@ -22,8 +22,6 @@
*
* \author Mark Spencer <markster@digium.com>
*
* \arg Config in \ref Config_qu queues.conf
*
* \par Development notes
* \note 2004-11-25: Persistent Dynamic Members added by:
* NetNation Communications (www.netnation.com)
@ -56,6 +54,15 @@
* \ingroup applications
*/
/*!
* \li The application app_queues uses configuration file \ref queues.conf
* \addtogroup configuration_file
*/
/*! \page queues.conf queues.conf
* \verbinclude queues.conf.sample
*/
/*** MODULEINFO
<use type="module">res_monitor</use>
<support_level>core</support_level>
@ -9689,6 +9696,16 @@ static int unload_module(void)
return res;
}
/*!
* \brief Load the module
*
* Module loading including tests for configuration or dependencies.
* This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
* or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
* tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
* configuration file or other non-critical problem return
* AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
*/
static int load_module(void)
{
int res;

20
apps/app_skel.c
Unescape View File

@ -29,6 +29,16 @@
* \ingroup applications
*/
/*!
* \li The application app_skel uses configuration file \ref app_skel.conf
* \addtogroup configuration_file Configuration Files
*/
/*!
* \page app_skel.conf app_skel.conf
* \verbinclude app_skel.conf.sample
*/
/*** MODULEINFO
<defaultenabled>no</defaultenabled>
<support_level>core</support_level>
@ -651,10 +661,12 @@ static int unload_module(void)
/*!
* \brief Load the module
*
* \par The configuration file
*
* The application app_skel uses a configuration file.
* \verbinclude app_skel.conf.sample
* Module loading including tests for configuration or dependencies.
* This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
* or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
* tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
* configuration file or other non-critical problem return
* AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
*/
static int load_module(void)
{

22
apps/app_voicemail.c
Unescape View File

@ -28,7 +28,7 @@
* \par See also
* \arg \ref Config_vm
* \note For information about voicemail IMAP storage, https://wiki.asterisk.org/wiki/display/AST/IMAP+Voicemail+Storage
* \ingroup applications
* \ingroup applications
* \todo This module requires res_adsi to load. This needs to be optional
* during compilation.
*
@ -37,6 +37,16 @@
* with a plan to clean this up.
*/
/*!
* \li The application app_voicemail uses configuration file \ref voicemail.conf
* \addtogroup configuration_file Configuration Files
*/
/*!
* \page voicemail.conf voicemail.conf
* \verbinclude voicemail.conf.sample
*/
/*** MODULEINFO
<use type="module">res_adsi</use>
<use type="module">res_smdi</use>
@ -14277,6 +14287,16 @@ static int unload_module(void)
return res;
}
/*!
* \brief Load the module
*
* Module loading including tests for configuration or dependencies.
* This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
* or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
* tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
* configuration file or other non-critical problem return
* AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
*/
static int load_module(void)
{
int res;

Write Preview
Loading…
Cancel
Save