kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2026-07-23 07:54:50 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add "Provided-by" to doc XML and CLI output.

Browse Source 
For application, function, manager, managerEvent, managerEventInstance
and info XML documentation nodes, the make_xml_documentation script will
add a "module" attribute if not already present.  For XML in separate
"*_doc.xml" files, the script figures out the correct module name.  For
documentation in the "main" directory, the module name is set to "builtin".

The CLI handlers for "core show application", "core show function",
"manager show command" and "manager show event", have been updated to
show the following after the Synopsis...

```
[Provided By]
<modulename>
```

For modules that provide additional "info" elements (like the technologies
do for Dial), the providing module has also been added.

```
Technology: WebSocket  Provided by: chan_websocket
WebSocket Dial Strings:
...
```

UserNote: The CLI help for applications, functions, manager commands and
manager events now shows the module that provides its functionality.
This commit is contained in:
George Joseph
2026-02-24 14:32:45 -07:00
parent 3b06ed1563
commit 00c4346307
9 changed files with 177 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/appdocsxml.dtd
+2
View File
@@ -64,6 +64,7 @@
<!ELEMENT managerEventInstance (since?,synopsis?,syntax?,description?,see-also?)*>
<!ATTLIST managerEventInstance class CDATA #REQUIRED>
<!ATTLIST managerEventInstance module CDATA #IMPLIED>
<!ELEMENT configInfo (synopsis?,description?,configFile+)>
<!ATTLIST configInfo name CDATA #REQUIRED>
@@ -95,6 +96,7 @@
<!ATTLIST info name CDATA #REQUIRED>
<!ATTLIST info language CDATA #REQUIRED>
<!ATTLIST info tech CDATA #REQUIRED>
<!ATTLIST info module CDATA #IMPLIED>
<!ELEMENT see-also (ref|xi:include)*>