[asterisk-commits] lmadsen: branch 1.6.2 r249916 - in /branches/1.6.2: ./ pbx/pbx_dundi.c

[SVN commits to the Asterisk project]

Author: lmadsen
Date: Tue Mar  2 13:22:14 2010
New Revision: 249916

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=249916
Log:
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)
........

Modified:
    branches/1.6.2/   (props changed)
    branches/1.6.2/pbx/pbx_dundi.c

Propchange: branches/1.6.2/
------------------------------------------------------------------------------
Binary property 'trunk-merged' - no diff available.

Modified: branches/1.6.2/pbx/pbx_dundi.c
URL: http://svnview.digium.com/svn/asterisk/branches/1.6.2/pbx/pbx_dundi.c?view=diff&rev=249916&r1=249915&r2=249916
==============================================================================
--- branches/1.6.2/pbx/pbx_dundi.c (original)
+++ branches/1.6.2/pbx/pbx_dundi.c Tue Mar  2 13:22:14 2010
@@ -64,6 +64,82 @@
 #include "asterisk/app.h"
 
 #include "dundi-parser.h"
+
+/*** DOCUMENTATION
+	<function name="DUNDILOOKUP" language="en_US">
+		<synopsis>
+			Do a DUNDi lookup of a phone number.
+		</synopsis>
+		<syntax>
+			<parameter name="number" required="true"/>
+			<parameter name="context">
+				<para>If not specified the default will be <literal>e164</literal>.</para>
+			</parameter>
+			<parameter name="options">
+				<optionlist>
+					<option name="b">
+						<para>Bypass the internal DUNDi cache</para>
+					</option>
+				</optionlist>
+			</parameter>
+		</syntax>
+		<description>
+			<para>This will do a DUNDi lookup of the given phone number.</para>
+			<para>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.</para>
+		</description>
+	</function>
+			
+		
+	<function name="DUNDIQUERY" language="en_US">
+		<synopsis>
+			Initiate a DUNDi query.
+		</synopsis>
+		<syntax>
+			<parameter name="number" required="true"/>
+			<parameter name="context">
+				<para>If not specified the default will be <literal>e164</literal>.</para>
+			</parameter>
+			<parameter name="options">
+				<optionlist>
+					<option name="b">
+						<para>Bypass the internal DUNDi cache</para>
+					</option>
+				</optionlist>
+			</parameter>
+		</syntax>
+		<description>
+			<para>This will do a DUNDi lookup of the given phone number.</para>
+			<para>The result of this function will be a numeric ID that can be used to retrieve
+			the results with the <literal>DUNDIRESULT</literal> function.</para>
+		</description>
+	</function>
+
+	<function name="DUNDIRESULT" language="en_US">
+		<synopsis>
+			Retrieve results from a DUNDIQUERY.
+		</synopsis>
+		<syntax>
+			<parameter name="id" required="true">
+				<para>The identifier returned by the <literal>DUNDIQUERY</literal> function.</para>
+			</parameter>
+			<parameter name="resultnum">
+				<optionlist>
+					<option name="number">
+						<para>The number of the result that you want to retrieve, this starts at <literal>1</literal></para>
+					</option>
+					<option name="getnum">
+						<para>The total number of results that are available.</para>
+					</option>
+				</optionlist>
+			</parameter>
+		</syntax>
+		<description>
+			<para>This function will retrieve results from a previous use\n"
+			of the <literal>DUNDIQUERY</literal> function.</para>
+		</description>
+	</function>
+ ***/
 
 #define MAX_RESULTS	64
 
@@ -3866,14 +3942,6 @@
 
 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 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 @@
 
 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,
 };