d04ab3c645
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 |
||
---|---|---|
.. | ||
lang | ||
CODING-GUIDELINES | ||
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: https://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 Asterisk uses the Doxygen documentation software. Run "make progdocs" and open the resulting documentation index at doc/api/index.html in a webbrowser or copy the directory to a directory served by a webserver for remote access.