]> git.ipfire.org Git - thirdparty/freeswitch.git/commitdiff
Add a couple comments to mod_skel
authorMathieu Rene <mrene@avgs.ca>
Tue, 27 Jan 2009 21:32:15 +0000 (21:32 +0000)
committerMathieu Rene <mrene@avgs.ca>
Tue, 27 Jan 2009 21:32:15 +0000 (21:32 +0000)
git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@11515 d0543943-73ff-0310-b7d9-9358b9ac24b2

src/mod/applications/mod_skel/mod_skel.c

index 8d1aa4c660b405dd969b9c49c0c0521d7f37f4cf..e44be1fdafb34babc013ca7f8eaf332163fdef87 100644 (file)
  */
 #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)