Update config framework/sorcery with types/options without documentation
authorMatthew Jordan <mjordan@digium.com>
Fri, 23 Aug 2013 15:21:40 +0000 (15:21 +0000)
committerMatthew Jordan <mjordan@digium.com>
Fri, 23 Aug 2013 15:21:40 +0000 (15:21 +0000)
commite31bd332b83f0245ce8bd6626279e1b9c683ec18
treef6ce4f0257399a167527b6dd02fda9339d323214
parentb2a13e83dcb4958cccd5d314a1bb8bf25379cb51
Update config framework/sorcery with types/options without documentation

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' - which has its own
   separate API call - they are actually provided by a different configuration
   file. The options are merely registered so that the user gets a warning that
   a different configuration file provides the item.

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.

Review: https://reviewboard.asterisk.org/r/2785/

(closes issue ASTERISK-22359)
Reported by: Matt Jordan

(closes issue ASTERISK-22112)
Reported by: Rusty Newton

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@397524 65c4cc65-6c06-0410-ace0-fbb531ad65f3
include/asterisk/config_options.h
include/asterisk/sorcery.h
main/config_options.c
main/features_config.c
main/sorcery.c
res/res_pjsip.c
res/res_pjsip/pjsip_configuration.c
res/res_pjsip/pjsip_options.c