Multiple revisions 379209-379210
authorMatthew Jordan <mjordan@digium.com>
Wed, 16 Jan 2013 15:33:05 +0000 (15:33 +0000)
committerMatthew Jordan <mjordan@digium.com>
Wed, 16 Jan 2013 15:33:05 +0000 (15:33 +0000)
........
  r379209 | mjordan | 2013-01-16 09:27:44 -0600 (Wed, 16 Jan 2013) | 8 lines

  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.
........
  r379210 | mjordan | 2013-01-16 09:30:20 -0600 (Wed, 16 Jan 2013) | 4 lines

  Update the dtd to actually *support* the module attribute in all elements

  Mea culpa.
........

Merged revisions 379209-379210 from http://svn.asterisk.org/svn/asterisk/branches/11

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@379211 65c4cc65-6c06-0410-ace0-fbb531ad65f3

doc/appdocsxml.dtd
res/res_jabber.c
res/res_xmpp.c

index 456ac18..c379843 100644 (file)
   <!ELEMENT agi (synopsis?,syntax?,description?,see-also?)>
   <!ATTLIST agi name CDATA #REQUIRED>
   <!ATTLIST agi language CDATA #REQUIRED>
   <!ELEMENT agi (synopsis?,syntax?,description?,see-also?)>
   <!ATTLIST agi name CDATA #REQUIRED>
   <!ATTLIST agi language CDATA #REQUIRED>
+  <!ATTLIST agi module CDATA #IMPLIED>
 
   <!ELEMENT manager (synopsis?,syntax?,description?,see-also?)>
   <!ATTLIST manager name CDATA #REQUIRED>
   <!ATTLIST manager language CDATA #REQUIRED>
 
   <!ELEMENT manager (synopsis?,syntax?,description?,see-also?)>
   <!ATTLIST manager name CDATA #REQUIRED>
   <!ATTLIST manager language CDATA #REQUIRED>
+  <!ATTLIST manager module CDATA #IMPLIED>
 
   <!ELEMENT managerEvent (managerEventInstance+)>
   <!ATTLIST managerEvent name CDATA #REQUIRED>
   <!ATTLIST managerEvent language CDATA #REQUIRED>
 
   <!ELEMENT managerEvent (managerEventInstance+)>
   <!ATTLIST managerEvent name CDATA #REQUIRED>
   <!ATTLIST managerEvent language CDATA #REQUIRED>
+  <!ATTLIST managerEvent module CDATA #IMPLIED>
 
   <!ELEMENT managerEventInstance (synopsis?,syntax?,description?,see-also?)*>
   <!ATTLIST managerEventInstance class CDATA #REQUIRED>
 
   <!ELEMENT managerEventInstance (synopsis?,syntax?,description?,see-also?)*>
   <!ATTLIST managerEventInstance class CDATA #REQUIRED>
index f74d6ac..fe05274 100644 (file)
@@ -75,7 +75,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/message.h"
 
 /*** DOCUMENTATION
 #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>
                <synopsis>
                        Sends an XMPP message to a buddy.
                </synopsis>
@@ -105,7 +105,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <ref type="function">JABBER_RECEIVE</ref>
                </see-also>
        </application>
                        <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>
                <synopsis>
                        Reads XMPP messages.
                </synopsis>
@@ -134,7 +134,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <ref type="application">JabberSend</ref>
                </see-also>
        </function>
                        <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>
                <synopsis>
                        Retrieves a buddy's status.
                </synopsis>
@@ -164,7 +164,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <ref type="application">JabberSend</ref>
                </see-also>
        </function>
                        <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>
                <synopsis>
                        Send a Jabber Message to a specified chat room
                </synopsis>
@@ -187,7 +187,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>
                        <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>
                <synopsis>
                        Join a chat room
                </synopsis>
@@ -207,7 +207,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <para>Allows Asterisk to join a chat room.</para>
                </description>
        </application>
                        <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>
                <synopsis>
                        Leave a chat room
                </synopsis>
@@ -226,7 +226,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <para>Allows Asterisk to leave a chat room.</para>
                </description>
        </application>
                        <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>
                <synopsis>
                        Retrieve the status of a jabber list member
                </synopsis>
@@ -270,7 +270,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        </enumlist>
                </description>
         </application>
                        </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>
                <synopsis>
                        Sends a message to a Jabber Client.
                </synopsis>
index 04db2dd..c924080 100644 (file)
@@ -64,7 +64,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/config_options.h"
 
 /*** DOCUMENTATION
 #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>
                <synopsis>
                        Sends an XMPP message to a buddy.
                </synopsis>
@@ -94,7 +94,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <ref type="function">JABBER_RECEIVE</ref>
                </see-also>
        </application>
                        <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>
                <synopsis>
                        Reads XMPP messages.
                </synopsis>
@@ -123,7 +123,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <ref type="application">JabberSend</ref>
                </see-also>
        </function>
                        <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>
                <synopsis>
                        Retrieves a buddy's status.
                </synopsis>
@@ -153,7 +153,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <ref type="application">JabberSend</ref>
                </see-also>
        </function>
                        <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>
                <synopsis>
                        Send a Jabber Message to a specified chat room
                </synopsis>
@@ -176,7 +176,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>
                        <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>
                <synopsis>
                        Join a chat room
                </synopsis>
@@ -196,7 +196,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <para>Allows Asterisk to join a chat room.</para>
                </description>
        </application>
                        <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>
                <synopsis>
                        Leave a chat room
                </synopsis>
@@ -215,7 +215,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <para>Allows Asterisk to leave a chat room.</para>
                </description>
        </application>
                        <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>
                <synopsis>
                        Retrieve the status of a jabber list member
                </synopsis>
@@ -259,7 +259,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        </enumlist>
                </description>
        </application>
                        </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>
                <synopsis>
                        Sends a message to a Jabber Client.
                </synopsis>