From e87083aa769a65d497ecd433520bd3eefe96a06d Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Fri, 10 Dec 2010 11:20:16 +0000
Subject: improve code documentation

---
 src/QXmppOutgoingClient.cpp | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'src/QXmppOutgoingClient.cpp')

diff --git a/src/QXmppOutgoingClient.cpp b/src/QXmppOutgoingClient.cpp
index bb5655e6..9ae68881 100644
--- a/src/QXmppOutgoingClient.cpp
+++ b/src/QXmppOutgoingClient.cpp
@@ -92,6 +92,10 @@ QXmppOutgoingClientPrivate::QXmppOutgoingClientPrivate()
 {
 }
 
+/// Constructs an outgoing client stream.
+///
+/// \param parent
+
 QXmppOutgoingClient::QXmppOutgoingClient(QObject *parent)
     : QXmppStream(parent),
     d(new QXmppOutgoingClientPrivate)
@@ -131,16 +135,22 @@ QXmppOutgoingClient::QXmppOutgoingClient(QObject *parent)
     Q_ASSERT(check);
 }
 
+/// Destroys an outgoing client stream.
+
 QXmppOutgoingClient::~QXmppOutgoingClient()
 {
     delete d;
 }
 
+/// Returns a reference to the stream's configuration.
+
 QXmppConfiguration& QXmppOutgoingClient::configuration()
 {
     return d->config;
 }
 
+/// Attempts to connect to the XMPP server.
+
 void QXmppOutgoingClient::connectToHost()
 {
     const QString host = configuration().host();
-- 
cgit v1.2.3