[asterisk-commits] lathama: trunk r374164 - /trunk/apps/
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Mon Oct 1 18:22:56 CDT 2012
Author: lathama
Date: Mon Oct 1 18:22:50 2012
New Revision: 374164
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=374164
Log:
Doxygen Cleanup
Start adding configuration file linking and pages. Add module loading doxygen block.
(issue ASTERISK-20259)
Modified:
trunk/apps/app_adsiprog.c
trunk/apps/app_alarmreceiver.c
trunk/apps/app_amd.c
trunk/apps/app_confbridge.c
trunk/apps/app_festival.c
trunk/apps/app_followme.c
trunk/apps/app_meetme.c
trunk/apps/app_queue.c
trunk/apps/app_skel.c
trunk/apps/app_voicemail.c
Modified: trunk/apps/app_adsiprog.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_adsiprog.c?view=diff&rev=374164&r1=374163&r2=374164
==============================================================================
--- trunk/apps/app_adsiprog.c (original)
+++ trunk/apps/app_adsiprog.c Mon Oct 1 18:22:50 2012
@@ -23,6 +23,16 @@
* \author Mark Spencer <markster at digium.com>
*
* \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
@@ -1585,6 +1595,16 @@
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))
Modified: trunk/apps/app_alarmreceiver.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_alarmreceiver.c?view=diff&rev=374164&r1=374163&r2=374164
==============================================================================
--- trunk/apps/app_alarmreceiver.c (original)
+++ trunk/apps/app_alarmreceiver.c Mon Oct 1 18:22:50 2012
@@ -28,6 +28,16 @@
* *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING ***
*
* \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
@@ -724,11 +734,15 @@
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)
{
Modified: trunk/apps/app_amd.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_amd.c?view=diff&rev=374164&r1=374163&r2=374164
==============================================================================
--- trunk/apps/app_amd.c (original)
+++ trunk/apps/app_amd.c Mon Oct 1 18:22:50 2012
@@ -24,6 +24,18 @@
* \brief Answering machine detection
*
* \author Claude Klimos (claude.klimos at 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 @@
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))
Modified: trunk/apps/app_confbridge.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_confbridge.c?view=diff&rev=374164&r1=374163&r2=374164
==============================================================================
--- trunk/apps/app_confbridge.c (original)
+++ trunk/apps/app_confbridge.c Mon Oct 1 18:22:50 2012
@@ -26,6 +26,16 @@
*
* This is a conference bridge application utilizing the bridging core.
* \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
@@ -2827,7 +2837,16 @@
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;
Modified: trunk/apps/app_festival.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_festival.c?view=diff&rev=374164&r1=374163&r2=374164
==============================================================================
--- trunk/apps/app_festival.c (original)
+++ trunk/apps/app_festival.c Mon Oct 1 18:22:50 2012
@@ -25,6 +25,16 @@
* \extref The Festival Speech Synthesis System - http://www.cstr.ed.ac.uk/projects/festival/
*
* \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
@@ -537,6 +547,16 @@
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 };
Modified: trunk/apps/app_followme.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_followme.c?view=diff&rev=374164&r1=374163&r2=374164
==============================================================================
--- trunk/apps/app_followme.c (original)
+++ trunk/apps/app_followme.c Mon Oct 1 18:22:50 2012
@@ -23,9 +23,17 @@
*
* \author BJ Weschke <bweschke at 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
@@ -1555,6 +1563,16 @@
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))
Modified: trunk/apps/app_meetme.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_meetme.c?view=diff&rev=374164&r1=374163&r2=374164
==============================================================================
--- trunk/apps/app_meetme.c (original)
+++ trunk/apps/app_meetme.c Mon Oct 1 18:22:50 2012
@@ -27,6 +27,16 @@
* \author (SLA) Russell Bryant <russell at digium.com>
*
* \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
@@ -7572,8 +7582,16 @@
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;
Modified: trunk/apps/app_queue.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_queue.c?view=diff&rev=374164&r1=374163&r2=374164
==============================================================================
--- trunk/apps/app_queue.c (original)
+++ trunk/apps/app_queue.c Mon Oct 1 18:22:50 2012
@@ -21,8 +21,6 @@
* \brief True call queues with optional send URL on answer
*
* \author Mark Spencer <markster at digium.com>
- *
- * \arg Config in \ref Config_qu queues.conf
*
* \par Development notes
* \note 2004-11-25: Persistent Dynamic Members added by:
@@ -54,6 +52,15 @@
* by Matthew Enger <m.enger at xi.com.au>
*
* \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
@@ -9689,6 +9696,16 @@
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;
Modified: trunk/apps/app_skel.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_skel.c?view=diff&rev=374164&r1=374163&r2=374164
==============================================================================
--- trunk/apps/app_skel.c (original)
+++ trunk/apps/app_skel.c Mon Oct 1 18:22:50 2012
@@ -27,6 +27,16 @@
*
* This is a skeleton for development of an Asterisk application
* \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
@@ -651,10 +661,12 @@
/*!
* \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)
{
Modified: trunk/apps/app_voicemail.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_voicemail.c?view=diff&rev=374164&r1=374163&r2=374164
==============================================================================
--- trunk/apps/app_voicemail.c (original)
+++ trunk/apps/app_voicemail.c Mon Oct 1 18:22:50 2012
@@ -28,13 +28,23 @@
* \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.
*
* \todo This file is now almost impossible to work with, due to all \#ifdefs.
* Feels like the database code before realtime. Someone - please come up
* 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
@@ -14277,6 +14287,16 @@
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;
More information about the asterisk-commits
mailing list