diff options
| author | Jeremy Lainé <jeremy.laine@m4x.org> | 2010-12-10 08:26:16 +0000 |
|---|---|---|
| committer | Jeremy Lainé <jeremy.laine@m4x.org> | 2010-12-10 08:26:16 +0000 |
| commit | b545b9df092f805d7c52c946b41d1f3035057df2 (patch) | |
| tree | 883b009e5cb8fdbe8981ab83a324175c38918f78 /src/QXmppStun.h | |
| parent | 64a0e58b40e7ee8422d56279882caeeb14152b2b (diff) | |
| download | qxmpp-b545b9df092f805d7c52c946b41d1f3035057df2.tar.gz | |
improve code documentation for QXmppIceComponent / QXmppIceConnection
Diffstat (limited to 'src/QXmppStun.h')
| -rw-r--r-- | src/QXmppStun.h | 10 |
1 files changed, 5 insertions, 5 deletions
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: |
