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

---
 src/QXmppServer.cpp  | 13 +++++++++++++
 src/QXmppServer.h    |  1 +
 src/QXmppSrvInfo.cpp |  4 ++--
 src/QXmppSrvInfo.h   |  1 +
 4 files changed, 17 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/QXmppServer.cpp b/src/QXmppServer.cpp
index b6b95d4b..043f8011 100644
--- a/src/QXmppServer.cpp
+++ b/src/QXmppServer.cpp
@@ -790,16 +790,29 @@ void QXmppSslServer::incomingConnection(int socketDescriptor)
     emit newConnection(socket);
 }
 
+/// Adds the given certificates to the CA certificate database to be used
+/// for incoming connnections.
+///
+/// \param caCertificates
+
 void QXmppSslServer::addCaCertificates(const QString &caCertificates)
 {
     d->caCertificates = caCertificates;
 }
 
+/// Sets the local certificate to be used for incoming connections.
+///
+/// \param localCertificate
+
 void QXmppSslServer::setLocalCertificate(const QString &localCertificate)
 {
     d->localCertificate = localCertificate;
 }
 
+/// Sets the local private key to be used for incoming connections.
+///
+/// \param privateKey
+
 void QXmppSslServer::setPrivateKey(const QString &privateKey)
 {
     d->privateKey = privateKey;
diff --git a/src/QXmppServer.h b/src/QXmppServer.h
index 38f9efed..252f13f9 100644
--- a/src/QXmppServer.h
+++ b/src/QXmppServer.h
@@ -118,6 +118,7 @@ public:
     void setPrivateKey(const QString &privateKey);
 
 signals:
+    /// This signal is emitted when a new connection is established.
     void newConnection(QSslSocket *socket);
 
 private:
diff --git a/src/QXmppSrvInfo.cpp b/src/QXmppSrvInfo.cpp
index 7c2b06d8..1de267a6 100644
--- a/src/QXmppSrvInfo.cpp
+++ b/src/QXmppSrvInfo.cpp
@@ -205,7 +205,7 @@ QString QXmppSrvRecord::target() const
 
 /// Sets the host name for this service record.
 ///
-/// \param hostName
+/// \param target
 
 void QXmppSrvRecord::setTarget(const QString &target)
 {
@@ -256,7 +256,7 @@ quint16 QXmppSrvRecord::weight() const
 
 /// Sets the weight for this service record.
 ///
-/// \param priority
+/// \param weight
 
 void QXmppSrvRecord::setWeight(quint16 weight)
 {
diff --git a/src/QXmppSrvInfo.h b/src/QXmppSrvInfo.h
index 6a009fdf..3e4f6c89 100644
--- a/src/QXmppSrvInfo.h
+++ b/src/QXmppSrvInfo.h
@@ -65,6 +65,7 @@ private:
 class QXmppSrvInfo
 {
 public:
+    /// This enum is used to describe the error encountered during lookup.
     enum Error
     {
         NoError = 0,
-- 
cgit v1.2.3