Let documentation reference links specify which module they're linking to

Again, since res_jabber/res_xmpp have duplicate APIs, their documentation ref
links have to specify which reference they're referring to. The various
documentation parsers can interpret the module attribute however they want
in order to construct the appropriate links.
........

Merged revisions 379228 from http://svn.asterisk.org/svn/asterisk/branches/11

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

diff --git a/doc/appdocsxml.dtd b/doc/appdocsxml.dtd
index c379843d3f5d4fd26814fa6d95efd417ed1f06f6..561e3d38cd4322843954760f7e8ae758d38bdfcd 100644 (file)
--- a/doc/appdocsxml.dtd
+++ b/doc/appdocsxml.dtd
@@ -48,6 +48,7 @@
 
   <!ELEMENT ref (#PCDATA)>
   <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi|manager|managerEvent) #REQUIRED>
+  <!ATTLIST ref module CDATA #IMPLIED>
 
   <!ELEMENT synopsis (#PCDATA)>
 

diff --git a/res/res_jabber.c b/res/res_jabber.c
index fe05274ef398fdf5fa979c772322c41a39141974..e8e79051e4b4f3d00046102ade7aa6bedcaa6278 100644 (file)
--- a/res/res_jabber.c
+++ b/res/res_jabber.c
@@ -101,8 +101,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <replaceable>asterisk</replaceable>, configured in jabber.conf.</para>
                </description>
                <see-also>
-                       <ref type="function">JABBER_STATUS</ref>
-                       <ref type="function">JABBER_RECEIVE</ref>
+                       <ref type="function" module="res_jabber">JABBER_STATUS</ref>
+                       <ref type="function" module="res_jabber">JABBER_RECEIVE</ref>
                </see-also>
        </application>
        <function name="JABBER_RECEIVE" language="en_US" module="res_jabber">
@@ -130,8 +130,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        the <replaceable>asterisk</replaceable> XMPP account configured in jabber.conf.</para>
                </description>
                <see-also>
-                       <ref type="function">JABBER_STATUS</ref>
-                       <ref type="application">JabberSend</ref>
+                       <ref type="function" module="res_jabber">JABBER_STATUS</ref>
+                       <ref type="application" module="res_jabber">JabberSend</ref>
                </see-also>
        </function>
        <function name="JABBER_STATUS" language="en_US" module="res_jabber">
@@ -160,8 +160,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        the associated XMPP account configured in jabber.conf.</para>
                </description>
                <see-also>
-                       <ref type="function">JABBER_RECEIVE</ref>
-                       <ref type="application">JabberSend</ref>
+                       <ref type="function" module="res_jabber">JABBER_RECEIVE</ref>
+                       <ref type="application" module="res_jabber">JabberSend</ref>
                </see-also>
        </function>
        <application name="JabberSendGroup" language="en_US" module="res_jabber">
@@ -269,7 +269,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                                </enum>
                        </enumlist>
                </description>
-        </application>
+       </application>
        <manager name="JabberSend" language="en_US" module="res_jabber">
                <synopsis>
                        Sends a message to a Jabber Client.

diff --git a/res/res_xmpp.c b/res/res_xmpp.c
index c924080981b4a31c1824165ccf09f47905b1d6e3..3e84e4193209b8e87e4ef38b0fd813908f63ae8e 100644 (file)
--- a/res/res_xmpp.c
+++ b/res/res_xmpp.c
@@ -90,8 +90,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <replaceable>asterisk</replaceable>, configured in xmpp.conf.</para>
                </description>
                <see-also>
-                       <ref type="function">JABBER_STATUS</ref>
-                       <ref type="function">JABBER_RECEIVE</ref>
+                       <ref type="function" module="res_xmpp">JABBER_STATUS</ref>
+                       <ref type="function" module="res_xmpp">JABBER_RECEIVE</ref>
                </see-also>
        </application>
        <function name="JABBER_RECEIVE" language="en_US" module="res_xmpp">
@@ -119,8 +119,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        the <replaceable>asterisk</replaceable> XMPP account configured in xmpp.conf.</para>
                </description>
                <see-also>
-                       <ref type="function">JABBER_STATUS</ref>
-                       <ref type="application">JabberSend</ref>
+                       <ref type="function" module="res_xmpp">JABBER_STATUS</ref>
+                       <ref type="application" module="res_xmpp">JabberSend</ref>
                </see-also>
        </function>
        <function name="JABBER_STATUS" language="en_US" module="res_xmpp">
@@ -149,8 +149,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        the associated XMPP account configured in xmpp.conf.</para>
                </description>
                <see-also>
-                       <ref type="function">JABBER_RECEIVE</ref>
-                       <ref type="application">JabberSend</ref>
+                       <ref type="function" module="res_xmpp">JABBER_RECEIVE</ref>
+                       <ref type="application" module="res_xmpp">JabberSend</ref>
                </see-also>
        </function>
        <application name="JabberSendGroup" language="en_US" module="res_xmpp">