sysmocom
/
asterisk
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
asterisk/doc
History
Matthew Jordan d04ab3c645 Add CLI configuration documentation 
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
 		2013-02-15 13:38:12 +00:00
..
lang Add app_voicemail and say.c support for Vietnamese. 2009-12-30 22:30:21 +00:00
CODING-GUIDELINES Restore CODING-GUIDELINES to doc folder 2012-08-30 12:50:03 +00:00
IAX2-security.pdf Merged revisions 216008 via svnmerge from 2009-09-03 18:45:54 +00:00
IAX2-security.txt Merged revisions 216263 via svnmerge from 2009-09-04 10:48:44 +00:00
Makefile Merged revisions 280740 via svnmerge from 2010-08-03 18:43:37 +00:00
README.txt Doxygen Updates Janitor Work 2012-09-22 20:43:30 +00:00
api-1.6.0-changes.odt add document describing API changes from 1.4.0 to 1.6.0 2008-05-24 01:14:41 +00:00
api-1.6.2-changes.txt Add timezone to the possible fields in a timespec. 2008-12-16 22:57:17 +00:00
appdocsxml.dtd Add CLI configuration documentation 2013-02-15 13:38:12 +00:00
asterisk.8 Merged revisions 331143 via svnmerge from 2011-08-09 16:02:45 +00:00
asterisk.sgml Merged revisions 331139 via svnmerge from 2011-08-09 15:53:26 +00:00

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.