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

[SVN commits to the Asterisk project]

Author: eliel
Date: Sat Oct  4 23:30:42 2008
New Revision: 146408

URL: http://svn.digium.com/view/asterisk?view=rev&rev=146408
Log:
Introduce the VERSION() function XML documentation.

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

Modified: team/group/appdocsxml/funcs/func_version.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_version.c?view=diff&rev=146408&r1=146407&r2=146408
==============================================================================
--- team/group/appdocsxml/funcs/func_version.c (original)
+++ team/group/appdocsxml/funcs/func_version.c Sat Oct  4 23:30:42 2008
@@ -33,6 +33,31 @@
 #include "asterisk/app.h"
 #include "asterisk/ast_version.h"
 #include "asterisk/build.h"
+
+/*** DOCUMENTATION
+	<function name="VERSION" language="en_US">
+		<synopsis>
+			Return the Version info for this Asterisk.
+		</synopsis>
+		<syntax>
+			<parameter name="info">
+				<para>The possible values are:</para>
+				<para><literal>ASTERISK_VERSION_NUM</literal>, a string of digits is returned (right now fixed at 999999).</para>
+				<para><literal>BUILD_USER</literal>, the string representing the user's name whose account was used to configure Asterisk, is returned.</para>
+				<para><literal>BUILD_HOSTNAME</literal>, the string representing the name of the host on which Asterisk was configured, is returned.</para>
+				<para><literal>BUILD_MACHINE</literal>, the string representing the type of machine on which Asterisk was configured, is returned.</para>
+				<para><literal>BUILD_OS</literal>, the string representing the OS of the machine on which Asterisk was configured, is returned.</para>
+				<para><literal>BUILD_DATE</literal>, the string representing the date on which Asterisk was configured, is returned.</para>
+				<para><literal>BUILD_KERNEL</literal>, the string representing the kernel version of the machine on which Asterisk was configured, is returned.</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>If there are no arguments, return the version of Asterisk in this format: SVN-branch-1.4-r44830M</para>
+			<para>Example:  Set(junky=${VERSION()};</para>
+			<para>Sets junky to the string <literal>SVN-branch-1.6-r74830M</literal>, or possibly, <literal>SVN-trunk-r45126M</literal>.</para>
+		</description>
+	</function>
+ ***/
 
 static int acf_version_exec(struct ast_channel *chan, const char *cmd,
 			 char *parse, char *buffer, size_t buflen)
@@ -70,19 +95,6 @@
 
 static struct ast_custom_function acf_version = {
 	.name = "VERSION",
-	.synopsis = "Return the Version info for this Asterisk",
-	.syntax = "VERSION([info])",
-	.desc =
-		"If there are no arguments, return the version of Asterisk in this format: SVN-branch-1.4-r44830M\n"
-		"If the argument is 'ASTERISK_VERSION_NUM', a string of digits is returned (right now fixed at 999999).\n"
-		"If the argument is 'BUILD_USER', the string representing the user's name whose account was used to configure Asterisk, is returned.\n"
-		"If the argument is 'BUILD_HOSTNAME', the string representing the name of the host on which Asterisk was configured, is returned.\n"
-		"If the argument is 'BUILD_MACHINE', the string representing the type of machine on which Asterisk was configured, is returned.\n"
-		"If the argument is 'BUILD_OS', the string representing the OS of the machine on which Asterisk was configured, is returned.\n"
-		"If the argument is 'BUILD_DATE', the string representing the date on which Asterisk was configured, is returned.\n"
-		"If the argument is 'BUILD_KERNEL', the string representing the kernel version of the machine on which Asterisk was configured, is returned .\n"
-		"  Example:  Set(junky=${VERSION()}; \n"
-		"  Sets junky to the string 'SVN-branch-1.6-r74830M', or possibly, 'SVN-trunk-r45126M'.\n",
 	.read = acf_version_exec,
 };