[ASTERISK-4] XML documentation examples
Some Asterisk modules contain examples in the XML documentation that aren't formatted as examples.
Most of these were addressed in ASTERISK-29777 with review 17586
A few things slipped through the cracks. Documenting here until such time as appropriate to open a new JIRA issue and pack these into a review.
Examples
- https://asterisk.phreaknet.org/#function-VERSION
- https://wiki.asterisk.org/wiki/display/AST/Asterisk+18+Function_DIALGROUP
- https://github.com/asterisk/asterisk/blob/b4347c486150653ec7ce1d129e8f9017c69344da/funcs/func_rand.c#L52
- https://asterisk.phreaknet.org/#function-FRAME_DROP
- https://asterisk.phreaknet.org/#application-WaitForSilence
- https://wiki.asterisk.org/wiki/display/AST/Asterisk+18+Function_KEYPADHASH
- https://wiki.asterisk.org/wiki/display/AST/Asterisk+18+Function_CONFBRIDGE
- https://wiki.asterisk.org/wiki/display/AST/Asterisk+18+Function_PJSIP_HEADER
- https://github.com/asterisk/asterisk/blob/b4347c486150653ec7ce1d129e8f9017c69344da/res/res_mutestream.c#L72
Should these really all be a single example? Multiple separate one seems more appropriate: https://wiki.asterisk.org/wiki/display/AST/Asterisk+18+Function_CHANNEL
There are probably more than these, so as they surface, add them to the list here and we'll do them all at once.
Additionally, https://wiki.asterisk.org/wiki/display/AST/Asterisk+18+Application_PauseQueueMember was fixed in the aforementioned review, but the formatting looks wonky. Double-check this as well.
Additionally, there is a spelling error here: https://github.com/asterisk/asterisk/blob/master/apps/app_playback.c#L76
Another spelling error here: https://asterisk.phreaknet.org/#function-IF
Also, add an example! Third-party docs e.g. https://www.voip-info.org/asterisk-func-if/ shouldn't be more descriptive than the official one...
Additionally, something is really messed up here: https://github.com/asterisk/asterisk/blob/master/res/res_agi.c#L797
The parameter has no name, which causes astdocgen to crash, but there seem to be other things wrong with this, too. This is related to: https://issues.asterisk.org/jira/browse/ASTERISK-28891
Also document VOLUME = 0, negative, and positive for func_volume.
Comments
You must be