From 99e1174bfabb3579b97ca6ec5309e1dea2041006 Mon Sep 17 00:00:00 2001 From: Andrew Latham Date: Mon, 1 Oct 2012 23:24:35 +0000 Subject: Doxygen Cleanup Start adding configuration file linking and pages. Add module loading doxygen block. Breaking up commits to keep it easy to track (issue ASTERISK-20259) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@374166 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- channels/chan_dahdi.c | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) (limited to 'channels/chan_dahdi.c') diff --git a/channels/chan_dahdi.c b/channels/chan_dahdi.c index f669e2ead..678312631 100644 --- a/channels/chan_dahdi.c +++ b/channels/chan_dahdi.c @@ -29,14 +29,20 @@ * You need to install libraries before you attempt to compile * and install the DAHDI channel. * - * \par See also - * \arg \ref Config_dahdi - * * \ingroup channel_drivers * * \todo Deprecate the "musiconhold" configuration option post 1.4 */ +/*! + * \li The channel chan_dahdi uses the configuration file \ref chan_dahdi.conf + * \addtogroup configuration_file + */ + +/*! \page chan_dahdi.conf chan_dahdi.conf + * \verbinclude chan_dahdi.conf.sample + */ + /*** MODULEINFO res_smdi dahdi @@ -19096,6 +19102,16 @@ static const struct ast_data_entry dahdi_data_providers[] = { AST_DATA_ENTRY("asterisk/channel/dahdi/version", &dahdi_version_data_provider) }; +/*! + * \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; -- cgit v1.2.3