From 05cca0d54af0409aaa10fe758a3ba32f84c5e83b Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Mon, 23 Aug 2010 07:26:26 +0000
Subject: add code documentation for incoming S2S stream

---
 src/QXmppIncomingServer.cpp | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

(limited to 'src')

diff --git a/src/QXmppIncomingServer.cpp b/src/QXmppIncomingServer.cpp
index 24775360..46e00ba9 100644
--- a/src/QXmppIncomingServer.cpp
+++ b/src/QXmppIncomingServer.cpp
@@ -40,6 +40,13 @@ public:
     QString localStreamId;
 };
 
+/// Constructs a new incoming server stream.
+///
+/// \param socket The socket for the XMPP stream.
+/// \param domain The local domain.
+/// \param parent The parent QObject for the stream (optional).
+///
+
 QXmppIncomingServer::QXmppIncomingServer(QSslSocket *socket, const QString &domain, QObject *parent)
     : QXmppStream(parent),
     d(new QXmppIncomingServerPrivate)
@@ -50,11 +57,21 @@ QXmppIncomingServer::QXmppIncomingServer(QSslSocket *socket, const QString &doma
     d->domain = domain;
 }
 
+/// Destroys the current stream.
+
 QXmppIncomingServer::~QXmppIncomingServer()
 {
     delete d;
 }
 
+/// Returns the stream's identifier.
+///
+
+QString QXmppIncomingServer::localStreamId() const
+{
+    return d->localStreamId;
+}
+
 void QXmppIncomingServer::handleStream(const QDomElement &streamElement)
 {
     if (!streamElement.attribute("from").isEmpty())
@@ -133,11 +150,6 @@ void QXmppIncomingServer::handleStanza(const QDomElement &stanza)
     }
 }
 
-QString QXmppIncomingServer::localStreamId() const
-{
-    return d->localStreamId;
-}
-
 /// Handles a dialback response received from the authority server.
 ///
 /// \param response
@@ -174,4 +186,3 @@ void QXmppIncomingServer::slotDialbackResponseReceived(const QXmppDialback &dial
     stream->deleteLater();
 }
 
-
-- 
cgit v1.2.3