astobj2: Add backtrace to log_bad_ao2.
[asterisk/asterisk.git] / funcs / func_module.c
index 00ccf05..143804a 100644 (file)
  *
  * \brief Simple module check function
  * \author Olle E. Johansson, Edvina.net
+ *
+ * \ingroup functions
  */
-#include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+/*** MODULEINFO
+       <support_level>core</support_level>
+ ***/
+
+#include "asterisk.h"
 
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <sys/types.h>
-#include <sys/stat.h>
+ASTERISK_REGISTER_FILE()
 
 #include "asterisk/module.h"
-#include "asterisk/channel.h"
 #include "asterisk/pbx.h"
-#include "asterisk/logger.h"
-#include "asterisk/utils.h"
-#include "asterisk/app.h"
-#include "asterisk/module.h"
+
+/*** DOCUMENTATION
+       <function name="IFMODULE" language="en_US">
+               <synopsis>
+                       Checks if an Asterisk module is loaded in memory.
+               </synopsis>
+               <syntax>
+                       <parameter name="modulename.so" required="true">
+                               <para>Module name complete with <literal>.so</literal></para>
+                       </parameter>
+               </syntax>
+               <description>
+                       <para>Checks if a module is loaded. Use the full module name
+                       as shown by the list in <literal>module list</literal>.
+                       Returns <literal>1</literal> if module exists in memory, otherwise <literal>0</literal></para>
+               </description>
+       </function>
+ ***/
 
 static int ifmodule_read(struct ast_channel *chan, const char *cmd, char *data,
                    char *buf, size_t len)
@@ -55,12 +69,8 @@ static int ifmodule_read(struct ast_channel *chan, const char *cmd, char *data,
 
 static struct ast_custom_function ifmodule_function = {
        .name = "IFMODULE",
-       .synopsis = "Checks if an Asterisk module is loaded in memory",
-       .syntax = "IFMODULE(<modulename.so>)",
        .read = ifmodule_read,
-       .desc = "Checks if a module is loaded. Use the full module name\n"
-               "as shown by the list in \"module list\". \n"
-               "Returns \"1\" if module exists in memory, otherwise \"0\".\n",
+       .read_max = 2,
 };