From 4af7217b123b643037476ecb9dfab80295f0aaf6 Mon Sep 17 00:00:00 2001 From: Jeremy Lainé Date: Sat, 11 Dec 2010 20:03:26 +0000 Subject: improve documentation for QXmppServer and QXmppServerExtension --- src/QXmppServer.h | 7 +++++++ src/QXmppServerExtension.h | 6 ++++++ 2 files changed, 13 insertions(+) (limited to 'src') 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 { -- cgit v1.2.3