[asterisk-dev] [Code Review] 3807: xmldoc: Add support for an <example> tag in the Asterisk XML documentation
Matt Jordan
reviewboard at asterisk.org
Thu Jul 24 09:48:58 CDT 2014
> On July 16, 2014, 2:13 p.m., Paul Belanger wrote:
> > /trunk/funcs/func_jitterbuffer.c, lines 69-76
> > <https://reviewboard.asterisk.org/r/3807/diff/1/?file=64535#file64535line69>
> >
> > Your priority values for each extension is not consistent. 5 are exten => 1,1 and 1 is exten => 1,n.
These are really all individual examples. I'll break them up accordingly.
- Matt
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/3807/#review12697
-----------------------------------------------------------
On July 16, 2014, 11:58 a.m., Matt Jordan wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/3807/
> -----------------------------------------------------------
>
> (Updated July 16, 2014, 11:58 a.m.)
>
>
> Review request for Asterisk Developers.
>
>
> Repository: Asterisk
>
>
> Description
> -------
>
> This patch adds support for an <example /> tag in the XML documentation schema.
>
> For CLI help, this doesn't change the formatting too much:
> - Preceeding white space is removed
> - Unlike with para elements, new lines are preserved
>
> However, having an <example /> tag in the XML schema allows for the wiki documentation generation script to surround the documentation with {code} or {noformat} tags, generating much better content for the wiki - and allowing us to put dialplan examples (and other code snippets, if desired) into the documentation for an application/function/AMI command/etc.
>
>
> Diffs
> -----
>
> /trunk/main/xmldoc.c 418779
> /trunk/funcs/func_jitterbuffer.c 418779
> /trunk/doc/appdocsxml.dtd 418779
>
> Diff: https://reviewboard.asterisk.org/r/3807/diff/
>
>
> Testing
> -------
>
> Updated the JITTERBUFFER function. It now displays its dialplan examples in a single example block in the CLI help.
>
>
> Thanks,
>
> Matt Jordan
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20140724/67706d74/attachment.html>
More information about the asterisk-dev
mailing list