From fc0dd32f430a5fb7f6bcba638663cdf845a363d0 Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Mon, 13 Dec 2010 08:39:19 +0000
Subject: add some code documentation to QXmppRpcManager

---
 src/QXmppRpcManager.cpp | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'src/QXmppRpcManager.cpp')

diff --git a/src/QXmppRpcManager.cpp b/src/QXmppRpcManager.cpp
index 06c58451..63885556 100644
--- a/src/QXmppRpcManager.cpp
+++ b/src/QXmppRpcManager.cpp
@@ -34,11 +34,19 @@ QXmppRpcManager::QXmppRpcManager()
 {
 }
 
+/// Adds a local interface which can be queried using RPC.
+///
+/// \param interface
+
 void QXmppRpcManager::addInvokableInterface( QXmppInvokable *interface )
 {
     m_interfaces[ interface->metaObject()->className() ] = interface;
 }
 
+/// Invokes a remote interface using RPC.
+///
+/// \param iq
+
 void QXmppRpcManager::invokeInterfaceMethod( const QXmppRpcInvokeIq &iq )
 {
     QXmppStanza::Error error;
@@ -90,6 +98,8 @@ void QXmppRpcManager::invokeInterfaceMethod( const QXmppRpcInvokeIq &iq )
     client()->sendPacket(errorIq);
 }
 
+/// Call a remote method using RPC with the specified arguments.
+
 QXmppRemoteMethodResult QXmppRpcManager::callRemoteMethod( const QString &jid,
                                           const QString &interface,
                                           const QVariant &arg1,
-- 
cgit v1.2.3