doc fixes

2 files changed, 24 insertions, 25 deletions

diff --git a/src/base/QXmppRtpChannel.cpp b/src/base/QXmppRtpChannel.cpp
index 93d38b97..3abbf4ca 100644
--- a/src/base/QXmppRtpChannel.cpp
+++ b/src/base/QXmppRtpChannel.cpp
@@ -167,10 +167,6 @@ void QXmppRtpChannel::setRemotePayloadTypes(const QList<QXmppJinglePayloadType>
     payloadTypesChanged();
 }
 
-void QXmppRtpChannel::payloadTypesChanged()
-{
-}
-
 enum CodecId {
     G711u = 0,
     GSM = 3,
@@ -493,6 +489,17 @@ QIODevice::OpenMode QXmppRtpAudioChannel::openMode() const
     return QIODevice::openMode();
 }
 
+/// Returns the RTP channel's payload type.
+///
+/// You can use this to determine the QAudioFormat to use with your
+/// QAudioInput/QAudioOutput.
+
+QXmppJinglePayloadType QXmppRtpAudioChannel::payloadType() const
+{
+    return d->payloadType;
+}
+
+/// \cond
 qint64 QXmppRtpAudioChannel::readData(char * data, qint64 maxSize)
 {
     // if we are filling the buffer, return empty samples
@@ -531,16 +538,6 @@ qint64 QXmppRtpAudioChannel::readData(char * data, qint64 maxSize)
     return maxSize;
 }
 
-/// Returns the RTP channel's payload type.
-///
-/// You can use this to determine the QAudioFormat to use with your
-/// QAudioInput/QAudioOutput.
-
-QXmppJinglePayloadType QXmppRtpAudioChannel::payloadType() const
-{
-    return d->payloadType;
-}
-
 void QXmppRtpAudioChannel::payloadTypesChanged()
 {
     // delete incoming codecs
@@ -578,6 +575,7 @@ void QXmppRtpAudioChannel::payloadTypesChanged()
 
     open(QIODevice::ReadWrite | QIODevice::Unbuffered);
 }
+/// \endcond
 
 /// Returns the position in the received audio data.
 
@@ -632,6 +630,7 @@ void QXmppRtpAudioChannel::stopTone(QXmppRtpAudioChannel::Tone tone)
     }
 }
 
+/// \cond
 qint64 QXmppRtpAudioChannel::writeData(const char * data, qint64 maxSize)
 {
     if (!d->outgoingCodec) {
@@ -647,6 +646,7 @@ qint64 QXmppRtpAudioChannel::writeData(const char * data, qint64 maxSize)
 
     return maxSize;
 }
+/// \endcond
 
 void QXmppRtpAudioChannel::writeDatagram()
 {
@@ -969,6 +969,7 @@ QIODevice::OpenMode QXmppRtpVideoChannel::openMode() const
     return mode;
 }
 
+/// \cond
 void QXmppRtpVideoChannel::payloadTypesChanged()
 {
     // refresh decoders
@@ -1019,6 +1020,7 @@ void QXmppRtpVideoChannel::payloadTypesChanged()
         }
     }
 }
+/// \endcond
 
 /// Decodes buffered RTP packets and returns a list of video frames.
 
diff --git a/src/base/QXmppRtpChannel.h b/src/base/QXmppRtpChannel.h
index 1511e597..73680af7 100644
--- a/src/base/QXmppRtpChannel.h
+++ b/src/base/QXmppRtpChannel.h
@@ -70,14 +70,16 @@ public:
 
     /// Closes the RTP channel.
     virtual void close() = 0;
-    /// Returns the RTP channel's current read/write mode.
+
+    /// Returns the mode in which the channel has been opened.
     virtual QIODevice::OpenMode openMode() const = 0;
+
     QList<QXmppJinglePayloadType> localPayloadTypes();
     void setRemotePayloadTypes(const QList<QXmppJinglePayloadType> &remotePayloadTypes);
 
 protected:
     /// \cond
-    virtual void payloadTypesChanged();
+    virtual void payloadTypesChanged() = 0;
 
     QList<QXmppJinglePayloadType> m_incomingPayloadTypes;
     QList<QXmppJinglePayloadType> m_outgoingPayloadTypes;
@@ -121,16 +123,13 @@ public:
     QXmppRtpAudioChannel(QObject *parent = 0);
     ~QXmppRtpAudioChannel();
 
-    QXmppJinglePayloadType payloadType() const;
-
-    /// \cond
     qint64 bytesAvailable() const;
     void close();
     bool isSequential() const;
     QIODevice::OpenMode openMode() const;
+    QXmppJinglePayloadType payloadType() const;
     qint64 pos() const;
     bool seek(qint64 pos);
-    /// \endcond
 
 signals:
     /// \brief This signal is emitted when a datagram needs to be sent.
@@ -283,6 +282,9 @@ public:
     QXmppRtpVideoChannel(QObject *parent = 0);
     ~QXmppRtpVideoChannel();
 
+    void close();
+    QIODevice::OpenMode openMode() const;
+
     // incoming stream
     QXmppVideoFormat decoderFormat() const;
     QList<QXmppVideoFrame> readFrames();
@@ -292,11 +294,6 @@ public:
     void setEncoderFormat(const QXmppVideoFormat &format);
     void writeFrame(const QXmppVideoFrame &frame);
 
-    /// \cond
-    QIODevice::OpenMode openMode() const;
-    void close();
-    /// \endcond
-
 signals:
     /// \brief This signal is emitted when a datagram needs to be sent.
     void sendDatagram(const QByteArray &ba);