From 255c1aabcd8d4e881f06ac55eadfc20274936df0 Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Sat, 21 Jul 2012 18:04:02 +0200
Subject: documentation fixes

---
 src/base/QXmppRtpChannel.cpp | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

(limited to 'src/base/QXmppRtpChannel.cpp')

diff --git a/src/base/QXmppRtpChannel.cpp b/src/base/QXmppRtpChannel.cpp
index dcea48e2..93d38b97 100644
--- a/src/base/QXmppRtpChannel.cpp
+++ b/src/base/QXmppRtpChannel.cpp
@@ -367,15 +367,13 @@ QXmppRtpAudioChannel::~QXmppRtpAudioChannel()
 }
 
 /// Returns the number of bytes that are available for reading.
-///
 
 qint64 QXmppRtpAudioChannel::bytesAvailable() const
 {
     return QIODevice::bytesAvailable() + d->incomingBuffer.size();
 }
 
-/// Closes the RTP channel.
-///
+/// Closes the RTP audio channel.
 
 void QXmppRtpAudioChannel::close()
 {
@@ -906,8 +904,7 @@ QXmppRtpVideoChannel::~QXmppRtpVideoChannel()
     delete d;
 }
 
-/// Closes the RTP channel.
-///
+/// Closes the RTP video channel.
 
 void QXmppRtpVideoChannel::close()
 {
@@ -934,6 +931,8 @@ void QXmppRtpVideoChannel::datagramReceived(const QByteArray &ba)
     d->frames << decoder->handlePacket(packet);
 }
 
+/// Returns the video format used by the encoder.
+
 QXmppVideoFormat QXmppRtpVideoChannel::decoderFormat() const
 {
     if (d->decoders.isEmpty())
@@ -942,11 +941,15 @@ QXmppVideoFormat QXmppRtpVideoChannel::decoderFormat() const
     return d->decoders.value(key)->format();
 }
 
+/// Returns the video format used by the encoder.
+
 QXmppVideoFormat QXmppRtpVideoChannel::encoderFormat() const
 {
     return d->outgoingFormat;
 }
 
+/// Sets the video format used by the encoder.
+
 void QXmppRtpVideoChannel::setEncoderFormat(const QXmppVideoFormat &format)
 {
     if (d->encoder && !d->encoder->setFormat(format))
-- 
cgit v1.2.3