[svn-commits] mvanbaak: branch group/appdocsxml r128244 - /team/group/appdocsxml/doc/

[SVN commits to the Digium repositories]

Author: mvanbaak
Date: Sat Jul  5 16:05:47 2008
New Revision: 128244

URL: http://svn.digium.com/view/asterisk?view=rev&rev=128244
Log:
start documenting the xml specification for documentation

Added:
    team/group/appdocsxml/doc/xmldocumentation.txt   (with props)

Added: team/group/appdocsxml/doc/xmldocumentation.txt
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/doc/xmldocumentation.txt?view=auto&rev=128244
==============================================================================
--- team/group/appdocsxml/doc/xmldocumentation.txt (added)
+++ team/group/appdocsxml/doc/xmldocumentation.txt Sat Jul  5 16:05:47 2008
@@ -1,0 +1,77 @@
+Applications etc now have to be documented with XML.
+This document will outline the format for that documentation.
+A lot of examples will be taken from apps/app_dial.c
+
+Application documentation:
+
+Nodes:
+application - required, defines the application name
+	synopsis - required, small description of the application
+	description - required, longer description of the application
+	variable - optional, 1 or more nodes describing the dialplan variables this application uses
+		value - optional, 1 or more nodes describing the possible values of this variable
+	option - optional, 1 or more nodes describing the application options
+		argument - optional, 1 or more nodes describing the option arguments
+		variable - optional, 1 or more nodes describing option specific variables
+			value - optional, 1 or more nodes describing the possible values of this variable
+
+Attributes per node:
+application:
+* name - required, the name of the application
+variable:
+* name   - required, The variable name.
+* access - optional, defines wether this variable is read-only or read-write.
+           possible values:
+		   ro - read-only. This is the default if the attribute is omitted.
+		   rw - read-write
+	value:
+	* name    - required. The name of the possible value.
+	* default - optional, defines wether this value is the default.
+				possible values:
+				false - This is not the default value. This is the default if the attribute is omitted.
+				true  - This is the default value.
+option:
+* name     - required. The option name.
+* argsep   - optional, If the option takes arguments they will be seperated by this character
+* required - optional, defines wether this option is required.
+			 possible values:
+			 false - This option is not required. This is the default if the attribute is omitted.
+			 true  - This option is required.
+	argument:
+	* name - required, The name of the option argument
+	* required - optional, defines wether this argument is required.
+				 possible values:
+				 false - This argument is not required. This is the default if the attribute is omitted.
+				 true  - This argument is required.
+
+Example:
+
+/*** DOCUMENTATION
+	<application name="MyApp">
+		<synopsis>
+			Small description of MyApp
+		</synopsis>
+		<description>
+			Long description of MyApp.
+			You can tell the user what it does here
+		</description>
+		<variable name="myvar" access="ro">
+			<value name="myvarvalue" default="true">
+				tell what this value means
+			</value>
+			description of the variable
+		</variable>
+		<option name="myoption" argsep="^" required="true">
+			<argument name="foo" required="true">
+				argument description
+			</argument>
+			<variable name="MYAPP_VAR_FOO" access="rw">
+				<value name="bar" default="true">
+					description
+				</value>
+				description
+			</variable>
+			option description
+		</option>
+	</application>
+***/

Propchange: team/group/appdocsxml/doc/xmldocumentation.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: team/group/appdocsxml/doc/xmldocumentation.txt
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Propchange: team/group/appdocsxml/doc/xmldocumentation.txt
------------------------------------------------------------------------------
    svn:mime-type = text/plain