diff options
| author | Matthew Jordan <mjordan@digium.com> | 2012-06-25 17:59:34 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2012-06-25 17:59:34 +0000 |
| commit | 82a7409c15cf943ebc12cc8453424350628732bf (patch) | |
| tree | fd06e7c2248dae47e019c76bef0b4865c284e00d /doc | |
| parent | d0fda07d74b0e73ea563e3b90361faf5f20965e3 (diff) | |
Add AMI event documentation
This patch adds the core changes necessary to support AMI event documentation
in the source files of Asterisk, and adds documentation to those AMI events
defined in the core application modules. Event documentation is built from
the source by two new python scripts, located in build_tools:
get_documentation.py and post_process_documentation.py.
The get_documentation.py script mirrors the actions of the existing AWK
get_documentation scripts, except that it will scan the entirety of a source
file for Asterisk documentation. Upon encountering it, if the documentation
happens to be an AMI event, it will attempt to extract information about the
event directly from the manager event macro calls that raise the event. The
post_process_documentation.py script combines manager event instances that
are the same event but documented in multiple source files. It generates
the final core-[lang].xml file.
As this process can take longer to complete than a typical 'make all', it
is only performed if a new make target, 'full', is chosen.
Review: https://reviewboard.asterisk.org/r/1967/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@369346 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/appdocsxml.dtd | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/appdocsxml.dtd b/doc/appdocsxml.dtd index 328752c30..59f91c33c 100644 --- a/doc/appdocsxml.dtd +++ b/doc/appdocsxml.dtd @@ -1,4 +1,4 @@ - <!ELEMENT docs (application|function|agi|manager)*> + <!ELEMENT docs (application|function|agi|manager|managerEvent)*> <!ATTLIST docs xmlns:xi CDATA #FIXED "http://www.w3.org/2001/XInclude"> <!ELEMENT xi:include (xi:fallback?) > @@ -29,10 +29,17 @@ <!ATTLIST manager name CDATA #REQUIRED> <!ATTLIST manager language CDATA #REQUIRED> + <!ELEMENT managerEvent (managerEventInstance+)> + <!ATTLIST managerEvent name CDATA #REQUIRED> + <!ATTLIST managerEvent language CDATA #REQUIRED> + + <!ELEMENT managerEventInstance (synopsis?,syntax?,description?,see-also?)*> + <!ATTLIST managerEventInstance class CDATA #REQUIRED> + <!ELEMENT see-also (ref|xi:include)*> <!ELEMENT ref (#PCDATA)> - <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi) #REQUIRED> + <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi|managerEvent) #REQUIRED> <!ELEMENT synopsis (#PCDATA)> |