kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-03 03:02:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e31bd332b83f0245ce8bd6626279e1b9c683ec18
asterisk/include/asterisk
History
Matthew Jordan e31bd332b8 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
2013-08-23 15:21:40 +00:00
..
doxygen
Fix some doxygen bridging file references.
2013-08-16 18:34:31 +00:00
_private.h
Refactor CEL to avoid using the event system core
2013-08-17 14:46:44 +00:00
abstract_jb.h
Merge in the bridge_construction branch to make the system use the Bridging API.
2013-05-21 18:00:22 +00:00
acl.h
Stasis: Update security events to use Stasis
2013-05-17 17:36:10 +00:00
adsi.h
Multiple revisions 369323-369324
2012-06-25 15:55:25 +00:00
ael_structs.h
Merged revisions 136726 via svnmerge from
2008-08-08 00:48:35 +00:00
agi.h
Remove the old stub files, preferring the optional_api method.
2010-07-14 20:48:59 +00:00
alaw.h
…
aoc.h
Generic Advice of Charge.
2010-06-02 18:10:15 +00:00
app.h
Massively clean up app_queue.
2013-08-22 18:52:41 +00:00
ari.h
Rename everything Stasis-HTTP to ARI
2013-07-27 23:11:02 +00:00
ast_expr.h
Merge str_substitution branch.
2009-04-29 18:53:01 +00:00
ast_version.h
Rename version.h to ast_version.h. Next, I will be re-adding version.h as an
2008-02-26 20:02:14 +00:00
astdb.h
app_queue: Support persisting and loading of long member lists.
2012-10-01 20:36:25 +00:00
astmm.h
Merged revisions 376049 via svnmerge from
2012-11-08 18:19:49 +00:00
astobj2.h
Stasis: address refcount races; implementation comments
2013-08-16 16:03:34 +00:00
astobj.h
Merged revisions 129970 via svnmerge from
2008-07-11 14:22:44 +00:00
astosp.h
…
audiohook.h
Minor optimizations.
2013-07-19 23:30:10 +00:00
autochan.h
Convert the ast_channel data structure over to the astobj2 framework.
2009-04-24 14:04:26 +00:00
autoconfig.h.in
Fix documentation replication issues
2013-08-01 17:07:52 +00:00
backtrace.h
Add backtrace generation to MALLOC_DEBUG memory corruption reports
2013-06-08 22:09:07 +00:00
bridge_after.h
A great big renaming patch
2013-07-25 04:06:32 +00:00
bridge_basic.h
Massively clean up app_queue.
2013-08-22 18:52:41 +00:00
bridge_channel_internal.h
Fix some doxygen bridging file references.
2013-08-16 18:34:31 +00:00
bridge_channel.h
Bridge API: Set a cause code on a channel when it is ejected from a bridge.
2013-08-22 21:09:52 +00:00
bridge_features.h
Fix several interrelated issues dealing with the holding bridge technology.
2013-08-21 15:51:19 +00:00
bridge_internal.h
Bridge API: Set a cause code on a channel when it is ejected from a bridge.
2013-08-22 21:09:52 +00:00
bridge_roles.h
ARI: bridges/{bridgeID}/addChannel: add roles parameter
2013-08-05 16:59:13 +00:00
bridge_technology.h
A great big renaming patch
2013-07-25 04:06:32 +00:00
bridge.h
Bridge API: Set a cause code on a channel when it is ejected from a bridge.
2013-08-22 21:09:52 +00:00
buildinfo.h
try to get this committed before the buildbot complains about a broken tree
2008-10-30 16:53:11 +00:00
calendar.h
Track module use count for res_calendar
2012-02-22 21:22:43 +00:00
callerid.h
Allow for redirecting reasons to be set to arbitrary strings.
2012-09-25 19:29:14 +00:00
causes.h
Merged revisions 378735,378748 via svnmerge from
2013-01-09 20:21:33 +00:00
ccss.h
Merge in the bridge_construction branch to make the system use the Bridging API.
2013-05-21 18:00:22 +00:00
cdr.h
Handle hangup logic in the Stasis message bus and consumers of Stasis messages
2013-07-07 20:34:38 +00:00
cel.h
Make CEL behavior conform to the documentation
2013-08-22 17:13:16 +00:00
celt.h
I think reviewboard broke this. The whole file was doubled.
2011-07-07 22:39:54 +00:00
channel_internal.h
Split caching out from the stasis_caching_topic.
2013-08-01 13:49:34 +00:00
channel.h
Remove some dead code dealing with: AST_BRIDGE_REC_CHANNEL_0, AST_BRIDGE_REC_CHANNEL_1, and AST_BRIDGE_IGNORE_SIGS.
2013-08-15 15:12:16 +00:00
channelstate.h
Merge Call completion support into trunk.
2010-04-09 15:31:32 +00:00
chanvars.h
Add additional memory debugging to several core APIs, and fix several memory
2008-10-14 22:38:06 +00:00
cli.h
DTMF events are now published on a channel's stasis_topic. AMI was
2013-04-15 16:22:03 +00:00
compat.h
Add builtin roundf() for systems lacking it.
2013-01-19 20:54:07 +00:00
compiler.h
Merged revisions 285336 via svnmerge from
2010-09-07 19:38:55 +00:00
config_options.h
Update config framework/sorcery with types/options without documentation
2013-08-23 15:21:40 +00:00
config.h
Add support for a realtime sorcery module.
2013-04-27 12:01:29 +00:00
core_local.h
Create Local channel messages on the Stasis message bus and produce AMI events
2013-07-08 14:26:40 +00:00
core_unreal.h
Massively clean up app_queue.
2013-08-22 18:52:41 +00:00
crypto.h
Clean up doxygen warnings
2012-08-30 14:23:28 +00:00
data.h
Asterisk media architecture conversion - no more format bitfields
2011-02-03 16:22:10 +00:00
datastore.h
Clean up doxygen warnings
2012-08-30 14:23:28 +00:00
devicestate.h
Strip down the old event system
2013-08-17 14:39:27 +00:00
dial.h
Add dial events to app_queue and app_followme.
2013-05-22 18:11:57 +00:00
dlinkedlists.h
Doubly linked lists unit test and update to implementation.
2011-12-06 19:09:56 +00:00
dns.h
…
dnsmgr.h
Re-link peers by IP when dnsmgr changes the IP
2012-01-30 23:58:51 +00:00
doxyref.h
Doxygen Updates - Title update
2012-10-18 14:17:40 +00:00
dsp.h
Improve T.38 gateway V.21 preamble detection.
2011-12-28 18:59:16 +00:00
dundi.h
incorporates r159808 from branches/1.4:
2008-11-29 17:57:39 +00:00
endian.h
only include this for OpenBSD. At least FreeBSD is borked when including it
2008-10-09 17:48:53 +00:00
endpoints.h
Initial support for endpoints.
2013-05-08 13:39:08 +00:00
enum.h
Add Doxygen documentation for API changes from 1.6.0 to 1.6.1
2009-03-09 20:58:17 +00:00
event_defs.h
Refactor CEL to avoid using the event system core
2013-08-17 14:46:44 +00:00
event.h
Refactor CEL to avoid using the event system core
2013-08-17 14:46:44 +00:00
extconf.h
Merged revisions 328329 via svnmerge from
2011-07-15 00:23:14 +00:00
features_config.h
Make DTMF attended transfer support feature-complete.
2013-07-23 15:28:11 +00:00
features.h
Massively clean up app_queue.
2013-08-22 18:52:41 +00:00
file.h
ARI - channel recording support
2013-07-03 17:58:45 +00:00
format_cap.h
Fixup some bridge and format capabilities comments and whitespace.
2013-03-04 21:15:36 +00:00
format_pref.h
Clean up doxygen warnings
2012-08-30 14:23:28 +00:00
format.h
Index installed sounds and implement ARI sounds queries
2013-06-24 13:49:20 +00:00
frame_defs.h
Asterisk media architecture conversion - no more format bitfields
2011-02-03 16:22:10 +00:00
frame.h
Set 14400 as the default max bit rate if T38MaxBitRate is not specified
2013-08-21 16:31:58 +00:00
framehook.h
bridge_native_rtp: Fix native bridge tech being incompatible when it should be.
2013-06-11 22:21:36 +00:00
fskmodem_float.h
Optionally build integer-based routines for FSK tone decoding (but default
2008-07-21 20:59:03 +00:00
fskmodem_int.h
Optionally build integer-based routines for FSK tone decoding (but default
2008-07-21 20:59:03 +00:00
fskmodem.h
(Step 2 of 2)
2008-07-21 21:00:47 +00:00
global_datastores.h
Add SRTP support for Asterisk
2010-06-08 05:29:08 +00:00
hashtab.h
Merged revisions 376341,376344-376345 via svnmerge from
2012-11-16 00:19:48 +00:00
heap.h
Clean up doxygen warnings
2012-08-30 14:23:28 +00:00
http_websocket.h
Allow WebSocket connections on more URL's
2013-04-18 17:30:28 +00:00
http.h
Shuffle RESTful URL's around.
2013-07-03 16:32:00 +00:00
image.h
Asterisk media architecture conversion - no more format bitfields
2011-02-03 16:22:10 +00:00
indications.h
Audit of ao2_iterator_init() usage for v1.8.
2012-01-27 18:47:16 +00:00
inline_api.h
Add development flag to disable the inline API.
2013-05-08 21:01:33 +00:00
io.h
Merged revisions 182810 via svnmerge from
2009-03-18 02:28:55 +00:00
jabber.h
Doxygen Updates - janitor work
2012-09-21 17:14:59 +00:00
jingle.h
Merged revisions 327682 via svnmerge from
2011-07-11 19:49:35 +00:00
json.h
Address JSON thread safety issues.
2013-08-02 14:27:35 +00:00
linkedlists.h
Merged revisions 376630 via svnmerge from
2012-11-27 18:20:18 +00:00
localtime.h
Stasis application WebSocket support
2013-04-08 13:27:45 +00:00
lock.h
Fix deadlocks in chan_sip in REFER and BYE handling
2013-08-15 12:12:26 +00:00
logger.h
ARI: Bridge Playback, Bridge Record
2013-07-19 19:35:21 +00:00
manager.h
Make bridge snapshots use prefixes.
2013-08-08 19:16:33 +00:00
md5.h
Ensure alignment of in[] field in MD5Context struct.
2012-08-29 22:48:08 +00:00
media_index.h
Index installed sounds and implement ARI sounds queries
2013-06-24 13:49:20 +00:00
message.h
Clean up doxygen warnings
2012-08-30 14:23:28 +00:00
mixmonitor.h
bridge_features: Support One touch Monitor/MixMonitor
2013-07-01 16:01:24 +00:00
mod_format.h
Asterisk media architecture conversion - no more format bitfields
2011-02-03 16:22:10 +00:00
module.h
Break res_stasis into smaller files.
2013-05-14 21:45:08 +00:00
monitor.h
Redesigned 'optional API' support.
2009-06-15 16:07:23 +00:00
musiconhold.h
Update MOH start/stop routine doxygen.
2013-08-22 21:29:16 +00:00
netsock2.h
Stasis: Update security events to use Stasis
2013-05-17 17:36:10 +00:00
netsock.h
Convert netsock.h over to use ast_sockaddrs rather than sockaddr_in and update
2012-02-27 16:31:24 +00:00
network.h
Get default entity ID determination working on Linux again
2008-06-12 17:38:27 +00:00
optional_api.h
Address OpenSSL initialization issues when using third-party libraries.
2012-01-30 21:21:16 +00:00
options.h
Fix res_ari_asterisk load issue
2013-08-05 14:35:00 +00:00
parking.h
Allow res_parking to be unloadable
2013-08-17 15:01:54 +00:00
paths.h
ARI - channel recording support
2013-07-03 17:58:45 +00:00
pbx.h
Prevent crash during synchronous AMI origination by ref bumping returned channel
2013-07-01 21:24:20 +00:00
pickup.h
Make sure that pickup.h does not use an include guard name used elsewhere.
2013-08-02 13:54:31 +00:00
pktccops.h
Add PacketCable NCS 1.0 support for Docsis/Eurodocsis networks
2009-11-02 22:29:19 +00:00
plc.h
…
poll-compat.h
Merged revisions 284597 via svnmerge from
2010-09-02 05:02:54 +00:00
presencestate.h
Split caching out from the stasis_caching_topic.
2013-08-01 13:49:34 +00:00
privacy.h
…
pval.h
Merged revisions 271399 via svnmerge from
2010-06-18 21:32:09 +00:00
res_fax.h
Improve T.38 gateway V.21 preamble detection.
2011-12-28 18:59:16 +00:00
res_odbc.h
Doxygen Updates - janitor work
2012-09-21 17:14:59 +00:00
res_pjsip_exten_state.h
Fix remnants of the pjsip renaming
2013-07-31 13:31:55 +00:00
res_pjsip_pubsub.h
Handle default body types for SIP event packages in res_pjsip_pubsub
2013-08-22 17:42:37 +00:00
res_pjsip_session.h
Fix remnants of the pjsip renaming
2013-07-31 13:31:55 +00:00
res_pjsip.h
Localize and rename ACL configuration.
2013-08-20 21:01:59 +00:00
res_srtp.h
Allow SRTP policies to be reloaded
2012-02-24 15:10:35 +00:00
rtp_engine.h
Refactor RTCP events over to Stasis; associate with channels
2013-07-05 17:33:33 +00:00
say.h
Add SayAlphaCase and similar functionality for AGI
2013-08-22 22:33:48 +00:00
sched.h
ast_channel opaquification of pointers and integral types
2012-02-20 23:43:27 +00:00
sdp_srtp.h
Merge in current pimp_my_sip work, including:
2013-06-22 14:03:22 +00:00
security_events_defs.h
Strip down the old event system
2013-08-17 14:39:27 +00:00
security_events.h
Avoid unnecessary cleanups during immediate shutdown
2013-05-30 17:05:53 +00:00
select.h
Merged revisions 315503 via svnmerge from
2011-04-26 19:38:41 +00:00
sha1.h
Update SHA1 code to RFC 6234
2011-10-11 19:06:29 +00:00
silk.h
Media Project Phase2: SILK 8khz-24khz, SLINEAR 8khz-192khz, SPEEX 32khz, hd audio ConfBridge, and other stuff
2011-02-22 23:04:49 +00:00
sip_api.h
Don't make chan_sip export global symbols.
2012-10-11 15:49:02 +00:00
slin.h
Asterisk media architecture conversion - no more format bitfields
2011-02-03 16:22:10 +00:00
slinfactory.h
Media Project Phase2: SILK 8khz-24khz, SLINEAR 8khz-192khz, SPEEX 32khz, hd audio ConfBridge, and other stuff
2011-02-22 23:04:49 +00:00
smdi.h
Doxygen Updates - Title update
2012-10-18 14:17:40 +00:00
sorcery.h
Update config framework/sorcery with types/options without documentation
2013-08-23 15:21:40 +00:00
sounds_index.h
Index installed sounds and implement ARI sounds queries
2013-06-24 13:49:20 +00:00
speech.h
Add support for retrieving engine specific settings using the speech API and from dialplan.
2012-10-01 12:29:04 +00:00
srv.h
Doxygen - Markup Guidelines
2013-04-22 16:22:00 +00:00
stasis_app_impl.h
ARI: allow other operations to happen while bridged
2013-08-13 15:27:32 +00:00
stasis_app_playback.h
ARI: Bridge Playback, Bridge Record
2013-07-19 19:35:21 +00:00
stasis_app_recording.h
ARI: Add recording controls
2013-08-06 14:44:45 +00:00
stasis_app.h
ARI: Music on Hold/Background Music for bridges
2013-08-23 00:26:19 +00:00
stasis_bridges.h
Make a couple of changes to help AMI events to be more clear in what is occurring.
2013-08-02 14:13:04 +00:00
stasis_cache_pattern.h
Split caching out from the stasis_caching_topic.
2013-08-01 13:49:34 +00:00
stasis_channels.h
Split caching out from the stasis_caching_topic.
2013-08-01 13:49:34 +00:00
stasis_endpoints.h
Split caching out from the stasis_caching_topic.
2013-08-01 13:49:34 +00:00
stasis_internal.h
Update Asterisk's CDRs for the new bridging framework
2013-06-17 03:00:38 +00:00
stasis_message_router.h
Fix bridge/channel AMI event ordering issues
2013-07-23 13:39:50 +00:00
stasis_system.h
Convert CCSS manager events to stasis.
2013-07-19 18:00:35 +00:00
stasis_test.h
Initial support for endpoints.
2013-05-08 13:39:08 +00:00
stasis.h
Tweak caching topics to fix CEL tests
2013-08-06 14:28:23 +00:00
statsd.h
Example of how to use the Stasis message bus
2013-04-26 20:05:15 +00:00
stringfields.h
Add aggregate operations for stuctures with string fields
2013-02-07 15:16:44 +00:00
strings.h
Move ast_str_container_alloc and friends
2013-08-02 14:08:34 +00:00
stun.h
Re-resolve the STUN address if a STUN poll fails for res_stun_monitor.
2011-12-01 21:19:41 +00:00
syslog.h
Change all refererences to 1.6.3 to be 1.8, since that will be the next feature release
2009-12-21 18:51:17 +00:00
taskprocessor.h
Address David's latest feedback on reviewboard:
2013-01-17 16:04:10 +00:00
tcptls.h
Do not use a FILE handle when doing SIP TCP reads.
2012-10-12 16:31:01 +00:00
tdd.h
…
term.h
Revamp of terminal color codes
2013-02-14 18:47:56 +00:00
test.h
Update Asterisk's CDRs for the new bridging framework
2013-06-17 03:00:38 +00:00
threadpool.h
Merge the pimp_my_sip branch into trunk.
2013-04-25 18:25:31 +00:00
threadstorage.h
Fix some doxygen warnings.
2010-06-08 14:38:18 +00:00
time.h
Update Asterisk's CDRs for the new bridging framework
2013-06-17 03:00:38 +00:00
timing.h
Refactor ast_timer_ack to return an error and handle the error in timer users
2012-11-05 23:10:14 +00:00
transcap.h
Doxygen updates, formatting.
2007-12-11 22:20:22 +00:00
translate.h
Clean up doxygen warnings
2012-08-30 14:23:28 +00:00
udptl.h
Doxygen Updates - Title update
2012-10-18 14:17:40 +00:00
ulaw.h
Doxygen updates, formatting.
2007-12-11 22:20:22 +00:00
unaligned.h
Merged revisions 282543 via svnmerge from
2010-08-17 19:34:52 +00:00
utils.h
utils.h: Minor formatting tweaks.
2013-08-16 16:22:26 +00:00
uuid.h
Add uuid wrapper API call ast_uuid_generate_str().
2013-03-28 23:59:20 +00:00
version.h
Remove "asterisk/version.h" in favor of "asterisk/ast_version.h".
2012-01-25 21:31:28 +00:00
xml.h
Add CLI configuration documentation
2013-02-15 13:38:12 +00:00
xmldoc.h
Add CLI configuration documentation
2013-02-15 13:38:12 +00:00
xmpp.h
Move device state distribution to Stasis-core
2013-04-16 15:33:59 +00:00