Doxygen update
[asterisk/asterisk.git] / funcs / func_timeout.c
index 75b328e..a400a95 100644 (file)
  * \brief Channel timeout related dialplan functions
  *
  * \author Mark Spencer <markster@digium.com> 
+ * \ingroup functions
  */
 
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
 #include <sys/types.h>
 
-#include "asterisk.h"
-
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
 #include "asterisk/module.h"
 #include "asterisk/channel.h"
 #include "asterisk/pbx.h"
@@ -40,13 +41,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/app.h"
 #include "asterisk/options.h"
 
-static int timeout_read(struct ast_channel *chan, char *cmd, char *data,
+static int timeout_read(struct ast_channel *chan, const char *cmd, char *data,
                        char *buf, size_t len)
 {
        time_t myt;
 
        if (!data) {
-               ast_log(LOG_ERROR, "Must specify type of timeout to get.");
+               ast_log(LOG_ERROR, "Must specify type of timeout to get.\n");
                return -1;
        }
 
@@ -76,14 +77,14 @@ static int timeout_read(struct ast_channel *chan, char *cmd, char *data,
                break;
 
        default:
-               ast_log(LOG_ERROR, "Unknown timeout type specified.");
+               ast_log(LOG_ERROR, "Unknown timeout type specified.\n");
                break;
        }
 
        return 0;
 }
 
-static int timeout_write(struct ast_channel *chan, char *cmd, char *data,
+static int timeout_write(struct ast_channel *chan, const char *cmd, char *data,
                         const char *value)
 {
        int x;
@@ -91,7 +92,7 @@ static int timeout_write(struct ast_channel *chan, char *cmd, char *data,
        struct tm myt;
 
        if (!data) {
-               ast_log(LOG_ERROR, "Must specify type of timeout to set.");
+               ast_log(LOG_ERROR, "Must specify type of timeout to set.\n");
                return -1;
        }
 
@@ -137,7 +138,7 @@ static int timeout_write(struct ast_channel *chan, char *cmd, char *data,
                break;
 
        default:
-               ast_log(LOG_ERROR, "Unknown timeout type specified.");
+               ast_log(LOG_ERROR, "Unknown timeout type specified.\n");
                break;
        }
 
@@ -146,7 +147,7 @@ static int timeout_write(struct ast_channel *chan, char *cmd, char *data,
 
 static struct ast_custom_function timeout_function = {
        .name = "TIMEOUT",
-       .synopsis = "Gets or sets timeouts on the channel.",
+       .synopsis = "Gets or sets timeouts on the channel. Timeout values are in seconds.",
        .syntax = "TIMEOUT(timeouttype)",
        .desc =
                "Gets or sets various channel timeouts. The timeouts that can be\n"
@@ -173,29 +174,14 @@ static struct ast_custom_function timeout_function = {
        .write = timeout_write,
 };
 
-static char *tdesc = "Channel timeout dialplan functions";
-
-int unload_module(void)
+static int unload_module(void)
 {
        return ast_custom_function_unregister(&timeout_function);
 }
 
-int load_module(void)
+static int load_module(void)
 {
        return ast_custom_function_register(&timeout_function);
 }
 
-const char *description(void)
-{
-       return tdesc;
-}
-
-int usecount(void)
-{
-       return 0;
-}
-
-const char *key()
-{
-       return ASTERISK_GPL_KEY;
-}
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Channel timeout dialplan functions");