summaryrefslogtreecommitdiff
path: root/addons
diff options
context:
space:
mode:
authorMatt Jordan <mjordan@digium.com>2016-08-12 11:15:38 -0500
committerMatt Jordan <mjordan@digium.com>2016-08-15 07:39:19 -0500
commitddab42e296a0c69ab40a2ecbe5cdcc961f6b6602 (patch)
tree64f52e2649b01500c01dea3d579dc60674573fa7 /addons
parent8b1e919ae46bdab02010a9d25c1c27670b03e87f (diff)
func_channel: Reorganize documentation
* Following the example of the PJSIP channel driver, the channel technology specific documentation has been moved to the respective channel drivers that provide that functionality. This has the benefit of locating the documentation of items with those modules that provide it. * Examples of using the CHANNEL function for both standard items as well as for PJSIP have been added. * The 'max_forwards' standard item has been documented. Change-Id: Ifaa79a232c8ac99cf8da6ef6cc7815d398b1b79b
Diffstat (limited to 'addons')
-rw-r--r--addons/chan_ooh323.c48
1 files changed, 48 insertions, 0 deletions
diff --git a/addons/chan_ooh323.c b/addons/chan_ooh323.c
index 7e50bbfa5..127ba0c8f 100644
--- a/addons/chan_ooh323.c
+++ b/addons/chan_ooh323.c
@@ -22,6 +22,54 @@
<support_level>extended</support_level>
***/
+/*** DOCUMENTATION
+<info name="OOH323CHANNEL" language="en_US" tech="OOH323">
+ <enumlist>
+ <enum name="faxdetect">
+ <para>R/W Fax Detect</para>
+ <para>Returns 0 or 1</para>
+ <para>Write yes or no</para>
+ </enum>
+ <enum name="t38support">
+ <para>R/W t38support</para>
+ <para>Returns 0 or 1</para>
+ <para>Write yes or no</para>
+ </enum>
+ <enum name="h323id_url">
+ <para>R/0 Returns caller URL</para>
+ </enum>
+ <enum name="caller_h323id">
+ <para>R/0 Returns caller h323id</para>
+ </enum>
+ <enum name="caller_dialeddigits">
+ <para>R/0 Returns caller dialed digits</para>
+ </enum>
+ <enum name="caller_email">
+ <para>R/0 Returns caller email</para>
+ </enum>
+ <enum name="callee_email">
+ <para>R/0 Returns callee email</para>
+ </enum>
+ <enum name="callee_dialeddigits">
+ <para>R/0 Returns callee dialed digits</para>
+ </enum>
+ <enum name="caller_url">
+ <para>R/0 Returns caller URL</para>
+ </enum>
+ <enum name="max_forwards">
+ <para>R/W Get or set the maximum number of call forwards for this channel.
+
+ This number describes the number of times a call may be forwarded by this channel
+ before the call fails. "Forwards" in this case refers to redirects by phones as well
+ as calls to local channels.
+
+ Note that this has no relation to the SIP Max-Forwards header.
+ </para>
+ </enum>
+ </enumlist>
+</info>
+ ***/
+
#include "chan_ooh323.h"
#include <math.h>