diff options
| author | Jeremy Lainé <jeremy.laine@m4x.org> | 2010-12-13 08:39:19 +0000 |
|---|---|---|
| committer | Jeremy Lainé <jeremy.laine@m4x.org> | 2010-12-13 08:39:19 +0000 |
| commit | fc0dd32f430a5fb7f6bcba638663cdf845a363d0 (patch) | |
| tree | 0e53f0df5ad2c302ccb9ad08bb9045c1e1ec2790 /src/QXmppRpcManager.h | |
| parent | a2b083b9fc42c562281201e4bd786b1057f57584 (diff) | |
| download | qxmpp-fc0dd32f430a5fb7f6bcba638663cdf845a363d0.tar.gz | |
add some code documentation to QXmppRpcManager
Diffstat (limited to 'src/QXmppRpcManager.h')
| -rw-r--r-- | src/QXmppRpcManager.h | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/src/QXmppRpcManager.h b/src/QXmppRpcManager.h index 65415bb1..3f12fe0b 100644 --- a/src/QXmppRpcManager.h +++ b/src/QXmppRpcManager.h @@ -28,13 +28,29 @@ #include <QVariant> #include "QXmppClientExtension.h" +#include "QXmppInvokable.h" +#include "QXmppRemoteMethod.h" -class QXmppInvokable; -struct QXmppRemoteMethodResult; class QXmppRpcErrorIq; class QXmppRpcInvokeIq; class QXmppRpcResponseIq; +/// \brief The QXmppRpcManager class make it possible to invoke remote methods +/// and to expose local interfaces for remote procedure calls, as specified by +/// XEP-0009: Jabber-RPC. +/// +/// To make use of this manager, you need to instantiate it and load it into +/// the QXmppClient instance as follows: +/// +/// \code +/// QXmppRpcManager *manager = new QXmppRpcManager; +/// client->addExtension(manager); +/// \endcode +/// +/// \note THIS API IS NOT FINALIZED YET +/// +/// \ingroup Managers + class QXmppRpcManager : public QXmppClientExtension { Q_OBJECT |
