]> git.ipfire.org Git - thirdparty/asterisk.git/commitdiff
Let documentation reference links specify which module they're linking to
authorMatthew Jordan <mjordan@digium.com>
Wed, 16 Jan 2013 17:45:37 +0000 (17:45 +0000)
committerMatthew Jordan <mjordan@digium.com>
Wed, 16 Jan 2013 17:45:37 +0000 (17:45 +0000)
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.

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

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

index c379843d3f5d4fd26814fa6d95efd417ed1f06f6..561e3d38cd4322843954760f7e8ae758d38bdfcd 100644 (file)
@@ -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)>
 
index f4d5869626524865577a638629a33f52d42b5f86..910770f53ae976016f323bba50a421266fc3cf72 100644 (file)
@@ -92,8 +92,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">
@@ -121,8 +121,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">
@@ -151,8 +151,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">
@@ -260,7 +260,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.
index f6ab9a8467051604f637c54d16e17b6bdab8e9d9..24612ba122cc01c5337168c5a7c5b6e977d9eaa3 100644 (file)
@@ -81,8 +81,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">
@@ -110,8 +110,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">
@@ -140,8 +140,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">