kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-31 02:37:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor usage pattern of xmldoc info tag.

Browse Source 
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
This commit is contained in:
Corey Farrell
2016-08-15 16:29:53 -04:00
parent 4f0067293e
commit 824a4e84d1
11 changed files with 22 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
main/message.c
View File

@@ -123,16 +123,12 @@ ASTERISK_REGISTER_FILE()
<syntax>
<parameter name="to" required="true">
<para>A To URI for the message.</para>
<xi:include xpointer="xpointer(/docs/info[@name='PJSIPMessageToInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='SIPMessageToInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='XMPPMessageToInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='MessageToInfo'])" />
</parameter>
<parameter name="from" required="false">
<para>A From URI for the message if needed for the
message technology being used to send this message.</para>
<xi:include xpointer="xpointer(/docs/info[@name='PJSIPMessageFromInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='SIPMessageFromInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='XMPPMessageFromInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='MessageFromInfo'])" />
</parameter>
</syntax>
<description>
@@ -168,16 +164,12 @@ ASTERISK_REGISTER_FILE()
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
<parameter name="To" required="true">
<para>The URI the message is to be sent to.</para>
<xi:include xpointer="xpointer(/docs/info[@name='PJSIPMessageToInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='SIPMessageToInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='XMPPMessageToInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='MessageToInfo'])" />
</parameter>
<parameter name="From">
<para>A From URI for the message if needed for the
message technology being used to send this message.</para>
<xi:include xpointer="xpointer(/docs/info[@name='PJSIPMessageFromInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='SIPMessageFromInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='XMPPMessageFromInfo'])" />
<xi:include xpointer="xpointer(/docs/info[@name='MessageFromInfo'])" />
</parameter>
<parameter name="Body">
<para>The message body text. This must not contain any newlines as that