[asterisk-commits] eliel: branch group/appdocsxml r145198 - in /team/group/appdocsxml: apps/ funcs/

[SVN commits to the Asterisk project]

Author: eliel
Date: Tue Sep 30 13:26:50 2008
New Revision: 145198

URL: http://svn.digium.com/view/asterisk?view=rev&rev=145198
Log:
Introduce function ICON xml documentation.
Fix an issue in SoftHangup application xml documentation.

Modified:
    team/group/appdocsxml/apps/app_softhangup.c
    team/group/appdocsxml/funcs/func_iconv.c

Modified: team/group/appdocsxml/apps/app_softhangup.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_softhangup.c?view=diff&rev=145198&r1=145197&r2=145198
==============================================================================
--- team/group/appdocsxml/apps/app_softhangup.c (original)
+++ team/group/appdocsxml/apps/app_softhangup.c Tue Sep 30 13:26:50 2008
@@ -55,7 +55,7 @@
 			<para>Hangs up the requested channel.  If there are no channels to 
 			hangup, the application will report it.</para>
 		</description>
-	</aplication>
+	</application>
 
  ***/
 

Modified: team/group/appdocsxml/funcs/func_iconv.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_iconv.c?view=diff&rev=145198&r1=145197&r2=145198
==============================================================================
--- team/group/appdocsxml/funcs/func_iconv.c (original)
+++ team/group/appdocsxml/funcs/func_iconv.c Tue Sep 30 13:26:50 2008
@@ -40,6 +40,32 @@
 #include "asterisk/pbx.h"
 #include "asterisk/utils.h"
 #include "asterisk/app.h"
+
+/*** DOCUMENTATION
+	<function name="ICONV" language="en_US">
+		<synopsis>
+			Converts charsets of strings.	
+		</synopsis>
+		<syntax>
+			<parameter name="in-charset" required="true">
+				<para>Input charset</para>
+			</parameter>
+			<parameter name="out-charset" required="true">
+				<para>Output charset</para>
+			</parameter>
+			<parameter name="string" required="true">
+				<para>String to convert, from <replaceable>in-charset</replaceable> to <replaceable>out-charset</replaceable></para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Converts string from <replaceable>in-charset</replaceable> into <replaceable>out-charset</replaceable>.
+			For available charsets, use <literal>iconv -l</literal> on your shell command line.</para>
+			<note><para>Due to limitations within the API, ICONV will not currently work with
+			charsets with embedded NULLs. If found, the string will terminate.</para></note>
+		</description>
+	</function>
+ ***/
+
 
 /*! 
  * Some systems define the second arg to iconv() as (const char *),
@@ -101,14 +127,7 @@
 
 static struct ast_custom_function iconv_function = {
 	.name = "ICONV",
-	.synopsis = "Converts charsets of strings.",
-	.desc =
-"Converts string from in-charset into out-charset.  For available charsets,\n"
-"use 'iconv -l' on your shell command line.\n"
-"Note: due to limitations within the API, ICONV will not currently work with\n"
-"charsets with embedded NULLs.  If found, the string will terminate.\n",
-	.syntax = "ICONV(in-charset,out-charset,string)",
-	.read = iconv_read,
+	.read = iconv_read
 };
 
 static int unload_module(void)