[asterisk-dev] [Code Review] 2785: Update config framework/sorcery to allow for options/types without documentation; update documentation for various modules

[svnbot]

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

(Updated Aug. 23, 2013, 10:21 a.m.)


Status
------

This change has been marked as submitted.


Review request for Asterisk Developers.


Changes
-------

Committed in revision 397524


Bugs: ASTERISK-22112 and ASTERISK-22359
    https://issues.asterisk.org/jira/browse/ASTERISK-22112
    https://issues.asterisk.org/jira/browse/ASTERISK-22359


Repository: Asterisk


Description
-------

There are times when a configuration option should not have documentation.

1. Some options are registered with a particular object merely as a warning to users. These options aren't even really 'deprecated', they are just provided by a different configuration file.

2. Some object types - most notably some used by modules that use sorcery - are completely internal and should never be shown to the user.

3. Sorcery itself has several 'hidden' fields that should never be shown to a user.

This patch updates the configuration framework and sorcery with additional API calls that allow a module to register types as internal and options as not requiring documentation. This bypasses the XML documentation checking.

This patch also re-enables the strict XML documentation checking in trunk, as well as updates some documentation that was missing.


Diffs
-----

  /trunk/res/res_pjsip.c 397523 
  /trunk/res/res_pjsip/pjsip_configuration.c 397523 
  /trunk/main/sorcery.c 397523 
  /trunk/main/features_config.c 397523 
  /trunk/include/asterisk/sorcery.h 397523 
  /trunk/main/config_options.c 397523 
  /trunk/include/asterisk/config_options.h 397523 
  /trunk/res/res_pjsip/pjsip_options.c 397523 

Diff: https://reviewboard.asterisk.org/r/2785/diff/


Testing
-------


Thanks,

Matt Jordan

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20130823/5e865aa1/attachment.htm>