From 71bd4ecc4a15d2927bb201939a401256e14b14fa Mon Sep 17 00:00:00 2001 From: lmadsen Date: Tue, 2 Mar 2010 19:22:14 +0000 Subject: Merged revisions 249912 via svnmerge from https://origsvn.digium.com/svn/asterisk/trunk ........ r249912 | lmadsen | 2010-03-02 14:21:19 -0500 (Tue, 02 Mar 2010) | 6 lines Convert some DUNDI functions to XML documentation. (closes issue #16798) Reported by: snuffy Patches: xml_dundi.diff uploaded by snuffy (license 35) ........ git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.6.2@249916 f38db490-d61c-443f-a65b-d21fe96a405b --- pbx/pbx_dundi.c | 99 +++++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 76 insertions(+), 23 deletions(-) diff --git a/pbx/pbx_dundi.c b/pbx/pbx_dundi.c index 51bfe2b27..38004d400 100644 --- a/pbx/pbx_dundi.c +++ b/pbx/pbx_dundi.c @@ -65,6 +65,82 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "dundi-parser.h" +/*** DOCUMENTATION + + + Do a DUNDi lookup of a phone number. + + + + + If not specified the default will be e164. + + + + + + + + + This will do a DUNDi lookup of the given phone number. + This function will return the Technology/Resource found in the first result + in the DUNDi lookup. If no results were found, the result will be blank. + + + + + + + Initiate a DUNDi query. + + + + + If not specified the default will be e164. + + + + + + + + + This will do a DUNDi lookup of the given phone number. + The result of this function will be a numeric ID that can be used to retrieve + the results with the DUNDIRESULT function. + + + + + + Retrieve results from a DUNDIQUERY. + + + + The identifier returned by the DUNDIQUERY function. + + + + + + + + + + This function will retrieve results from a previous use\n" + of the DUNDIQUERY function. + + + ***/ + #define MAX_RESULTS 64 #define MAX_PACKET_SIZE 8192 @@ -3866,14 +3942,6 @@ static int dundifunc_read(struct ast_channel *chan, const char *cmd, char *num, static struct ast_custom_function dundi_function = { .name = "DUNDILOOKUP", - .synopsis = "Do a DUNDi lookup of a phone number.", - .syntax = "DUNDILOOKUP(number[,context[,options]])", - .desc = "This will do a DUNDi lookup of the given phone number.\n" - "If no context is given, the default will be e164. The result of\n" - "this function will return the Technology/Resource found in the first result\n" - "in the DUNDi lookup. If no results were found, the result will be blank.\n" - "If the 'b' option is specified, the internal DUNDi cache will\n" - "be bypassed.\n", .read = dundifunc_read, }; @@ -3971,13 +4039,6 @@ static int dundi_query_read(struct ast_channel *chan, const char *cmd, char *dat static struct ast_custom_function dundi_query_function = { .name = "DUNDIQUERY", - .synopsis = "Initiate a DUNDi query.", - .syntax = "DUNDIQUERY(number[|context[|options]])", - .desc = "This will do a DUNDi lookup of the given phone number.\n" - "If no context is given, the default will be e164. The result of\n" - "this function will be a numeric ID that can be used to retrieve\n" - "the results with the DUNDIRESULT function. If the 'b' option is\n" - "is specified, the internal DUNDi cache will be bypassed.\n", .read = dundi_query_read, }; @@ -4057,14 +4118,6 @@ finish: static struct ast_custom_function dundi_result_function = { .name = "DUNDIRESULT", - .synopsis = "Retrieve results from a DUNDIQUERY", - .syntax = "DUNDIRESULT(id|resultnum)", - .desc = "This function will retrieve results from a previous use\n" - "of the DUNDIQUERY function.\n" - " id - This argument is the identifier returned by the DUNDIQUERY function.\n" - " resultnum - This is the number of the result that you want to retrieve.\n" - " Results start at 1. If this argument is specified as \"getnum\",\n" - " then it will return the total number of results that are available.\n", .read = dundi_result_read, }; -- cgit v1.2.3