diff options
| author | Matthew Jordan <mjordan@digium.com> | 2014-07-31 11:49:40 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2014-07-31 11:49:40 +0000 |
| commit | 922e3203a9303acbc95a334793a41e07e3f4772d (patch) | |
| tree | 6c2ecda7896b61b79b9bbcb6b3e1cd0692e93ab6 /funcs | |
| parent | 485d0379aeac18563f2fd3b3fee8516e32f16675 (diff) | |
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
Diffstat (limited to 'funcs')
| -rw-r--r-- | funcs/func_jitterbuffer.c | 26 |
1 files changed, 19 insertions, 7 deletions
diff --git a/funcs/func_jitterbuffer.c b/funcs/func_jitterbuffer.c index 31ab86ce3..0b57caf6e 100644 --- a/funcs/func_jitterbuffer.c +++ b/funcs/func_jitterbuffer.c @@ -66,13 +66,25 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>target_extra: Defaults to 40ms</para> <para>This option only affects the adaptive jitterbuffer. It represents the amount time in milliseconds by which the new jitter buffer will pad its size.</para> <para> </para> - <para>Examples:</para> - <para>exten => 1,1,Set(JITTERBUFFER(fixed)=default);Fixed with defaults. </para> - <para>exten => 1,1,Set(JITTERBUFFER(fixed)=200);Fixed with max size 200ms, default resync threshold and target extra. </para> - <para>exten => 1,1,Set(JITTERBUFFER(fixed)=200,1500);Fixed with max size 200ms resync threshold 1500. </para> - <para>exten => 1,1,Set(JITTERBUFFER(adaptive)=default);Adaptive with defaults. </para> - <para>exten => 1,1,Set(JITTERBUFFER(adaptive)=200,,60);Adaptive with max size 200ms, default resync threshold and 40ms target extra. </para> - <para>exten => 1,n,Set(JITTERBUFFER(disabled)=);Remove previously applied jitterbuffer </para> + <example title="Fixed with defaults" language="text"> + exten => 1,1,Set(JITTERBUFFER(fixed)=default) + </example> + <example title="Fixed with 200ms max size" language="text"> + exten => 1,1,Set(JITTERBUFFER(fixed)=200) + </example> + <example title="Fixed with 200ms max size, resync threshold 1500" language="text"> + exten => 1,1,Set(JITTERBUFFER(fixed)=200,1500) + </example> + <example title="Adaptive with defaults" language="text"> + exten => 1,1,Set(JITTERBUFFER(adaptive)=default) + </example> + <example title="Adaptive with 200ms max size, 60ms target extra" language="text"> + exten => 1,1,Set(JITTERBUFFER(adaptive)=200,,60) + </example> + <example title="Set a fixed jitterbuffer with defaults; then remove it" language="text"> + exten => 1,1,Set(JITTERBUFFER(fixed)=default) + exten => 1,n,Set(JITTERBUFFER(disabled)=) + </example> <note><para>If a channel specifies a jitterbuffer due to channel driver configuration and the JITTERBUFFER function has set a jitterbuffer for that channel, the jitterbuffer set by the JITTERBUFFER function will take priority and the jitterbuffer set by the channel |