[asterisk-commits] mvanbaak: branch group/appdocsxml r128337 - /team/group/appdocsxml/doc/

[SVN commits to the Asterisk project]

Author: mvanbaak
Date: Sat Jul  5 19:08:39 2008
New Revision: 128337

URL: http://svn.digium.com/view/asterisk?view=rev&rev=128337
Log:
add some extra doc about special first option to a lot of applications

Modified:
    team/group/appdocsxml/doc/xmldocumentation.txt

Modified: team/group/appdocsxml/doc/xmldocumentation.txt
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/doc/xmldocumentation.txt?view=diff&rev=128337&r1=128336&r2=128337
==============================================================================
--- team/group/appdocsxml/doc/xmldocumentation.txt (original)
+++ team/group/appdocsxml/doc/xmldocumentation.txt Sat Jul  5 19:08:39 2008
@@ -45,6 +45,16 @@
 				 false - This argument is not required. This is the default if the attribute is omitted.
 				 true  - This argument is required.
 
+There's a special option node for a lot of applications/functions.
+For example, Dial takes Technology/Resource[&Technology2/Resource2] as first, required argument.
+We decided to document this with an <option> tag in the following format:
+<option name="Technology/Resource" argsep="&" required="true">
+	<argument name="Technology2/Resource2">
+		Optional secondary 'device' to dial
+	</argument>
+	'device' to dial
+</option>
+
 Example:
 
 /*** DOCUMENTATION