[ASTERISK-4] XML documentation examples

DOCS-1

Kickstart the wiki

ASTERISK-9

indications: Add support for >2 frequencies

INTERLINKED-6

PhreakNet Forums

ASTERISK-7

Improve sound control capabilities

PHREAKNET-11

Yealink T33G: add provisioning support

PHREAKNET-10

Enhanced utilization of Feature Group D

ASTERISK-11

chan_dahdi: Add wink guard

ASTERISK-10

Proctor application for DAHDI

PHREAKNET-9

General WKSHWIAXCG0 enhancements

PHREAKNET-8

Setup a Patreon to cover expenses

INTERLINKED-5

Update blue box

PHREAKSCRIPT-10

Update CiscoCallManager patch URL

ASTERISK-8

Optimize boilerplate RSA to MD5 fallback

INTERLINKED-4

InterLinked Issues API

PHREAKNET-7

Subscriber Service Disconnect Request Option

INTERLINKED-3

InterLinked API site is down

PHREAKNET-6

Verification flags international calls

ASTERISK-4

XML documentation examples

INTERLINKED-2

PhreakNet Email for BoD Members

PHREAKSCRIPT-8

Boilerplate force MD5 broken

ASTERISK-6

Resonant Filter To Simulate N-Carrier

PHREAKNET-3

Provide commissions to 976 number owners

PHREAKSCRIPT-9

Add DAHDI to build tests

PHREAKSCRIPT-7

Boilerplate musiconhold.conf is wrong

PHREAKSCRIPT-6

Trace autosend

INTERLINKED-1

Phone verification is broken

PHREAKSCRIPT-5

coindsp patch missing

PHREAKNET-5

Semipublic inward boilerplate broken

PHREAKSCRIPT-4

Add less invasive/deterministic modes

PHREAKNET-4

Hosted lines defaults exchange on error

PHREAKNET-2

Asterisk reload following unsuccessful call

PHREAKSCRIPT-3

Report failure as requested

ASTERISK-5

Various ADSI issues

PHREAKNET-1

Add third-party billing integration

ASTERISK-3

Asterisk Wiki issues

PHREAKSCRIPT-2

Remove absolute sbin path

PHREAKSCRIPT-1

Hangs when certain invalid commands entered

ASTERISK-2

func_notchfilter: ISO C90 compiler fixes

ASTERISK-1

Add Assert application

← Issues Home || New Issue →

Sort Normal || Priority

Details

Category: Asterisk
Type: Improvement
Severity: Minor
Visibility: Public
Reported: 12/24/2021 2:58 PM
Last Active: 5/31/2022 4:15 PM
Status: Resolved 6/1/2022 9:12 AM
Reporter: InterLinked
Watching: InterLinked
Assigned To: Nobody

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

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 logged in to leave a comment.