From f4e28b3a09d3223fad1c736d59f06abf0667b5fa Mon Sep 17 00:00:00 2001 From: Corey Farrell Date: Mon, 15 Aug 2016 16:29:53 -0400 Subject: [PATCH] Refactor usage pattern of xmldoc info tag. This updates func_channel.c and main/message.c to use a generic xpointer include instead of including info from each channel driver. Now the name attribute of info is CHANNEL or CHANNEL_EXAMPLES to be included in documentation for func_channel. Setting the name attribute of info to MessageToInfo or MessageFromInfo causes it to be included in the MessageSend application and AMI action. Change-Id: I89fd8276a3250824241a618009714267d3a8d1ea --- addons/chan_ooh323.c | 2 +- channels/chan_dahdi.c | 2 +- channels/chan_iax2.c | 2 +- channels/chan_sip.c | 4 ++-- channels/pjsip/dialplan_functions.c | 4 ++-- channels/sip/dialplan_functions.c | 2 +- doc/appdocsxml.xslt | 5 ++++- funcs/func_channel.c | 8 ++------ main/message.c | 16 ++++------------ res/res_pjsip_messaging.c | 4 ++-- res/res_xmpp.c | 4 ++-- 11 files changed, 22 insertions(+), 31 deletions(-) diff --git a/addons/chan_ooh323.c b/addons/chan_ooh323.c index 9ab90aed81..b64d43c662 100644 --- a/addons/chan_ooh323.c +++ b/addons/chan_ooh323.c @@ -23,7 +23,7 @@ ***/ /*** DOCUMENTATION - + R/W Fax Detect diff --git a/channels/chan_dahdi.c b/channels/chan_dahdi.c index ac55f5864e..2e139a2342 100644 --- a/channels/chan_dahdi.c +++ b/channels/chan_dahdi.c @@ -180,7 +180,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") This application will Accept the R2 call either with charge or no charge. - + R/O DAHDI channel related to this channel. diff --git a/channels/chan_iax2.c b/channels/chan_iax2.c index bd773fc844..db5e4fa4d3 100644 --- a/channels/chan_iax2.c +++ b/channels/chan_iax2.c @@ -213,7 +213,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") Gets or sets a variable that is sent to a remote IAX2 peer during call setup. - + R/O Get the peer's osptoken. diff --git a/channels/chan_sip.c b/channels/chan_sip.c index 4be53c2182..a30a18117f 100644 --- a/channels/chan_sip.c +++ b/channels/chan_sip.c @@ -568,11 +568,11 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") for all of the sip peers will be retrieved. - + The from parameter can be a configured peer name or in the form of "display-name" <URI>. - + Specifying a prefix of sip: will send the message as a SIP MESSAGE request. diff --git a/channels/pjsip/dialplan_functions.c b/channels/pjsip/dialplan_functions.c index 380a05eed0..ecf5105f8c 100644 --- a/channels/pjsip/dialplan_functions.c +++ b/channels/pjsip/dialplan_functions.c @@ -109,7 +109,7 @@ PJSIP_MEDIA_OFFER - + R/O Retrieve media related information. @@ -411,7 +411,7 @@ - + ; Log the current Call-ID same => n,Log(NOTICE, ${CHANNEL(pjsip,call-id)}) diff --git a/channels/sip/dialplan_functions.c b/channels/sip/dialplan_functions.c index e53981d657..b859c601bc 100644 --- a/channels/sip/dialplan_functions.c +++ b/channels/sip/dialplan_functions.c @@ -24,7 +24,7 @@ ***/ /*** DOCUMENTATION - + R/O Get the IP address of the peer. diff --git a/doc/appdocsxml.xslt b/doc/appdocsxml.xslt index 6e4c5ac500..f067decaef 100644 --- a/doc/appdocsxml.xslt +++ b/doc/appdocsxml.xslt @@ -6,7 +6,10 @@ - + + + + diff --git a/funcs/func_channel.c b/funcs/func_channel.c index 5efc09c4f9..673de51d09 100644 --- a/funcs/func_channel.c +++ b/funcs/func_channel.c @@ -233,11 +233,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") R/W The maximum number of forwards allowed. - - - - - + @@ -263,7 +259,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") ; Log the current state of the channel same => n,Log(NOTICE, This channel is: ${CHANNEL(state)}) - + ***/ diff --git a/main/message.c b/main/message.c index c15975b631..d4e48fb4a7 100644 --- a/main/message.c +++ b/main/message.c @@ -123,16 +123,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") A To URI for the message. - - - + A From URI for the message if needed for the message technology being used to send this message. - - - + @@ -168,16 +164,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") The URI the message is to be sent to. - - - + A From URI for the message if needed for the message technology being used to send this message. - - - + The message body text. This must not contain any newlines as that diff --git a/res/res_pjsip_messaging.c b/res/res_pjsip_messaging.c index 594c0fdac3..4e5ad26521 100644 --- a/res/res_pjsip_messaging.c +++ b/res/res_pjsip_messaging.c @@ -24,11 +24,11 @@ ***/ /*** DOCUMENTATION - + The from parameter can be a configured endpoint or in the form of "display-name" <URI>. - + Specifying a prefix of pjsip: will send the message as a SIP MESSAGE request. diff --git a/res/res_xmpp.c b/res/res_xmpp.c index ed35cd169e..cd4b248708 100644 --- a/res/res_xmpp.c +++ b/res/res_xmpp.c @@ -278,11 +278,11 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") Sends a message to a Jabber Client. - + Specifying a prefix of xmpp: will send the message as an XMPP chat message. - + Specifying a prefix of xmpp: will specify the account defined in xmpp.conf to send the message from. Note that this field is required for XMPP messages. -- 2.47.2