kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2026-05-25 16:30:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
bef2dd5ce6806ee0d93fd317ac1b3bb7a055c51f
asterisk/include/asterisk
History
George Joseph 2b428734fd docs: Enable since/version handling for XML, CLI and ARI documentation 
* Added the "since" element to the XML configObject and configOption elements
  in appdocsxml.dtd.

* Added the "Since" section to the following CLI output:
  ```
  config show help <module> <object>
  config show help <module> <object> <option>
  core show application <app>
  core show function <func>
  manager show command <command>
  manager show event <event>
  agi show commands topic <topic>
  ```

* Refactored the commands above to output their sections in the same order:
  Synopsis, Since, Description, Syntax, Arguments, SeeAlso

* Refactored the commands above so they all use the same pattern for writing
  the output to the CLI.

* Fixed several memory leaks caused by failure to free temporary output
  buffers.

* Added a "since" array to the mustache template for the top-level resources
  (Channel, Endpoint, etc.) and to the paths/methods underneath them. These
  will be added to the generated markdown if present.
  Example:
  ```
    "resourcePath": "/api-docs/channels.{format}",
    "requiresModules": [
        "res_stasis_answer",
        "res_stasis_playback",
        "res_stasis_recording",
        "res_stasis_snoop"
    ],
    "since": [
        "18.0.0",
        "21.0.0"
    ],
    "apis": [
        {
            "path": "/channels",
            "description": "Active channels",
            "operations": [
                {
                    "httpMethod": "GET",
                    "since": [
                        "18.6.0",
                        "21.8.0"
                    ],
                    "summary": "List all active channels in Asterisk.",
                    "nickname": "list",
                    "responseClass": "List[Channel]"
                },

  ```

NOTE:  No versioning information is actually added in this commit.
Those will be added separately and instructions for adding and maintaining
them will be published on the documentation site at a later date.

