[svn-commits] eliel: branch group/appdocsxml r145431 - /team/group/appdocsxml/funcs/func_uri.c

[SVN commits to the Digium repositories]

Author: eliel
Date: Wed Oct  1 10:48:59 2008
New Revision: 145431

URL: http://svn.digium.com/view/asterisk?view=rev&rev=145431
Log:
Introduce URIENCODE() and URIDECODE() functions XML documentation.

Modified:
    team/group/appdocsxml/funcs/func_uri.c

Modified: team/group/appdocsxml/funcs/func_uri.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_uri.c?view=diff&rev=145431&r1=145430&r2=145431
==============================================================================
--- team/group/appdocsxml/funcs/func_uri.c (original)
+++ team/group/appdocsxml/funcs/func_uri.c Wed Oct  1 10:48:59 2008
@@ -38,6 +38,35 @@
 #include "asterisk/utils.h"
 #include "asterisk/app.h"
 
+/*** DOCUMENTATION
+	<function name="URIENCODE" language="en_US">
+		<synopsis>
+			Encodes a string to URI-safe encoding according to RFC 2396.
+		</synopsis>
+		<syntax>
+			<parameter name="data" required="true">
+				<para>Input string to be encoded.</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Returns the encoded string defined in <replaceable>data</replaceable>.</para>
+		</description>
+	</function>
+	<function name="URIDECODE" language="en_US">
+		<synopsis>
+			Decodes a URI-encoded string according to RFC 2396.
+		</synopsis>
+		<syntax>
+			<parameter name="data" required="true">
+				<para>Input string to be decoded.</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Returns the decoded URI-encoded <replaceable>data</replaceable> string.</para>
+		</description>
+	</function>
+ ***/
+
 /*! \brief uriencode: Encode URL according to RFC 2396 */
 static int uriencode(struct ast_channel *chan, const char *cmd, char *data,
 		     char *buf, size_t len)
@@ -69,15 +98,11 @@
 
 static struct ast_custom_function urldecode_function = {
 	.name = "URIDECODE",
-	.synopsis = "Decodes a URI-encoded string according to RFC 2396.",
-	.syntax = "URIDECODE(<data>)",
 	.read = uridecode,
 };
 
 static struct ast_custom_function urlencode_function = {
 	.name = "URIENCODE",
-	.synopsis = "Encodes a string to URI-safe encoding according to RFC 2396.",
-	.syntax = "URIENCODE(<data>)",
 	.read = uriencode,
 };