[asterisk-commits] mvanbaak: branch group/appdocsxml r143135 - in /team/group/appdocsxml: apps/ ...

SVN commits to the Asterisk project asterisk-commits at lists.digium.com
Mon Sep 15 13:47:49 CDT 2008


Author: mvanbaak
Date: Mon Sep 15 13:47:49 2008
New Revision: 143135

URL: http://svn.digium.com/view/asterisk?view=rev&rev=143135
Log:
last commit to fix all xml docblocks that were already in this tree.
Now it's time to start converting the rest ;)

Modified:
    team/group/appdocsxml/apps/app_morsecode.c
    team/group/appdocsxml/funcs/func_shell.c

Modified: team/group/appdocsxml/apps/app_morsecode.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_morsecode.c?view=diff&rev=143135&r1=143134&r2=143135
==============================================================================
--- team/group/appdocsxml/apps/app_morsecode.c (original)
+++ team/group/appdocsxml/apps/app_morsecode.c Mon Sep 15 13:47:49 2008
@@ -40,9 +40,9 @@
 			Plays morse code
 		</synopsis>
 		<syntax>
-			<argument name="string" required="true">
+			<parameter name="string" required="true">
 				<para>String to playback as morse code to channel</para>
-			</argument>
+			</parameter>
 		</syntax>
 		<description>
 			<para>Plays the Morse code equivalent of the passed string.</para>

Modified: team/group/appdocsxml/funcs/func_shell.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_shell.c?view=diff&rev=143135&r1=143134&r2=143135
==============================================================================
--- team/group/appdocsxml/funcs/func_shell.c (original)
+++ team/group/appdocsxml/funcs/func_shell.c Mon Sep 15 13:47:49 2008
@@ -68,18 +68,21 @@
 		<synopsis>
 			Executes a command as if you were at a shell.
 		</synopsis>
+		<syntax>
+			<parameter name="command" required="true">
+				<para>This is the argument to the function, the command you want to pass to the shell.</para>
+			</parameter>
+		</syntax>
 		<description>
-			  Returns the value from a system command
-			Example:  Set(foo=${SHELL(echo \bar\)})
-			Note:  When using the SHELL() dialplan function, your \SHELL\ is /bin/sh,
+			<para>Returns the value from a system command</para>
+			<para>Example:  <literal>Set(foo=${SHELL(echo \bar\)})</literal></para>
+			<note>When using the SHELL() dialplan function, your \SHELL\ is /bin/sh,
 			which may differ as to the underlying shell, depending upon your production
 			platform.  Also keep in mind that if you are using a common path, you should
 			be mindful of race conditions that could result from two calls running
-			SHELL() simultaneously.
+			SHELL() simultaneously.</note>
 		</description>
-		<option name="command" required="true">
-			This is the argument to the function, the command you want to pass to the shell.
-		</option> 
+ 
 	</function>
  ***/
 static struct ast_custom_function shell_function = {




More information about the asterisk-commits mailing list