aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2010-12-11 20:03:26 +0000
committerJeremy Lainé <jeremy.laine@m4x.org>2010-12-11 20:03:26 +0000
commit4af7217b123b643037476ecb9dfab80295f0aaf6 (patch)
tree6d45eb4cd33743d05a5b1ca09e568b23fc5a19eb /src
parent5889aeaade036a88cac8cbcf03e5b6cde6f8b053 (diff)
downloadqxmpp-4af7217b123b643037476ecb9dfab80295f0aaf6.tar.gz
improve documentation for QXmppServer and QXmppServerExtension
Diffstat (limited to 'src')
-rw-r--r--src/QXmppServer.h7
-rw-r--r--src/QXmppServerExtension.h6
2 files changed, 13 insertions, 0 deletions
diff --git a/src/QXmppServer.h b/src/QXmppServer.h
index 252f13f9..50f35049 100644
--- a/src/QXmppServer.h
+++ b/src/QXmppServer.h
@@ -42,6 +42,13 @@ class QXmppStream;
/// \brief The QXmppServer class represents an XMPP server.
///
+/// It provides support for both client-to-server and server-to-server
+/// communications, SSL encryption and logging facilities.
+///
+/// QXmppServer comes with a number of modules for service discovery,
+/// XMPP ping, statistics and file transfer proxy support. You can write
+/// your own extensions for QXmppServer by subclassing QXmppServerExtension.
+///
/// \ingroup Core
class QXmppServer : public QXmppLoggable
diff --git a/src/QXmppServerExtension.h b/src/QXmppServerExtension.h
index 7cb319e7..c16daa9b 100644
--- a/src/QXmppServerExtension.h
+++ b/src/QXmppServerExtension.h
@@ -38,6 +38,12 @@ class QXmppStream;
/// \brief The QXmppServerExtension class is the base class for QXmppServer
/// extensions.
///
+/// If you want to extend QXmppServer, for instance to support an IQ type
+/// which is not natively supported, you can subclass QXmppServerExtension
+/// and implement handleStanza(). You can then add your extension to the
+/// client instance using QXmppServer::addExtension().
+///
+/// \ingroup Core
class QXmppServerExtension : public QXmppLoggable
{