Doxygen update
[asterisk/asterisk.git] / funcs / func_timeout.c
index 206ba94..a400a95 100644 (file)
@@ -21,6 +21,7 @@
  * \brief Channel timeout related dialplan functions
  *
  * \author Mark Spencer <markster@digium.com> 
+ * \ingroup functions
  */
 
 #include "asterisk.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"