(cherry picked from commit 3c867e6e6c)
2025-01-23 18:42:28 +00:00
..
doxygen
res_monitor: Remove deprecated module.
2023-01-13 08:32:33 -06:00
_private.h
core/ari/pjsip: Add refer mechanism
2023-08-09 15:10:46 +00:00
.gitignore
…
abstract_jb.h
include: Spelling fixes
2021-11-16 05:59:44 -06:00
acl.h
dnsmgr.c: dnsmgr_refresh() incorrectly flags change with DNS round-robin
2024-11-14 20:02:03 +00:00
adsi.h
progdocs: Fix grouping for latest Doxygen.
2021-12-02 10:26:08 -06:00
ael_structs.h
…
agi.h
docs: Enable since/version handling for XML, CLI and ARI documentation
2025-01-23 18:42:28 +00:00
alaw.h
…
alertpipe.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
aoc.h
include: Spelling fixes
2021-11-16 05:59:44 -06:00
app.h
res_agi.c: Ensure SIGCHLD handler functions are properly balanced.
2024-11-14 20:02:03 +00:00
ari.h
res_ari: Fix for Doxygen.
2021-11-18 16:25:51 -06:00
ast_expr.h
…
ast_version.h
make_buildopts_h, et. al. Allow adding all cflags to buildopts.h
2023-09-14 17:58:24 +00:00
astdb.h
Stir/Shaken Refactor
2024-02-28 18:39:03 +00:00
astmm.h
Header fixes for compiling C++ source files
2025-01-23 18:42:28 +00:00
astobj2.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
audiohook.h
res_mixmonitor: MixMonitorMute by MixMonitor ID
2023-03-20 09:29:23 -05:00
autochan.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
autoconfig.h.in
Add SHA-256 and SHA-512-256 as authentication digest algorithms
2025-01-23 18:42:28 +00:00
backtrace.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
beep.h
…
bridge_after.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
bridge_basic.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
bridge_channel_internal.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
bridge_channel.h
bridge_channel: Fix for Doxygen.
2021-11-18 09:20:52 -06:00
bridge_features.h
res_monitor: Remove deprecated module.
2023-01-13 08:32:33 -06:00
bridge_internal.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
bridge_roles.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
bridge_technology.h
…
bridge.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
bucket.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
buildinfo.h
…
calendar.h
res: Fix for Doxygen.
2021-12-03 10:38:39 -06:00
callerid.h
callerid.c: Parse previously ignored Caller ID parameters.
2024-04-22 12:02:44 +00:00
causes.h
progdocs: Fix grouping for latest Doxygen.
2021-12-02 10:26:08 -06:00
ccss.h
app_macro: Remove deprecated module.
2023-01-10 14:07:44 -06:00
cdr.h
channel: Add multi-tenant identifier.
2024-08-12 15:21:35 +00:00
cel.h
channel: Add multi-tenant identifier.
2024-08-12 15:21:35 +00:00
celt.h
…
channel_internal.h
channel: Add multi-tenant identifier.
2024-08-12 15:21:35 +00:00
channel.h
channel: Add multi-tenant identifier.
2024-08-12 15:21:35 +00:00
channelstate.h
chan_dahdi: Fix wrong channel state when RINGING recieved.
2025-01-23 18:42:28 +00:00
chanvars.h
…
cli.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
codec.h
translate.c: Prefer better codecs upon translate ties.
2022-11-08 09:15:55 -06:00
compat.h
…
compiler.h
…
config_options.h
chan_sip: Remove deprecated module.
2023-01-03 09:00:42 -06:00
config.h
Geolocation: Base Asterisk Prereqs
2022-07-07 08:19:14 -05:00
conversions.h
progdocs: Fix Doxygen left-overs.
2021-12-13 08:57:26 -06:00
core_local.h
progdocs: Fix Doxygen left-overs.
2021-12-13 08:57:26 -06:00
core_unreal.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
crypto.h
doxygen: Fix doxygen errors.
2023-01-31 11:23:11 -06:00
data_buffer.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
datastore.h
progdocs: Fix for Doxygen, the hidden parts.
2021-12-02 10:37:38 -06:00
devicestate.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
dial.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
dlinkedlists.h
progdocs: Avoid 'name' with Doxygen \file.
2021-11-18 08:17:56 -06:00
dns_core.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
dns_internal.h
dns_txt: Add TXT record parsing support
2020-03-13 09:58:59 -05:00
dns_naptr.h
…
dns_query_set.h
…
dns_recurring.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
dns_resolver.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
dns_srv.h
…
dns_test.h
…
dns_tlsa.h
…
dns_txt.h
dns_txt: Add TXT record parsing support
2020-03-13 09:58:59 -05:00
dns.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
dnsmgr.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
doxyref.h
core: Cleanup gerrit and JIRA references. (#58)
2023-05-03 09:37:57 -06:00
dsp.h
res_tonedetect: Tone detection module
2021-09-10 11:08:11 -05:00
dundi.h
pbx_dundi: Add PJSIP support.
2023-04-10 14:38:51 -05:00
endian.h
…
endpoints.h
progdocs: Fix Doxygen left-overs.
2021-12-13 08:57:26 -06:00
enum.h
progdocs: Avoid 'name' with Doxygen \file.
2021-11-18 08:17:56 -06:00
event_defs.h
channel: Add multi-tenant identifier.
2024-08-12 15:21:35 +00:00
event.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
extconf.h
app_macro: Remove deprecated module.
2023-01-10 14:07:44 -06:00
features_config.h
res_monitor: Remove deprecated module.
2023-01-13 08:32:33 -06:00
features.h
…
file.h
file.h: Rename function argument to avoid C++ keyword clash.
2024-06-05 18:09:58 +00:00
format_cache.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
format_cap.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
format_compatibility.h
codecs: Remove test-law.
2021-01-04 05:00:58 -06:00
format.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
frame.h
func_channel: Expose previously unsettable options.
2023-11-28 19:54:04 +00:00
framehook.h
frame: Fix for Doxygen.
2021-11-18 16:13:18 -06:00
fskmodem_float.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
fskmodem_int.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
fskmodem.h
…
global_datastores.h
…
hashtab.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
heap.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
http_websocket.h
res_http_websocket: Add a client connection timeout
2022-01-31 07:18:51 -06:00
http.h
http.c: Add ability to create multiple HTTP servers
2021-12-15 09:58:27 -06:00
ilbc.h
…
image.h
progdocs: Fix Doxygen left-overs.
2021-12-13 08:57:26 -06:00
indications.h
…
inline_api.h
…
io.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
iostream.h
tcptls/iostream: Add support for setting SNI on client TLS connections
2024-04-29 13:24:07 +00:00
json.h
func_json: Fix crashes for some types
2023-10-05 14:38:05 +00:00
linkedlists.h
progdocs: Avoid 'name' with Doxygen \file.
2021-11-18 08:17:56 -06:00
localtime.h
…
lock.h
Header fixes for compiling C++ source files
2025-01-23 18:42:28 +00:00
logger_category.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
logger.h
logger.h: Fix build when AST_DEVMODE is not defined.
2025-01-23 18:42:28 +00:00
manager.h
docs: Enable since/version handling for XML, CLI and ARI documentation
2025-01-23 18:42:28 +00:00
max_forwards.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
md5.h
…
media_cache.h
…
media_index.h
media_index.c: Refactored so it doesn't cache the index
2019-01-28 12:26:58 -07:00
message.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
mixmonitor.h
various files - fix some alerts raised by lgtm code analysis
2019-11-18 08:30:45 -06:00
mod_format.h
include: Spelling fixes
2021-11-16 05:59:44 -06:00
module.h
loader.c: Allow dependent modules to be unloaded recursively.
2024-04-30 14:14:17 +00:00
multicast_rtp.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
musiconhold.h
…
mwi.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
named_locks.h
…
netsock2.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
network.h
…
optional_api.h
…
options.h
file.c: Add ability to search custom dir for sounds
2023-09-20 19:15:07 +00:00
opus.h
…
parking.h
chan_skinny: Remove deprecated module.
2022-12-08 08:07:12 -06:00
paths.h
Introduce astcachedir, to be used for temporary bucket files
2020-12-09 11:17:27 -06:00
pbx.h
docs: Enable since/version handling for XML, CLI and ARI documentation
2025-01-23 18:42:28 +00:00
phoneprov.h
res: Fix for Doxygen.
2021-12-03 10:38:39 -06:00
pickup.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
plc.h
include: Spelling fixes
2021-11-16 05:59:44 -06:00
poll-compat.h
…
presencestate.h
…
privacy.h
include: Spelling fixes
2021-11-16 05:59:44 -06:00
pval.h
…
refer.h
core/ari/pjsip: Add refer mechanism
2023-08-09 15:10:46 +00:00
res_aeap_message.h
doxygen: Fix doxygen errors.
2023-01-31 11:23:11 -06:00
res_aeap.h
doxygen: Fix doxygen errors.
2023-01-31 11:23:11 -06:00
res_audiosocket.h
feat: AudioSocket channel, application, and ARI support.
2020-01-14 09:36:44 -06:00
res_fax.h
res_fax: wrap v21 detected Asterisk initiated negotiation with config option
2019-12-13 14:24:10 -06:00
res_geolocation.h
doxygen: Fix doxygen errors.
2023-01-31 11:23:11 -06:00
res_hep.h
chan_mgcp: Remove deprecated module.
2022-12-09 08:59:04 -06:00
res_mwi_external.h
res: Fix for Doxygen.
2021-12-03 10:38:39 -06:00
res_odbc_transaction.h
…
res_odbc.h
odbc: Fix for Doxygen.
2021-11-19 02:50:36 -06:00
res_pjproject.h
res_rtp_asterisk: Fix regression issues with DTLS client check
2023-12-20 14:02:33 +00:00
res_pjsip_body_generator_types.h
…
res_pjsip_cli.h
res: Fix for Doxygen.
2021-12-03 10:38:39 -06:00
res_pjsip_outbound_publish.h
…
res_pjsip_presence_xml.h
res_pjsip: Fix for Doxygen.
2021-11-18 12:14:54 -06:00
res_pjsip_pubsub.h
res_pjsip_pubsub: Add new pubsub module capabilities. (#82)
2023-05-18 11:41:38 -06:00
res_pjsip_session_caps.h
res_pjsip: Fix for Doxygen.
2021-11-18 12:14:54 -06:00
res_pjsip_session.h
Stir/Shaken Refactor
2024-02-28 18:39:03 +00:00
res_pjsip.h
Add SHA-256 and SHA-512-256 as authentication digest algorithms
2025-01-23 18:42:28 +00:00
res_prometheus.h
res: Fix for Doxygen.
2021-12-03 10:38:39 -06:00
res_srtp.h
…
res_stir_shaken.h
Stir/Shaken Refactor
2024-02-28 18:39:03 +00:00
rtp_engine.h
res_pjsip_sdp_rtp: Use negotiated DTMF Payload types on bitrate mismatch
2024-09-12 18:46:48 +00:00
say.h
include: Spelling fixes
2021-11-16 05:59:44 -06:00
sched.h
sched: fix and test a double deref on delete of an executing call back
2022-01-21 10:06:57 -06:00
sdp_srtp.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
security_events_defs.h
…
security_events.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
select.h
…
sem.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
serializer.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
sha1.h
include: Remove unimplemented HMAC declarations
2022-01-19 09:44:24 -06:00
silk.h
…
sip_api.h
…
slin.h
various files - fix some alerts raised by lgtm code analysis
2019-11-18 08:30:45 -06:00
slinfactory.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
smdi.h
…
smoother.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
sorcery.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
sounds_index.h
media_index.c: Refactored so it doesn't cache the index
2019-01-28 12:26:58 -07:00
speech.h
res_aeap & res_speech_aeap: Add Asterisk External Application Protocol
2022-04-26 14:26:48 -05:00
spinlock.h
…
srv.h
progdocs: Avoid 'name' with Doxygen \file.
2021-11-18 08:17:56 -06:00
stasis_app_device_state.h
progdocs: Fix Doxygen left-overs.
2021-12-13 08:57:26 -06:00
stasis_app_impl.h
progdocs: Fix for Doxygen, the hidden parts.
2021-12-02 10:37:38 -06:00
stasis_app_mailbox.h
progdocs: Fix for Doxygen, the hidden parts.
2021-12-02 10:37:38 -06:00
stasis_app_playback.h
stasis: Fix for Doxygen.
2021-11-18 14:46:42 -06:00
stasis_app_recording.h
stasis: Fix for Doxygen.
2021-11-18 14:46:42 -06:00
stasis_app_snoop.h
stasis: Fix for Doxygen.
2021-11-18 14:46:42 -06:00
stasis_app.h
stasis: Fix for Doxygen.
2021-11-18 14:46:42 -06:00
stasis_bridges.h
stasis: Fix for Doxygen.
2021-11-18 14:46:42 -06:00
stasis_cache_pattern.h
progdocs: Fix Doxygen left-overs.
2021-12-13 08:57:26 -06:00
stasis_channels.h
channel: Add multi-tenant identifier.
2024-08-12 15:21:35 +00:00
stasis_endpoints.h
progdocs: Fix Doxygen left-overs.
2021-12-13 08:57:26 -06:00
stasis_internal.h
progdocs: Fix Doxygen left-overs.
2021-12-13 08:57:26 -06:00
stasis_message_router.h
stasis: Fix for Doxygen.
2021-11-18 14:46:42 -06:00
stasis_state.h
stasis_state: Add new stasis_state module
2019-06-28 11:41:15 -05:00
stasis_system.h
stasis: Fix for Doxygen.
2021-11-18 14:46:42 -06:00
stasis_test.h
stasis: Fix for Doxygen.
2021-11-18 14:46:42 -06:00
stasis.h
progdocs: Fix for Doxygen, the hidden parts.
2021-12-02 10:37:38 -06:00
statsd.h
res: Fix for Doxygen.
2021-12-03 10:38:39 -06:00
stream.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
stringfields.h
GCC12: Fixes for 16+
2022-05-09 08:21:45 -05:00
strings.h
Add C++ Standard detection to configure and fix a new C++20 compile issue
2025-01-23 18:42:28 +00:00
stun.h
progdocs: Avoid 'name' with Doxygen \file.
2021-11-18 08:17:56 -06:00
syslog.h
progdocs: Avoid 'name' with Doxygen \file.
2021-11-18 08:17:56 -06:00
taskprocessor.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
tcptls.h
chan_sip: Remove deprecated module.
2023-01-03 09:00:42 -06:00
tdd.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
term.h
progdocs: Fix grouping for latest Doxygen.
2021-12-02 10:26:08 -06:00
test.h
Add ability to pass arguments to unit tests from the CLI
2025-01-23 18:42:28 +00:00
threadpool.h
progdocs: Fix Doxygen left-overs.
2021-12-13 08:57:26 -06:00
threadstorage.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
time.h
doxygen: Fix doxygen errors.
2023-01-31 11:23:11 -06:00
timing.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
transcap.h
progdocs: Fix grouping for latest Doxygen.
2021-12-02 10:26:08 -06:00
translate.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
udptl.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
ulaw.h
…
unaligned.h
…
uri.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
utf8.h
res_pjsip: Replace invalid UTF-8 sequences in callerid name
2023-03-01 09:50:02 -06:00
utils.h
utils.h: Deprecate ast_gethostbyname(). (#79)
2023-05-11 13:05:49 -06:00
uuid.h
…
vector.h
main: Fix for Doxygen.
2021-12-02 15:02:09 -06:00
version.h
…
xml.h
doxygen: Fix doxygen errors.
2023-01-31 11:23:11 -06:00
xmldoc.h
docs: Enable since/version handling for XML, CLI and ARI documentation
2025-01-23 18:42:28 +00:00
xmpp.h
…