From b545b9df092f805d7c52c946b41d1f3035057df2 Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Fri, 10 Dec 2010 08:26:16 +0000
Subject: improve code documentation for QXmppIceComponent / QXmppIceConnection

---
 src/QXmppStun.cpp | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

(limited to 'src/QXmppStun.cpp')

diff --git a/src/QXmppStun.cpp b/src/QXmppStun.cpp
index 28986cce..69f582d8 100644
--- a/src/QXmppStun.cpp
+++ b/src/QXmppStun.cpp
@@ -987,16 +987,28 @@ QXmppIceComponent::Pair *QXmppIceComponent::addRemoteCandidate(QUdpSocket *socke
     return pair;
 }
 
+/// Sets the remote user fragment.
+///
+/// \param user
+
 void QXmppIceComponent::setRemoteUser(const QString &user)
 {
     m_remoteUser = user;
 }
 
+/// Sets the remote password.
+///
+/// \param password
+
 void QXmppIceComponent::setRemotePassword(const QString &password)
 {
     m_remotePassword = password;
 }
 
+/// Sets the list of sockets to use for this component.
+///
+/// \param sockets
+
 void QXmppIceComponent::setSockets(QList<QUdpSocket*> sockets)
 {
     // clear previous candidates and sockets
@@ -1034,6 +1046,12 @@ void QXmppIceComponent::setSockets(QList<QUdpSocket*> sockets)
     }
 }
 
+/// Sets the STUN server to use to determine server-reflexive addresses
+/// and ports.
+///
+/// \param host The address of the STUN server.
+/// \param port The port of the STUN server.
+
 void QXmppIceComponent::setStunServer(const QHostAddress &host, quint16 port)
 {
     m_stunHost = host;
@@ -1518,6 +1536,12 @@ void QXmppIceConnection::setRemotePassword(const QString &password)
         socket->setRemotePassword(password);
 }
 
+/// Sets the STUN server to use to determine server-reflexive addresses
+/// and ports.
+///
+/// \param hostName The host name or address of the STUN server.
+/// \param port     The port of the STUN server.
+
 void QXmppIceConnection::setStunServer(const QString &hostName, quint16 port)
 {
     // lookup STUN server
-- 
cgit v1.2.3