xmldocs: Add support for an <example> tag in the Asterisk XML Documentation
authorMatthew Jordan <mjordan@digium.com>
Thu, 31 Jul 2014 11:49:40 +0000 (11:49 +0000)
committerMatthew Jordan <mjordan@digium.com>
Thu, 31 Jul 2014 11:49:40 +0000 (11:49 +0000)
commit922e3203a9303acbc95a334793a41e07e3f4772d
tree6c2ecda7896b61b79b9bbcb6b3e1cd0692e93ab6
parent485d0379aeac18563f2fd3b3fee8516e32f16675
xmldocs: Add support for an <example> tag in the Asterisk XML Documentation

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.

Review: https://reviewboard.asterisk.org/r/3807/

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@419822 65c4cc65-6c06-0410-ace0-fbb531ad65f3
doc/appdocsxml.dtd
funcs/func_jitterbuffer.c
main/xmldoc.c