fix some doc warnings

2 files changed, 30 insertions, 14 deletions

diff --git a/src/base/QXmppCodec.h b/src/base/QXmppCodec.h
index 8a0e81d6..3af14d7d 100644
--- a/src/base/QXmppCodec.h
+++ b/src/base/QXmppCodec.h
@@ -115,8 +115,14 @@ class QXMPP_EXPORT QXmppVideoDecoder
 {
 public:
     virtual ~QXmppVideoDecoder();
+
+    /// Returns the format of the video stream.
     virtual QXmppVideoFormat format() const = 0;
+
+    /// Handles an RTP \a packet and returns a list of decoded video frames.
     virtual QList<QXmppVideoFrame> handlePacket(const QXmppRtpPacket &packet) = 0;
+
+    /// Sets the video stream's \a parameters.
     virtual bool setParameters(const QMap<QString, QString> &parameters) = 0;
 };
 
@@ -127,8 +133,14 @@ class QXMPP_EXPORT QXmppVideoEncoder
 {
 public:
     virtual ~QXmppVideoEncoder();
+
+    /// Sets the \a format of the video stream.
     virtual bool setFormat(const QXmppVideoFormat &format) = 0;
+
+    /// Handles a video \a frame and returns a list of RTP packet payloads.
     virtual QList<QByteArray> handleFrame(const QXmppVideoFrame &frame) = 0;
+
+    /// Returns the video stream's parameters.
     virtual QMap<QString, QString> parameters() const = 0;
 };
 
diff --git a/src/base/QXmppRtpChannel.cpp b/src/base/QXmppRtpChannel.cpp
index 190a414b..788e9a57 100644
--- a/src/base/QXmppRtpChannel.cpp
+++ b/src/base/QXmppRtpChannel.cpp
@@ -767,32 +767,36 @@ QXmppVideoFrame::QXmppVideoFrame(int bytes, const QSize &size, int bytesPerLine,
     m_data.resize(bytes);
 }
 
+/// Returns a pointer to the start of the frame data buffer.
+
 uchar *QXmppVideoFrame::bits()
 {
     return (uchar*)m_data.data();
 }
 
+/// Returns a pointer to the start of the frame data buffer.
+
 const uchar *QXmppVideoFrame::bits() const
 {
     return (const uchar*)m_data.constData();
 }
 
-/** Returns the number of bytes in a scan line.
- */
+/// Returns the number of bytes in a scan line.
+
 int QXmppVideoFrame::bytesPerLine() const
 {
     return m_bytesPerLine;
 }
 
-/** Returns the height of a video frame.
- */
+/// Returns the height of a video frame.
+
 int QXmppVideoFrame::height() const
 {
     return m_height;
 }
 
-/** Returns true if the frame is valid.
- */
+/// Returns true if the frame is valid.
+
 bool QXmppVideoFrame::isValid() const
 {
     return m_pixelFormat != Format_Invalid &&
@@ -800,29 +804,29 @@ bool QXmppVideoFrame::isValid() const
            m_mappedBytes > 0;
 }
 
-/** Returns the number of bytes occupied by the mapped frame data.
- */
+/// Returns the number of bytes occupied by the mapped frame data.
+
 int QXmppVideoFrame::mappedBytes() const
 {
     return m_mappedBytes;
 }
 
-/** Returns the color format of a video frame.
- */
+/// Returns the color format of a video frame.
+
 QXmppVideoFrame::PixelFormat QXmppVideoFrame::pixelFormat() const
 {
     return m_pixelFormat;
 }
 
-/** Returns the size of a video frame.
- */
+/// Returns the size of a video frame.
+
 QSize QXmppVideoFrame::size() const
 {
     return QSize(m_width, m_height);
 }
 
-/** Returns the width of a video frame.
- */
+/// Returns the width of a video frame.
+
 int QXmppVideoFrame::width() const
 {
     return m_width;