From dd72f41b408595624dee2e034d0b1eefc78a7d3d Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Thu, 10 May 2012 10:40:13 +0200
Subject: fix doc warnings

---
 src/base/QXmppPresence.h     |  3 ++-
 src/base/QXmppRtpChannel.cpp | 14 +++++++++++---
 src/base/QXmppRtpChannel.h   |  2 ++
 3 files changed, 15 insertions(+), 4 deletions(-)

(limited to 'src/base')

diff --git a/src/base/QXmppPresence.h b/src/base/QXmppPresence.h
index e0a8e8f5..848bced3 100644
--- a/src/base/QXmppPresence.h
+++ b/src/base/QXmppPresence.h
@@ -47,7 +47,8 @@ public:
         Probe           ///< A request for an entity's current presence; SHOULD be generated only by a server on behalf of a user.
     };
 
-    // XEP-0153: vCard-Based Avatars
+    /// This enum is used to describe vCard updates as defined by
+    /// XEP-0153: vCard-Based Avatars
     enum VCardUpdateType
     {
         VCardUpdateNone = 0,    ///< Protocol is not supported
diff --git a/src/base/QXmppRtpChannel.cpp b/src/base/QXmppRtpChannel.cpp
index 788e9a57..ab69e3ba 100644
--- a/src/base/QXmppRtpChannel.cpp
+++ b/src/base/QXmppRtpChannel.cpp
@@ -307,9 +307,7 @@ QXmppCodec *QXmppRtpAudioChannelPrivate::codecForPayloadType(const QXmppJinglePa
     return 0;
 }
 
-/// Creates a new RTP audio channel.
-///
-/// \param parent
+/// Constructs a new RTP audio channel with the given \a parent.
 
 QXmppRtpAudioChannel::QXmppRtpAudioChannel(QObject *parent)
     : QIODevice(parent)
@@ -490,6 +488,8 @@ bool QXmppRtpAudioChannel::isSequential() const
     return true;
 }
 
+/// Returns the mode in which the channel has been opened.
+
 QIODevice::OpenMode QXmppRtpAudioChannel::openMode() const
 {
     return QIODevice::openMode();
@@ -858,6 +858,8 @@ QXmppRtpVideoChannelPrivate::QXmppRtpVideoChannelPrivate()
     outgoingSsrc = qrand();
 }
 
+/// Constructs a new RTP video channel with the given \a parent.
+
 QXmppRtpVideoChannel::QXmppRtpVideoChannel(QObject *parent)
     : QXmppLoggable(parent)
 {
@@ -952,6 +954,8 @@ void QXmppRtpVideoChannel::setEncoderFormat(const QXmppVideoFormat &format)
     d->outgoingFormat = format;
 }
 
+/// Returns the mode in which the channel has been opened.
+
 QIODevice::OpenMode QXmppRtpVideoChannel::openMode() const
 {
     QIODevice::OpenMode mode = QIODevice::NotOpen;
@@ -1013,6 +1017,8 @@ void QXmppRtpVideoChannel::payloadTypesChanged()
     }
 }
 
+/// Decodes buffered RTP packets and returns a list of video frames.
+
 QList<QXmppVideoFrame> QXmppRtpVideoChannel::readFrames()
 {
     const QList<QXmppVideoFrame> frames = d->frames;
@@ -1020,6 +1026,8 @@ QList<QXmppVideoFrame> QXmppRtpVideoChannel::readFrames()
     return frames;
 }
 
+/// Encodes a video \a frame and sends RTP packets.
+
 void QXmppRtpVideoChannel::writeFrame(const QXmppVideoFrame &frame)
 {
     if (!d->encoder) {
diff --git a/src/base/QXmppRtpChannel.h b/src/base/QXmppRtpChannel.h
index ae92741a..e18f031e 100644
--- a/src/base/QXmppRtpChannel.h
+++ b/src/base/QXmppRtpChannel.h
@@ -279,7 +279,9 @@ public slots:
     void datagramReceived(const QByteArray &ba);
 
 protected:
+    /// cond
     void payloadTypesChanged();
+    /// \endcond
 
 private:
     friend class QXmppRtpVideoChannelPrivate;
-- 
cgit v1.2.3