improve code documentation for QXmppIceComponent / QXmppIceConnection

2 files changed, 29 insertions, 5 deletions

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
diff --git a/src/QXmppStun.h b/src/QXmppStun.h
index 40cb87a7..6480cdea 100644
--- a/src/QXmppStun.h
+++ b/src/QXmppStun.h
@@ -108,8 +108,8 @@ private:
     QString m_software;
 };
 
-/// The QXmppIceComponent class represents a piece of a media stream
-/// requiring a single transport address, as defined by RFC 2525
+/// \brief The QXmppIceComponent class represents a piece of a media stream
+/// requiring a single transport address, as defined by RFC 5245
 /// (Interactive Connectivity Establishment).
 
 class QXmppIceComponent : public QXmppLoggable
@@ -227,13 +227,13 @@ public:
     bool isConnected() const;
 
 signals:
-    // This signal is emitted once ICE negotiation succeeds.
+    /// \brief This signal is emitted once ICE negotiation succeeds.
     void connected();
 
-    // This signal is emitted when ICE negotiation fails.
+    /// \brief This signal is emitted when ICE negotiation fails.
     void disconnected();
 
-    // This signal is emitted when the list of local candidates changes.
+    /// \brief This signal is emitted when the list of local candidates changes.
     void localCandidatesChanged();
 
 public slots: