From ccb60b7970adeb4d11a02d41cecb607e331ef52e Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Mon, 23 Aug 2010 07:40:00 +0000
Subject: add code documentation to stream classes

---
 src/QXmppOutgoingClient.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'src/QXmppOutgoingClient.h')

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);
-- 
cgit v1.2.3