82a7409c15
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 |
||
|---|---|---|
| .. | ||
| lang | ||
| IAX2-security.pdf | ||
| IAX2-security.txt | ||
| Makefile | ||
| README.txt | ||
| api-1.6.0-changes.odt | ||
| api-1.6.2-changes.txt | ||
| appdocsxml.dtd | ||
| asterisk.8 | ||
| asterisk.sgml | ||
README.txt
The vast majority of the Asterisk project documentation has been moved to the
project wiki:
http://wiki.asterisk.org/
Asterisk release tarballs contain an export of the wiki in PDF and plain text
form, which you can find in:
doc/AST.pdf
doc/AST.txt