Skip to content
Snippets Groups Projects
  • Matthew Jordan's avatar
    d04ab3c6
    Add CLI configuration documentation · d04ab3c6
    Matthew Jordan authored
    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
    d04ab3c6
    History
    Add CLI configuration documentation
    Matthew Jordan authored
    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