From f938fd90021869d7e0210c63de0e603159a93f04 Mon Sep 17 00:00:00 2001
From: Mathieu Rene <mrene@avgs.ca>
Date: Tue, 27 Jan 2009 21:32:15 +0000
Subject: [PATCH] Add a couple comments to mod_skel

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@11515 d0543943-73ff-0310-b7d9-9358b9ac24b2
---
 src/mod/applications/mod_skel/mod_skel.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/mod/applications/mod_skel/mod_skel.c b/src/mod/applications/mod_skel/mod_skel.c
index 8d1aa4c660..e44be1fdaf 100644
--- a/src/mod/applications/mod_skel/mod_skel.c
+++ b/src/mod/applications/mod_skel/mod_skel.c
@@ -32,12 +32,17 @@
  */
 #include <switch.h>
 
+/* Prototypes */
 //SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_skel_shutdown);
 //SWITCH_MODULE_RUNTIME_FUNCTION(mod_skel_runtime);
-
 SWITCH_MODULE_LOAD_FUNCTION(mod_skel_load);
+
+/* SWITCH_MODULE_DEFINITION(name, load, shutdown, runtime) 
+ * Defines a switch_loadable_module_function_table_t and a static const char[] modname
+ */
 SWITCH_MODULE_DEFINITION(mod_skel, mod_skel_load, NULL, NULL);
 
+/* Macro expands to: switch_status_t mod_skel_load(switch_loadable_module_interface_t **module_interface, switch_memory_pool_t *pool) */
 SWITCH_MODULE_LOAD_FUNCTION(mod_skel_load)
 {
 	/* connect my internal structure to the blank pointer passed to me */
@@ -51,6 +56,7 @@ SWITCH_MODULE_LOAD_FUNCTION(mod_skel_load)
 
 /*
   Called when the system shuts down
+  Macro expands to: switch_status_t mod_skel_shutdown()
 SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_skel_shutdown)
 {
 	return SWITCH_STATUS_SUCCESS;
@@ -60,6 +66,7 @@ SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_skel_shutdown)
 /*
   If it exists, this is called in it's own thread when the module-load completes
   If it returns anything but SWITCH_STATUS_TERM it will be called again automatically
+  Macro expands to: switch_status_t mod_skel_runtime()
 SWITCH_MODULE_RUNTIME_FUNCTION(mod_skel_runtime)
 {
 	while(looping)