improve code documentation

3 files changed, 53 insertions, 0 deletions

diff --git a/source/QXmppJingleIq.cpp b/source/QXmppJingleIq.cpp
index df1f133a..066476fe 100644
--- a/source/QXmppJingleIq.cpp
+++ b/source/QXmppJingleIq.cpp
@@ -535,62 +535,103 @@ QXmppJinglePayloadType::QXmppJinglePayloadType()
 {
 }
 
+/// Returns the number of channels (e.g. 1 for mono, 2 for stereo).
+///
+
 unsigned char QXmppJinglePayloadType::channels() const
 {
     return m_channels;
 }
 
+/// Sets the number of channels (e.g. 1 for mono, 2 for stereo).
+///
+/// \param channels
+
 void QXmppJinglePayloadType::setChannels(unsigned char channels)
 {
     m_channels = channels;
 }
 
+/// Returns the clockrate in Hz, i.e. the number of samples per second.
+///
+
 unsigned int QXmppJinglePayloadType::clockrate() const
 {
     return m_clockrate;
 }
 
+/// Sets the clockrate in Hz, i.e. the number of samples per second.
+///
+/// \param clockrate
+
 void QXmppJinglePayloadType::setClockrate(unsigned int clockrate)
 {
     m_clockrate = clockrate;
 }
 
+/// Returns the payload type identifier.
+///
+
 unsigned char QXmppJinglePayloadType::id() const
 {
     return m_id;
 }
 
+/// Sets the payload type identifier.
+///
+
 void QXmppJinglePayloadType::setId(unsigned char id)
 {
     Q_ASSERT(id <= 127);
     m_id = id;
 }
 
+/// Returns the maximum packet time in milliseconds.
+///
+
 unsigned int QXmppJinglePayloadType::maxptime() const
 {
     return m_maxptime;
 }
 
+/// Sets the maximum packet type in milliseconds.
+///
+/// \param maxptime
+
 void QXmppJinglePayloadType::setMaxptime(unsigned int maxptime)
 {
     m_maxptime = maxptime;
 }
 
+/// Returns the payload type name.
+///
+
 QString QXmppJinglePayloadType::name() const
 {
     return m_name;
 }
 
+/// Sets the payload type name.
+///
+/// \param name
+
 void QXmppJinglePayloadType::setName(const QString &name)
 {
     m_name = name;
 }
 
+/// Returns the packet time in milliseconds (20 by default).
+///
+
 unsigned int QXmppJinglePayloadType::ptime() const
 {
     return m_ptime ? m_ptime : 20;
 }
 
+/// Sets the packet time in milliseconds (20 by default).
+///
+/// \param ptime
+
 void QXmppJinglePayloadType::setPtime(unsigned int ptime)
 {
     m_ptime = ptime;
diff --git a/source/QXmppJingleIq.h b/source/QXmppJingleIq.h
index 94639a9c..611ef3ed 100644
--- a/source/QXmppJingleIq.h
+++ b/source/QXmppJingleIq.h
@@ -28,6 +28,10 @@
 
 #include "QXmppIq.h"
 
+/// \brief The QXmppJinglePayloadType class represents a payload type
+/// as specified by XEP-0167: Jingle RTP Sessions.
+///
+
 class QXmppJinglePayloadType
 {
 public:
@@ -65,6 +69,10 @@ private:
     unsigned int m_ptime;
 };
 
+/// \brief The QXmppJingleCandidate class represents a transport candidate
+/// as specified by XEP-0176: Jingle ICE-UDP Transport Method.
+///
+
 class QXmppJingleCandidate
 {
 public:
@@ -267,8 +275,10 @@ public:
     static bool isJingleIq(const QDomElement &element);
 
 protected:
+    /// \cond
     void parseElementFromChild(const QDomElement &element);
     void toXmlElementFromChild(QXmlStreamWriter *writer) const;
+    /// \endcond
 
 private:
     Action m_action;
diff --git a/source/QXmppVersionIq.h b/source/QXmppVersionIq.h
index 93d91cbd..46bd5714 100644
--- a/source/QXmppVersionIq.h
+++ b/source/QXmppVersionIq.h
@@ -46,8 +46,10 @@ public:
     static bool isVersionIq(const QDomElement &element);
 
 protected:
+    /// \cond
     void parseElementFromChild(const QDomElement &element);
     void toXmlElementFromChild(QXmlStreamWriter *writer) const;
+    /// \endcond
 
 private:
     QString m_name;