improve QXmppClientExtension

1 files changed, 11 insertions, 3 deletions

diff --git a/src/QXmppClientExtension.h b/src/QXmppClientExtension.h
index 7bfe6296..82048411 100644
--- a/src/QXmppClientExtension.h
+++ b/src/QXmppClientExtension.h
@@ -37,6 +37,12 @@ class QXmppStream;
 /// \brief The QXmppClientExtension class is the base class for QXmppClient
 /// extensions.
 ///
+/// If you want to extend QXmpp, for instance to support an IQ type which
+/// is not natively supported by QXmpp, you can subclass QXmppClientExtension
+/// and implement handleStanza(). You can then add your extension to the
+/// client instance using QXmppClient::addExtension().
+///
+/// \ingroup Core
 
 class QXmppClientExtension : public QXmppLoggable
 {
@@ -49,10 +55,12 @@ public:
     virtual QStringList discoveryFeatures() const;
     virtual QList<QXmppDiscoveryIq::Identity> discoveryIdentities() const;
 
-    /// \brief Handles the incoming XMPP \a stanza.
+    /// \brief You need to implement this method to process incoming XMPP
+    /// stanzas.
     ///
-    /// Returns true if the stanza was handled and no further processing
-    /// should occur, or false otherwise.
+    /// You should return true if the stanza was handled and no further
+    /// processing should occur, or false to let other extensions process
+    /// the stanza.
     virtual bool handleStanza(const QDomElement &stanza) = 0;
 
 protected: