[asterisk-commits] mjordan: branch 11 r379209 - in /branches/11/res: res_jabber.c res_xmpp.c
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Wed Jan 16 09:27:49 CST 2013
Author: mjordan
Date: Wed Jan 16 09:27:44 2013
New Revision: 379209
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=379209
Log:
Add module tags to documentation for res_jabber/res_xmpp
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.
Modified:
branches/11/res/res_jabber.c
branches/11/res/res_xmpp.c
Modified: branches/11/res/res_jabber.c
URL: http://svnview.digium.com/svn/asterisk/branches/11/res/res_jabber.c?view=diff&rev=379209&r1=379208&r2=379209
==============================================================================
--- branches/11/res/res_jabber.c (original)
+++ branches/11/res/res_jabber.c Wed Jan 16 09:27:44 2013
@@ -66,7 +66,7 @@
#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 @@
<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 @@
<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 @@
<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 @@
<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 @@
<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 @@
<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 @@
</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>
Modified: branches/11/res/res_xmpp.c
URL: http://svnview.digium.com/svn/asterisk/branches/11/res/res_xmpp.c?view=diff&rev=379209&r1=379208&r2=379209
==============================================================================
--- branches/11/res/res_xmpp.c (original)
+++ branches/11/res/res_xmpp.c Wed Jan 16 09:27:44 2013
@@ -55,7 +55,7 @@
#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 @@
<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 @@
<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 @@
<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 @@
<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 @@
<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 @@
<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 @@
</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>
More information about the asterisk-commits
mailing list