kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 11:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update config framework/sorcery with types/options without documentation

Browse Source 
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
This commit is contained in:
Matthew Jordan
2013-08-23 15:21:40 +00:00
parent b2a13e83dc
commit e31bd332b8
8 changed files with 141 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
main/features_config.c
View File

@@ -1654,39 +1654,39 @@ static int load_config(void)
aco_option_register_custom(&cfg_info, "pickupfailsound", ACO_EXACT, global_options,
DEFAULT_PICKUPFAILSOUND, pickup_handler, 0);
aco_option_register_custom(&cfg_info, "context", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "context", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "parkext", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "parkext", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "parkext_exclusive", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "parkext_exclusive", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "parkinghints", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "parkinghints", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "parkedmusicclass", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "parkedmusicclass", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "parkingtime", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "parkingtime", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "parkpos", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "parkpos", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "findslot", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "findslot", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "parkedcalltransfers", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "parkedcalltransfers", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "parkedcallreparking", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "parkedcallreparking", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "parkedcallhangup", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "parkedcallhangup", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "parkedcallrecording", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "parkedcallrecording", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "comebackcontext", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "comebackcontext", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "comebacktoorigin", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "comebacktoorigin", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "comebackdialtime", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "comebackdialtime", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "parkeddynamic", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "parkeddynamic", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "adsipark", ACO_EXACT, global_options,
aco_option_register_custom_nodoc(&cfg_info, "adsipark", ACO_EXACT, global_options,
"", unsupported_handler, 0);
aco_option_register_custom(&cfg_info, "blindxfer", ACO_EXACT, featuremap_options,