diff options
| author | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-12 00:17:43 +0000 |
|---|---|---|
| committer | eliel <eliel@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-12 00:17:43 +0000 |
| commit | f4ab4abaf3f24f01cc695a96649585ab7fc91948 (patch) | |
| tree | ea3966ab1c52341565ff036f510bb7ecddaef0b4 /doc | |
| parent | d8c640af72a7468ebf5a492093b8148a8dfeb62d (diff) | |
Implement AGI XML documentation parsing functions.
A new <agi> element is used to describe the XML documentation.
We have the usual synopsis,syntax,description and seealso for AGI commands.
The CLI 'agi show commands' command was changed to show all the documentation se
ctions.
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@156051 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/appdocsxml.dtd | 27 |
1 files changed, 16 insertions, 11 deletions
diff --git a/doc/appdocsxml.dtd b/doc/appdocsxml.dtd index 057bf099b..0c0b8256f 100644 --- a/doc/appdocsxml.dtd +++ b/doc/appdocsxml.dtd @@ -1,4 +1,4 @@ - <!ELEMENT docs (application|function)* > + <!ELEMENT docs (application|function|agi)* > <!ELEMENT application (synopsis?,syntax?,description?,see-also?)> <!ATTLIST application name CDATA #REQUIRED> @@ -6,36 +6,42 @@ <!ELEMENT function (synopsis?,syntax?,description?,see-also?)> <!ATTLIST function name CDATA #REQUIRED> - <!ATTLIST function language CDATA #REQUIRED> + <!ATTLIST function language CDATA #REQUIRED> + + <!ELEMENT agi (synopsis?,syntax?,description?,see-also?)> + <!ATTLIST agi name CDATA #REQUIRED> + <!ATTLIST agi language CDATA #REQUIRED> <!ELEMENT see-also (ref*)> <!ELEMENT ref (#PCDATA)*> - <!ATTLIST ref type (application|function|astcli|link|manpage|filename) #REQUIRED> + <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi) #REQUIRED> <!ELEMENT synopsis (#PCDATA)> - + <!ELEMENT syntax (parameter*)> <!ATTLIST syntax argsep CDATA ","> <!ELEMENT description (para|note|warning|variablelist|enumlist)*> - <!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning)*> - <!ATTLIST parameter name CDATA #REQUIRED> + <!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter)*> + <!ATTLIST parameter name CDATA ""> <!ATTLIST parameter required (yes|no|true|false) "false"> <!ATTLIST parameter multiple (yes|no|true|false) "false"> <!ATTLIST parameter hasparams (yes|no|true|false|optional) "false"> + <!ATTLIST parameter literal (yes|no|true|false) "false"> + <!ATTLIST parameter default CDATA ""> <!ATTLIST parameter argsep CDATA ","> <!ELEMENT optionlist (option+)> <!ELEMENT option (argument|para|note|warning|variablelist|enumlist)*> - <!ATTLIST option name CDATA #REQUIRED> + <!ATTLIST option name CDATA #REQUIRED> <!ATTLIST option argsep CDATA ","> <!ATTLIST option implies CDATA ""> <!ELEMENT enumlist (enum+)> <!ELEMENT enum (para|note|warning)*> - <!ATTLIST enum name CDATA #REQUIRED> + <!ATTLIST enum name CDATA ""> <!ELEMENT argument (para|note|warning|variablelist|argument)*> <!ATTLIST argument name CDATA #REQUIRED> @@ -53,12 +59,11 @@ <!ELEMENT note (para+)> <!ELEMENT warning (para+)> - + <!ELEMENT variablelist (variable+)> <!ELEMENT variable (#PCDATA|value|para)*> <!ATTLIST variable name CDATA ""> - + <!ELEMENT value (#PCDATA)> <!ATTLIST value name CDATA #REQUIRED> <!ATTLIST value default CDATA ""> - |