add code documentation to stream classes

5 files changed, 19 insertions, 7 deletions

diff --git a/src/QXmppIncomingClient.h b/src/QXmppIncomingClient.h
index ca8af0e4..65acf842 100644
--- a/src/QXmppIncomingClient.h
+++ b/src/QXmppIncomingClient.h
@@ -28,7 +28,7 @@
 
 class QXmppIncomingClientPrivate;
 
-/// Interface for password checkers.
+/// \brief Interface for password checkers.
 ///
 
 class QXmppPasswordChecker
@@ -41,7 +41,7 @@ public:
     virtual bool get(const QString &username, QString &password) = 0;
 };
 
-/// The QXmppIncomingClient class represents an incoming XMPP stream
+/// \brief The QXmppIncomingClient class represents an incoming XMPP stream
 /// from an XMPP client.
 ///
 
@@ -59,8 +59,10 @@ public:
     void setPasswordChecker(QXmppPasswordChecker *checker);
 
 protected:
+    /// \cond
     void handleStream(const QDomElement &element);
     void handleStanza(const QDomElement &element);
+    /// \endcond
 
 private slots:
     void slotTimeout();
diff --git a/src/QXmppIncomingServer.cpp b/src/QXmppIncomingServer.cpp
index 46e00ba9..9fe7ee1e 100644
--- a/src/QXmppIncomingServer.cpp
+++ b/src/QXmppIncomingServer.cpp
@@ -137,7 +137,9 @@ void QXmppIncomingServer::handleStanza(const QDomElement &stanza)
             Q_ASSERT(check);
             stream->setVerify(d->localStreamId, request.key());
             stream->connectToHost();
-        } else {
+        }
+        else if (request.command() == QXmppDialback::Verify)
+        {
             emit dialbackRequestReceived(request);
         }
 
diff --git a/src/QXmppIncomingServer.h b/src/QXmppIncomingServer.h
index 52372813..e82ba9d7 100644
--- a/src/QXmppIncomingServer.h
+++ b/src/QXmppIncomingServer.h
@@ -30,7 +30,7 @@ class QXmppDialback;
 class QXmppIncomingServerPrivate;
 class QXmppOutgoingServer;
 
-/// The QXmppIncomingServer class represents an incoming XMPP stream
+/// \brief The QXmppIncomingServer class represents an incoming XMPP stream
 /// from an XMPP server.
 ///
 
@@ -45,11 +45,14 @@ public:
     QString localStreamId() const;
 
 signals:
+    /// This signal is emitted when a dialback verify request is received.
     void dialbackRequestReceived(const QXmppDialback &result);
 
 protected:
+    /// \cond
     void handleStanza(const QDomElement &stanzaElement);
     void handleStream(const QDomElement &streamElement);
+    /// \endcond
 
 private slots:
     void slotDialbackResponseReceived(const QXmppDialback &dialback);
diff --git a/src/QXmppOutgoingClient.h b/src/QXmppOutgoingClient.h
index 1e217c28..6bfb14a0 100644
--- a/src/QXmppOutgoingClient.h
+++ b/src/QXmppOutgoingClient.h
@@ -60,8 +60,8 @@ class QXmppVersionIq;
 
 class QXmppOutgoingClientPrivate;
 
-/// \brief The QXmppStream class represents an outgoing client-to-server
-/// stream.
+/// \brief The QXmppOutgoingClient class represents an outgoing XMPP stream
+/// to an XMPP server.
 ///
 
 class QXmppOutgoingClient : public QXmppStream
@@ -124,10 +124,12 @@ signals:
     void jingleIqReceived(const QXmppJingleIq&);
 
 protected:
+    /// \cond
     // Overridable methods
     virtual void handleStart();
     virtual void handleStanza(const QDomElement &element);
     virtual void handleStream(const QDomElement &element);
+    /// \endcond
 
 private slots:
     void socketError(QAbstractSocket::SocketError);
diff --git a/src/QXmppOutgoingServer.h b/src/QXmppOutgoingServer.h
index 5d3e67d4..2a2e2b8b 100644
--- a/src/QXmppOutgoingServer.h
+++ b/src/QXmppOutgoingServer.h
@@ -30,7 +30,7 @@ class QXmppDialback;
 class QXmppOutgoingServer;
 class QXmppOutgoingServerPrivate;
 
-/// The QXmppOutgoingServer class represents an outgoing XMPP stream
+/// \brief The QXmppOutgoingServer class represents an outgoing XMPP stream
 /// to another XMPP server.
 ///
 
@@ -49,11 +49,14 @@ public:
     void setVerify(const QString &id, const QString &key);
 
 signals:
+    /// This signal is emitted when a dialback verify response is received.
     void dialbackResponseReceived(const QXmppDialback &response);
 
 protected:
+    /// \cond
     void handleStart();
     void handleStanza(const QDomElement &stanzaElement);
+    /// \endcond
 
 private:
     Q_DISABLE_COPY(QXmppOutgoingServer)