This patch adds support for an <example /> tag in the XML documentation schema. For CLI help, this doesn't change the formatting too much: - Preceeding white space is removed - Unlike with para elements, new lines are preserved However, having an <example /> tag in the XML schema allows for the wiki documentation generation script to surround the documentation with {code} or {noformat} tags, generating much better content for the wiki - and allowing us to put dialplan examples (and other code snippets, if desired) into the documentation for an application/function/AMI command/etc. Review: https://reviewboard.asterisk.org/r/3807/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@419822 65c4cc65-6c06-0410-ace0-fbb531ad65f3 |
||
---|---|---|
.. | ||
lang | ||
api-1.6.0-changes.odt | ||
api-1.6.2-changes.txt | ||
appdocsxml.dtd | ||
appdocsxml.xslt | ||
astdb2bdb.8 | ||
astdb2sqlite3.8 | ||
asterisk.8 | ||
asterisk.sgml | ||
CODING-GUIDELINES | ||
IAX2-security.pdf | ||
IAX2-security.txt | ||
Makefile | ||
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.