From 14be2a55144d3a6ee73d6df9442b703b00bfc482 Mon Sep 17 00:00:00 2001 From: Andrew Latham Date: Mon, 1 Oct 2012 23:22:50 +0000 Subject: Doxygen Cleanup 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 --- apps/app_meetme.c | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) (limited to 'apps/app_meetme.c') diff --git a/apps/app_meetme.c b/apps/app_meetme.c index 4669f36ac..8b71a71e0 100644 --- a/apps/app_meetme.c +++ b/apps/app_meetme.c @@ -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 dahdi no @@ -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; -- cgit v1.2.3