[asterisk-dev] [Code Review] 2616: Features configuration documentation

[rmudgett]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/2616/#review8932
-----------------------------------------------------------

Ship it!


Ship It!

- rmudgett


On June 12, 2013, 1:15 a.m., Mark Michelson wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/2616/
> -----------------------------------------------------------
> 
> (Updated June 12, 2013, 1:15 a.m.)
> 
> 
> Review request for Asterisk Developers.
> 
> 
> Repository: Asterisk
> 
> 
> Description
> -------
> 
> This adds XML documentation for features configuration. This is mostly straightforward, but there are a few points to make:
> 
> * I've changed the appdocsxml.dtd to allow ref elements to refer to configOption elements.
> * Applicationmap items have a syntax section, but this does not print to the CLI when the configuration help is shown. It appears that that code in xmldoc.c specifically ignores syntax sections in configOption elements. This should likely be changed, but it should be done as a separate change.
> * Applicationmap items and featuregroup items can take any name as the name of the option. I followed the example of ConfBridge and used the acceptable regex as the name of the configuration option. This results in the somewhat clunky CLI command "config show help features applicationmap ^.*$" . Unfortunately, there's not really a better option as far as I can tell.
> 
> 
> Diffs
> -----
> 
>   /trunk/doc/appdocsxml.dtd 391478 
>   /trunk/main/features_config.c 391478 
> 
> Diff: https://reviewboard.asterisk.org/r/2616/diff/
> 
> 
> Testing
> -------
> 
> Docs validate properly and the CLI commands to show the help work as expected.
> 
> 
> Thanks,
> 
> Mark Michelson
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20130621/4906dad5/attachment.htm>