[asterisk-dev] [Code Review] 3807: xmldoc: Add support for an <example> tag in the Asterisk XML documentation

[Matt Jordan]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/3807/
-----------------------------------------------------------

(Updated July 27, 2014, 9:28 p.m.)


Review request for Asterisk Developers.


Changes
-------

Addressed findings.


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 (updated)
-----

  /trunk/main/xmldoc.c 419680 
  /trunk/funcs/func_jitterbuffer.c 419680 
  /trunk/doc/appdocsxml.dtd 419680 

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/20140728/80a4e85d/attachment-0001.html>