[sr-dev] git:master: Doxygen fix for XMPP page

Module: sip-router Branch: master Commit: 4079ba2c041c7172b13496b285a359ec9bff9d3b URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=4079ba2… Author: oej &lt;oej(a)edvina.net&gt; Committer: oej &lt;oej(a)edvina.net&gt; Date: Mon Oct 19 22:40:12 2009 +0200 Doxygen fix for XMPP page Starting to pick out documentation hidden deep in the source code and adding them as "related pages" in the doxygen. Please check. --- modules_k/xmpp/xmpp.c | 20 ++++++++++++++++---- 1 files changed, 16 insertions(+), 4 deletions(-) diff --git a/modules_k/xmpp/xmpp.c b/modules_k/xmpp/xmpp.c index 2403957..5d634d4 100644 --- a/modules_k/xmpp/xmpp.c +++ b/modules_k/xmpp/xmpp.c @@ -34,23 +34,34 @@ * \brief Kamailio XMPP module :: * \ingroup xmpp * + * - \ref XMPProuting + * * \page XMPProuting XMPP to SIP transport interface * * An inbound SIP URI: - * from sip:user1@domain1 to sip:user2*domain2@gateway_domain +\verbatim + from sip:user1@domain1 to sip:user2*domain2@gateway_domain +\endverbatim * is translated to an XMPP JID: - * from user1*domain1@xmpp_domain to user2@domain2 +\verbatim + from user1*domain1@xmpp_domain to user2@domain2 +\endverbatim * * An inbound XMPP JID (uri): - * from user1@domain1 to user2*domain2@xmpp_domain +\verbatim + from user1@domain1 to user2*domain2@xmpp_domain +\endverbatim * is translated to a SIP URI: - * from sip:user1*domain1@gateway_domain to sip:user2@domain2 +\verbatim + from sip:user1*domain1@gateway_domain to sip:user2@domain2 +\endverbatim * * Where '*' is the domain_separator, and gateway_domain and * xmpp_domain are defined below. * * * 2-way dialback sequence with xmppd2: +\verbatim * * Originating server (us) Receiving server (them) Authoritative server (us) * ----------------------- ----------------------- ------------------------- @@ -90,6 +101,7 @@ * | incoming <message/> | * |------------------------------>| * +\endverbatim * Note: Dialback is an old mechanism that is now replaced by TLS connections * in "modern" XMPP servers. With TLS, dialback is not used. */