From 5b168ee34babe562be856ec8f1dd14c0abd7c1a5 Mon Sep 17 00:00:00 2001
From: Russell Bryant <russell@russellbryant.com>
Date: Sat, 1 Nov 2008 21:10:07 +0000
Subject: Merge changes from team/group/appdocsxml

This commit introduces the first phase of an effort to manage documentation of the
interfaces in Asterisk in an XML format.  Currently, a new format is available for
applications and dialplan functions.  A good number of conversions to the new format
are also included.

For more information, see the following message to asterisk-dev:

http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---
 funcs/func_uri.c | 33 +++++++++++++++++++++++++++++----
 1 file changed, 29 insertions(+), 4 deletions(-)

(limited to 'funcs/func_uri.c')

diff --git a/funcs/func_uri.c b/funcs/func_uri.c
index 94ae220b6..5efa6ea38 100644
--- a/funcs/func_uri.c
+++ b/funcs/func_uri.c
@@ -38,6 +38,35 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #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 int uridecode(struct ast_channel *chan, const char *cmd, char *data,
 
 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,
 };
 
-- 
cgit v1.2.3