[asterisk-commits] eliel: branch group/appdocsxml r145330 - /team/group/appdocsxml/funcs/

[SVN commits to the Asterisk project]

Author: eliel
Date: Wed Oct  1 07:38:49 2008
New Revision: 145330

URL: http://svn.digium.com/view/asterisk?view=rev&rev=145330
Log:
Introduce BASE64_ENCODE and BASE64_DECODE XML documentation.

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

Modified: team/group/appdocsxml/funcs/func_base64.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_base64.c?view=diff&rev=145330&r1=145329&r2=145330
==============================================================================
--- team/group/appdocsxml/funcs/func_base64.c (original)
+++ team/group/appdocsxml/funcs/func_base64.c Wed Oct  1 07:38:49 2008
@@ -30,6 +30,35 @@
 #include "asterisk/pbx.h"	/* function register/unregister */
 #include "asterisk/utils.h"
 
+/*** DOCUMENTATION
+	<function name="BASE64_ENCODE" language="en_US">
+		<synopsis>
+			Encode a string in base64.
+		</synopsis>
+		<syntax>
+			<parameter name="string" required="true">
+				<para>Input string</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Returns the base64 string.</para>
+		</description>
+	</function>
+	<function name="BASE64_DECODE" language="en_US">
+		<synopsis>
+			Decode a base64 string.
+		</synopsis>
+		<syntax>
+			<parameter name="string" required="true">
+				<para>Input string.</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Returns the plain text string.</para>
+		</description>
+	</function>
+ ***/
+
 static int base64_encode(struct ast_channel *chan, const char *cmd, char *data,
 			 char *buf, size_t len)
 {
@@ -58,17 +87,11 @@
 
 static struct ast_custom_function base64_encode_function = {
 	.name = "BASE64_ENCODE",
-	.synopsis = "Encode a string in base64",
-	.desc = "Returns the base64 string\n",
-	.syntax = "BASE64_ENCODE(<string>)",
 	.read = base64_encode,
 };
 
 static struct ast_custom_function base64_decode_function = {
 	.name = "BASE64_DECODE",
-	.synopsis = "Decode a base64 string",
-	.desc = "Returns the plain text string\n",
-	.syntax = "BASE64_DECODE(<base64_string>)",
 	.read = base64_decode,
 };