Asterisk
/
asterisk
mirror of https://github.com/asterisk/asterisk
1
0
Fork 0
Code Issues Releases Wiki Activity

Add module tags to documentation for res_jabber/res_xmpp

Browse Source 
Since res_jabber/res_xmpp provide the same APIs (app/func/manager/etc.),
the XML documentation for each needs to call out which module is providing
the documentation. The module attribute has been added to the various XML
fragments for this purpose.



git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/11@379209 65c4cc65-6c06-0410-ace0-fbb531ad65f3
changes/61/61/1
Matthew Jordan 13 years ago
parent f551978e9e
commit 28bdf7d292
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File

16
res/res_jabber.c
Unescape View File

@ -66,7 +66,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/message.h"
/*** DOCUMENTATION
<application name="JabberSend" language="en_US">
<application name="JabberSend" language="en_US" module="res_jabber">
<synopsis>
Sends an XMPP message to a buddy.
</synopsis>
@ -96,7 +96,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<ref type="function">JABBER_RECEIVE</ref>
</see-also>
</application>
<function name="JABBER_RECEIVE" language="en_US">
<function name="JABBER_RECEIVE" language="en_US" module="res_jabber">
<synopsis>
Reads XMPP messages.
</synopsis>
@ -125,7 +125,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<ref type="application">JabberSend</ref>
</see-also>
</function>
<function name="JABBER_STATUS" language="en_US">
<function name="JABBER_STATUS" language="en_US" module="res_jabber">
<synopsis>
Retrieves a buddy's status.
</synopsis>
@ -155,7 +155,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<ref type="application">JabberSend</ref>
</see-also>
</function>
<application name="JabberSendGroup" language="en_US">
<application name="JabberSendGroup" language="en_US" module="res_jabber">
<synopsis>
Send a Jabber Message to a specified chat room
</synopsis>
@ -178,7 +178,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<note><para>To be able to send messages to a chat room, a user must have previously joined it. Use the <replaceable>JabberJoin</replaceable> function to do so.</para></note>
</description>
</application>
<application name="JabberJoin" language="en_US">
<application name="JabberJoin" language="en_US" module="res_jabber">
<synopsis>
Join a chat room
</synopsis>
@ -198,7 +198,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Allows Asterisk to join a chat room.</para>
</description>
</application>
<application name="JabberLeave" language="en_US">
<application name="JabberLeave" language="en_US" module="res_jabber">
<synopsis>
Leave a chat room
</synopsis>
@ -217,7 +217,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Allows Asterisk to leave a chat room.</para>
</description>
</application>
<application name="JabberStatus" language="en_US">
<application name="JabberStatus" language="en_US" module="res_jabber">
<synopsis>
Retrieve the status of a jabber list member
</synopsis>
@ -261,7 +261,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</enumlist>
</description>
</application>
<manager name="JabberSend" language="en_US">
<manager name="JabberSend" language="en_US" module="res_jabber">
<synopsis>
Sends a message to a Jabber Client.
</synopsis>

16
res/res_xmpp.c
Unescape View File

@ -55,7 +55,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/config_options.h"
/*** DOCUMENTATION
<application name="JabberSend" language="en_US">
<application name="JabberSend" language="en_US" module="res_xmpp">
<synopsis>
Sends an XMPP message to a buddy.
</synopsis>
@ -85,7 +85,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<ref type="function">JABBER_RECEIVE</ref>
</see-also>
</application>
<function name="JABBER_RECEIVE" language="en_US">
<function name="JABBER_RECEIVE" language="en_US" module="res_xmpp">
<synopsis>
Reads XMPP messages.
</synopsis>
@ -114,7 +114,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<ref type="application">JabberSend</ref>
</see-also>
</function>
<function name="JABBER_STATUS" language="en_US">
<function name="JABBER_STATUS" language="en_US" module="res_xmpp">
<synopsis>
Retrieves a buddy's status.
</synopsis>
@ -144,7 +144,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<ref type="application">JabberSend</ref>
</see-also>
</function>
<application name="JabberSendGroup" language="en_US">
<application name="JabberSendGroup" language="en_US" module="res_xmpp">
<synopsis>
Send a Jabber Message to a specified chat room
</synopsis>
@ -167,7 +167,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<note><para>To be able to send messages to a chat room, a user must have previously joined it. Use the <replaceable>JabberJoin</replaceable> function to do so.</para></note>
</description>
</application>
<application name="JabberJoin" language="en_US">
<application name="JabberJoin" language="en_US" module="res_xmpp">
<synopsis>
Join a chat room
</synopsis>
@ -187,7 +187,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Allows Asterisk to join a chat room.</para>
</description>
</application>
<application name="JabberLeave" language="en_US">
<application name="JabberLeave" language="en_US" module="res_xmpp">
<synopsis>
Leave a chat room
</synopsis>
@ -206,7 +206,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Allows Asterisk to leave a chat room.</para>
</description>
</application>
<application name="JabberStatus" language="en_US">
<application name="JabberStatus" language="en_US" module="res_xmpp">
<synopsis>
Retrieve the status of a jabber list member
</synopsis>
@ -250,7 +250,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</enumlist>
</description>
</application>
<manager name="JabberSend" language="en_US">
<manager name="JabberSend" language="en_US" module="res_xmpp">
<synopsis>
Sends a message to a Jabber Client.
</synopsis>

Write Preview
Loading…
Cancel
Save