diff options
| author | Matthew Jordan <mjordan@digium.com> | 2013-02-15 13:38:12 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2013-02-15 13:38:12 +0000 |
| commit | d04ab3c6450f3d92aa004ae9d6e0e7da51f702a3 (patch) | |
| tree | 821330ff71a4484afa46ade4a2bbd211c800a992 /doc | |
| parent | edf0483f4f0e73ded128f1e613b60f31925af102 (diff) | |
Add CLI configuration documentation
This patch allows a module to define its configuration in XML in source, such
that it can be parsed by the XML documentation engine. Documentation is
generated in a two-pass approach:
1. The documentation is first generated from the XML pulled from the source
2. The documentation is then enhanced by the registration of configuration
options that use the configuration framework
This patch include configuration documentation for the following modules:
* chan_motif
* res_xmpp
* app_confbridge
* app_skel
* udptl
Two new CLI commands have been added:
* config show help - show configuration help by module, category, and item
* xmldoc dump - dump the in-memory representation of the XML documentation to
a new XML file.
Review: https://reviewboard.asterisk.org/r/2278
Review: https://reviewboard.asterisk.org/r/2058
patches:
on review 2058 uploaded by twilson
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@381527 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/appdocsxml.dtd | 34 |
1 files changed, 29 insertions, 5 deletions
diff --git a/doc/appdocsxml.dtd b/doc/appdocsxml.dtd index 561e3d38c..a475cd32f 100644 --- a/doc/appdocsxml.dtd +++ b/doc/appdocsxml.dtd @@ -1,13 +1,13 @@ - <!ELEMENT docs (application|function|agi|manager|managerEvent|info)*> + <!ELEMENT docs (application|function|agi|manager|managerEvent|info|configInfo)*> <!ATTLIST docs xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude"> <!ELEMENT xi:include (xi:fallback?) > - <!ATTLIST xi:include + <!ATTLIST xi:include xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude" href CDATA #IMPLIED parse (xml|text) "xml" xpointer CDATA #IMPLIED - encoding CDATA #IMPLIED + encoding CDATA #IMPLIED accept CDATA #IMPLIED accept-language CDATA #IMPLIED > @@ -39,6 +39,30 @@ <!ELEMENT managerEventInstance (synopsis?,syntax?,description?,see-also?)*> <!ATTLIST managerEventInstance class CDATA #REQUIRED> + <!ELEMENT configInfo (synopsis?,description?,configFile+)> + <!ATTLIST configInfo name CDATA #REQUIRED> + <!ATTLIST configInfo language CDATA #REQUIRED> + + <!ELEMENT configFile (configObject+)> + <!ATTLIST configFile name CDATA #REQUIRED> + + <!ELEMENT configObject (synopsis?|description?|syntax?|see-also?|configOption)*> + <!ATTLIST configObject name CDATA #REQUIRED> + + <!ELEMENT configOption (synopsis,description?,syntax?,see-also?)*> + <!ATTLIST configOption name CDATA #REQUIRED> + <!ATTLIST configOption regex (yes|no|true|false) "false"> + <!ATTLIST configOption default CDATA #IMPLIED> + <!ATTLIST configOption type CDATA #IMPLIED> + + <!ELEMENT matchInfo (category|field?)> + + <!ELEMENT category (#PCDATA)> + <!ATTLIST category match (yes|no|true|false) #REQUIRED> + + <!ELEMENT field (#PCDATA)> + <!ATTLIST field name CDATA #REQUIRED> + <!ELEMENT info (para|note|warning|variablelist|enumlist|info|xi:include)*> <!ATTLIST info name CDATA #REQUIRED> <!ATTLIST info language CDATA #REQUIRED> @@ -52,7 +76,7 @@ <!ELEMENT synopsis (#PCDATA)> - <!ELEMENT syntax (parameter|xi:include)*> + <!ELEMENT syntax (parameter|dataType|category|matchInfo|xi:include)*> <!ATTLIST syntax argsep CDATA ","> <!ELEMENT description (para|note|warning|variablelist|enumlist|info|xi:include)*> @@ -91,7 +115,7 @@ <!ELEMENT replaceable (#PCDATA)> <!ELEMENT directory (#PCDATA)> <!ELEMENT astcli (#PCDATA)> - + <!ELEMENT note (para+|xi:include*)> <!ELEMENT warning (para+|xi:include*)> |