improve code documentation

3 files changed, 30 insertions, 2 deletions

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();
diff --git a/src/QXmppOutgoingServer.cpp b/src/QXmppOutgoingServer.cpp
index 965d14a6..3e66f5b9 100644
--- a/src/QXmppOutgoingServer.cpp
+++ b/src/QXmppOutgoingServer.cpp
@@ -45,7 +45,6 @@ public:
 
 /// Constructs a new outgoing server-to-server stream.
 ///
-/// \param socket
 /// \param domain the local domain
 /// \param parent the parent object
 ///
@@ -74,6 +73,10 @@ QXmppOutgoingServer::~QXmppOutgoingServer()
     delete d;
 }
 
+/// Attempts to connect to an XMPP server for the specified \a domain.
+///
+/// \param domain
+
 void QXmppOutgoingServer::connectToHost(const QString &domain)
 {
     d->remoteDomain = domain;
@@ -219,22 +222,35 @@ bool QXmppOutgoingServer::isConnected() const
     return QXmppStream::isConnected() && d->ready;
 }
 
+/// Returns the stream's local dialback key.
+
 QString QXmppOutgoingServer::localStreamKey() const
 {
     return d->localStreamKey;
 }
 
+/// Sets the stream's local dialback key.
+///
+/// \param key
+
 void QXmppOutgoingServer::setLocalStreamKey(const QString &key)
 {
     d->localStreamKey = key;
 }
 
+/// Sets the stream's verification information.
+///
+/// \param id
+/// \param key
+
 void QXmppOutgoingServer::setVerify(const QString &id, const QString &key)
 {
     d->verifyId = id;
     d->verifyKey = key;
 }
 
+/// Returns the remote server's domain.
+
 QString QXmppOutgoingServer::remoteDomain() const
 {
     return d->remoteDomain;
diff --git a/src/QXmppStun.h b/src/QXmppStun.h
index 6480cdea..a65ef323 100644
--- a/src/QXmppStun.h
+++ b/src/QXmppStun.h
@@ -33,7 +33,9 @@ class QDataStream;
 class QUdpSocket;
 class QTimer;
 
-/// \brief The QXmppStunMessage class represents a STUN message.
+/// \internal
+///
+/// The QXmppStunMessage class represents a STUN message.
 ///
 
 class QXmppStunMessage