From e11cc293602b6c35ed94722bc52376acf6c38164 Mon Sep 17 00:00:00 2001 From: Andrew Latham Date: Mon, 1 Oct 2012 23:24:10 +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@374165 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- res/res_calendar.c | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'res/res_calendar.c') diff --git a/res/res_calendar.c b/res/res_calendar.c index 8c349946b..dd2a643c5 100644 --- a/res/res_calendar.c +++ b/res/res_calendar.c @@ -23,6 +23,16 @@ * \todo Support writing attendees */ +/*! + * \li The resource res_calendar uses the configuration file \ref calendar.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page calendar.conf calendar.conf + * \verbinclude calendar.conf.sample + */ + /*** MODULEINFO core ***/ @@ -1830,6 +1840,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 (!(calendars = ao2_container_alloc(CALENDAR_BUCKETS, calendar_hash_fn, calendar_cmp_fn))) { -- cgit v1.2.3