diff options
author | tilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-07-31 01:10:47 +0000 |
---|---|---|
committer | tilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-07-31 01:10:47 +0000 |
commit | 356721a45cdb0b1f733602287d432f861fb24102 (patch) | |
tree | cc270243ba13c3006e7988529a8665655a65060e /funcs | |
parent | c3f03b34444ec12eb2a7fcef062b070bfe48f876 (diff) |
Mostly cleanup of documentation to substitute the pipe with the comma, but a few other formatting cleanups, too.
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@77808 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'funcs')
-rw-r--r-- | funcs/func_cdr.c | 8 | ||||
-rw-r--r-- | funcs/func_channel.c | 10 | ||||
-rw-r--r-- | funcs/func_curl.c | 2 | ||||
-rw-r--r-- | funcs/func_enum.c | 8 | ||||
-rw-r--r-- | funcs/func_odbc.c | 14 | ||||
-rw-r--r-- | funcs/func_timeout.c | 12 |
6 files changed, 28 insertions, 26 deletions
diff --git a/funcs/func_cdr.c b/funcs/func_cdr.c index 017bfccca..4e7baa039 100644 --- a/funcs/func_cdr.c +++ b/funcs/func_cdr.c @@ -121,7 +121,7 @@ static int cdr_write(struct ast_channel *chan, const char *cmd, char *parse, static struct ast_custom_function cdr_function = { .name = "CDR", .synopsis = "Gets or sets a CDR variable", - .syntax = "CDR(<name>[|options])", + .syntax = "CDR(<name>[,options])", .read = cdr_read, .write = cdr_write, .desc = @@ -146,9 +146,9 @@ static struct ast_custom_function cdr_function = { " and this variable will be stored on the cdr.\n" " raw values for disposition:\n" " 1 = NO ANSWER\n" -" 2 = BUSY\n" -" 3 = FAILED\n" -" 4 = ANSWERED\n" +" 2 = BUSY\n" +" 3 = FAILED\n" +" 4 = ANSWERED\n" " raw values for amaflags:\n" " 1 = OMIT\n" " 2 = BILLING\n" diff --git a/funcs/func_channel.c b/funcs/func_channel.c index 2a449532a..5ed03e31d 100644 --- a/funcs/func_channel.c +++ b/funcs/func_channel.c @@ -181,11 +181,11 @@ static struct ast_custom_function channel_function = { " remote_count Number of transmitted packets\n" " rtt Round trip time\n" " all All statistics (in a form suited to logging, but not for parsing)\n" - "R/O rtpdest Get remote RTP destination information\n" - " This option takes one additional argument:\n" - " Argument 1:\n" - " audio Get audio destination\n" - " video Get video destination\n" + "R/O rtpdest Get remote RTP destination information\n" + " This option takes one additional argument:\n" + " Argument 1:\n" + " audio Get audio destination\n" + " video Get video destination\n" "\n" "chan_iax2 provides the following additional options:\n" "R/W osptoken Get or set the OSP token information for a call\n" diff --git a/funcs/func_curl.c b/funcs/func_curl.c index a33b8db64..a254d3ca8 100644 --- a/funcs/func_curl.c +++ b/funcs/func_curl.c @@ -167,7 +167,7 @@ static int acf_curl_exec(struct ast_channel *chan, const char *cmd, char *info, struct ast_custom_function acf_curl = { .name = "CURL", .synopsis = "Retrieves the contents of a URL", - .syntax = "CURL(url[|post-data])", + .syntax = "CURL(url[,post-data])", .desc = " url - URL to retrieve\n" " post-data - Optional data to send as a POST (GET is default action)\n", diff --git a/funcs/func_enum.c b/funcs/func_enum.c index 581d68a7a..f3655be9e 100644 --- a/funcs/func_enum.c +++ b/funcs/func_enum.c @@ -52,7 +52,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/enum.h" #include "asterisk/app.h" -static char *synopsis = "Syntax: ENUMLOOKUP(number[|Method-type[|options[|record#[|zone-suffix]]]])\n"; +static char *synopsis = "Syntax: ENUMLOOKUP(number[,Method-type[,options[,record#[,zone-suffix]]]])\n"; static int function_enum(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) @@ -293,7 +293,7 @@ finish: static struct ast_custom_function enum_query_function = { .name = "ENUMQUERY", .synopsis = "Initiate an ENUM query", - .syntax = "ENUMQUERY(number[|Method-type[|zone-suffix]])", + .syntax = "ENUMQUERY(number[,Method-type[,zone-suffix]])", .desc = "This will do a ENUM lookup of the given phone number.\n" "If no method-tpye is given, the default will be sip. If no\n" "zone-suffix is given, the default will be \"e164.arpa\".\n" @@ -305,7 +305,7 @@ static struct ast_custom_function enum_query_function = { static struct ast_custom_function enum_result_function = { .name = "ENUMRESULT", .synopsis = "Retrieve results from a ENUMQUERY", - .syntax = "ENUMRESULT(id|resultnum)", + .syntax = "ENUMRESULT(id,resultnum)", .desc = "This function will retrieve results from a previous use\n" "of the ENUMQUERY function.\n" " id - This argument is the identifier returned by the ENUMQUERY function.\n" @@ -320,7 +320,7 @@ static struct ast_custom_function enum_function = { .synopsis = "General or specific querying of NAPTR records for ENUM or ENUM-like DNS pointers", .syntax = - "ENUMLOOKUP(number[|Method-type[|options[|record#[|zone-suffix]]]])", + "ENUMLOOKUP(number[,Method-type[,options[,record#[,zone-suffix]]]])", .desc = "Option 'c' returns an integer count of the number of NAPTRs of a certain RR type.\n" "Combination of 'c' and Method-type of 'ALL' will return a count of all NAPTRs for the record.\n" diff --git a/funcs/func_odbc.c b/funcs/func_odbc.c index 1c39326f8..856c5c288 100644 --- a/funcs/func_odbc.c +++ b/funcs/func_odbc.c @@ -595,11 +595,12 @@ static int init_acf_query(struct ast_config *cfg, char *catg, struct acf_odbc_qu } } - if ((tmp = ast_variable_retrieve(cfg, catg, "read"))) { - ast_log(LOG_WARNING, "Parameter 'read' is deprecated for category %s. Please use 'readsql' instead.\n", catg); + if ((tmp = ast_variable_retrieve(cfg, catg, "readsql"))) ast_copy_string((*query)->sql_read, tmp, sizeof((*query)->sql_read)); - } else if ((tmp = ast_variable_retrieve(cfg, catg, "readsql"))) + else if ((tmp = ast_variable_retrieve(cfg, catg, "read"))) { + ast_log(LOG_WARNING, "Parameter 'read' is deprecated for category %s. Please use 'readsql' instead.\n", catg); ast_copy_string((*query)->sql_read, tmp, sizeof((*query)->sql_read)); + } if (!ast_strlen_zero((*query)->sql_read) && ast_strlen_zero((*query)->readhandle[0])) { ast_free(*query); @@ -608,11 +609,12 @@ static int init_acf_query(struct ast_config *cfg, char *catg, struct acf_odbc_qu return EINVAL; } - if ((tmp = ast_variable_retrieve(cfg, catg, "write"))) { - ast_log(LOG_WARNING, "Parameter 'write' is deprecated for category %s. Please use 'writesql' instead.\n", catg); + if ((tmp = ast_variable_retrieve(cfg, catg, "writesql"))) ast_copy_string((*query)->sql_write, tmp, sizeof((*query)->sql_write)); - } else if ((tmp = ast_variable_retrieve(cfg, catg, "writesql"))) + else if ((tmp = ast_variable_retrieve(cfg, catg, "write"))) { + ast_log(LOG_WARNING, "Parameter 'write' is deprecated for category %s. Please use 'writesql' instead.\n", catg); ast_copy_string((*query)->sql_write, tmp, sizeof((*query)->sql_write)); + } if (!ast_strlen_zero((*query)->sql_write) && ast_strlen_zero((*query)->writehandle[0])) { ast_free(*query); diff --git a/funcs/func_timeout.c b/funcs/func_timeout.c index 51d2a47d9..86186ba24 100644 --- a/funcs/func_timeout.c +++ b/funcs/func_timeout.c @@ -153,7 +153,7 @@ static struct ast_custom_function timeout_function = { "Gets or sets various channel timeouts. The timeouts that can be\n" "manipulated are:\n" "\n" "absolute: The absolute maximum amount of time permitted for a call. A\n" - " setting of 0 disables the timeout.\n" "\n" + " setting of 0 disables the timeout.\n" "\n" "digit: The maximum amount of time permitted between digits when the\n" " user is typing in an extension. When this timeout expires,\n" " after the user has started to type in an extension, the\n" @@ -165,11 +165,11 @@ static struct ast_custom_function timeout_function = { " extension, or if it doesn't exist the call would be\n" " terminated). The default timeout is 5 seconds.\n" "\n" "response: The maximum amount of time permitted after falling through a\n" - " series of priorities for a channel in which the user may\n" - " begin typing an extension. If the user does not type an\n" - " extension in this amount of time, control will pass to the\n" - " 't' extension if it exists, and if not the call would be\n" - " terminated. The default timeout is 10 seconds.\n", + " series of priorities for a channel in which the user may\n" + " begin typing an extension. If the user does not type an\n" + " extension in this amount of time, control will pass to the\n" + " 't' extension if it exists, and if not the call would be\n" + " terminated. The default timeout is 10 seconds.\n", .read = timeout_read, .write = timeout_write, }; |