Document QXmppIbb{Open,Close,Data}Iq

2 files changed, 82 insertions, 21 deletions

diff --git a/src/base/QXmppIbbIq.cpp b/src/base/QXmppIbbIq.cpp
index 6f71e588..a950e6d8 100644
--- a/src/base/QXmppIbbIq.cpp
+++ b/src/base/QXmppIbbIq.cpp
@@ -29,25 +29,50 @@
 #include <QDomElement>
 #include <QXmlStreamWriter>
 
+///
+/// \class QXmppIbbOpenIq
+///
+/// The QXmppIbbOpenIq represents an IBB open request as defined by \xep{0047,
+/// In-Band Bytestreams}.
+///
+/// \ingroup Stanzas
+///
+
 QXmppIbbOpenIq::QXmppIbbOpenIq() : QXmppIq(QXmppIq::Set), m_block_size(1024)
 {
 }
 
+///
+/// Returns the maximum size in bytes of each data chunk (which MUST NOT be
+/// greater than 65535).
+///
 long QXmppIbbOpenIq::blockSize() const
 {
     return m_block_size;
 }
 
+///
+/// Sets the maximum size in bytes of each data chunk (which MUST NOT be greater
+/// than 65535).
+///
 void QXmppIbbOpenIq::setBlockSize(long block_size)
 {
     m_block_size = block_size;
 }
 
+///
+/// Returns the unique session ID for this IBB session (which MUST match the
+/// NMTOKEN datatype).
+///
 QString QXmppIbbOpenIq::sid() const
 {
     return m_sid;
 }
 
+///
+/// Sets the unique session ID for this IBB session (which MUST match the
+/// NMTOKEN datatype).
+///
 void QXmppIbbOpenIq::setSid(const QString &sid)
 {
     m_sid = sid;
@@ -77,15 +102,32 @@ void QXmppIbbOpenIq::toXmlElementFromChild(QXmlStreamWriter *writer) const
 }
 /// \endcond
 
+///
+/// \class QXmppIbbCloseIq
+///
+/// The QXmppIbbCloseIq represents an IBB close request as defined by \xep{0047,
+/// In-Band Bytestreams}.
+///
+/// \ingroup Stanzas
+///
+
 QXmppIbbCloseIq::QXmppIbbCloseIq() : QXmppIq(QXmppIq::Set)
 {
 }
 
+///
+/// Returns the unique session ID for this IBB session (which MUST match the
+/// NMTOKEN datatype).
+///
 QString QXmppIbbCloseIq::sid() const
 {
     return m_sid;
 }
 
+///
+/// Sets the unique session ID for this IBB session (which MUST match the
+/// NMTOKEN datatype).
+///
 void QXmppIbbCloseIq::setSid(const QString &sid)
 {
     m_sid = sid;
@@ -113,35 +155,72 @@ void QXmppIbbCloseIq::toXmlElementFromChild(QXmlStreamWriter *writer) const
 }
 /// \endcond
 
+///
+/// \class QXmppIbbCloseIq
+///
+/// The QXmppIbbCloseIq represents an IBB data request as defined by \xep{0047,
+/// In-Band Bytestreams}.
+///
+/// \ingroup Stanzas
+///
+
 QXmppIbbDataIq::QXmppIbbDataIq() : QXmppIq(QXmppIq::Set), m_seq(0)
 {
 }
 
+///
+/// Returns the data chunk sequence counter.
+///
+/// The value starts at 0 (zero) for each sender and MUST be incremented for
+/// each packet sent by that entity. The counter loops at maximum, so that after
+/// value 65535 the sequence MUST start again at 0.
+///
 quint16 QXmppIbbDataIq::sequence() const
 {
     return m_seq;
 }
 
+///
+/// Sets the data chunk sequence counter.
+///
+/// The value starts at 0 (zero) for each sender and MUST be incremented for
+/// each packet sent by that entity. The counter loops at maximum, so that after
+/// value 65535 the sequence MUST start again at 0.
+///
 void QXmppIbbDataIq::setSequence(quint16 seq)
 {
     m_seq = seq;
 }
 
+///
+/// Returns the unique session ID for this IBB session (which MUST match the
+/// NMTOKEN datatype).
+///
 QString QXmppIbbDataIq::sid() const
 {
     return m_sid;
 }
 
+///
+/// Sets the unique session ID for this IBB session (which MUST match the
+/// NMTOKEN datatype).
+///
 void QXmppIbbDataIq::setSid(const QString &sid)
 {
     m_sid = sid;
 }
 
+///
+/// Returns the current data chunk
+///
 QByteArray QXmppIbbDataIq::payload() const
 {
     return m_payload;
 }
 
+///
+/// Sets the current data chunk
+///
 void QXmppIbbDataIq::setPayload(const QByteArray &data)
 {
     m_payload = data;
diff --git a/src/base/QXmppIbbIq.h b/src/base/QXmppIbbIq.h
index 2b0f40c2..10b817a0 100644
--- a/src/base/QXmppIbbIq.h
+++ b/src/base/QXmppIbbIq.h
@@ -27,12 +27,6 @@
 
 #include "QXmppIq.h"
 
-///
-/// \brief QXmppIbbOpenIq represents an IBB open request as defined by
-/// \xep{0047}: In-Band Bytestreams.
-///
-/// \ingroup Stanzas
-///
 class QXmppIbbOpenIq : public QXmppIq
 {
 public:
@@ -44,10 +38,10 @@ public:
     QString sid() const;
     void setSid(const QString &sid);
 
+    /// \cond
     static bool isIbbOpenIq(const QDomElement &element);
 
 protected:
-    /// \cond
     void parseElementFromChild(const QDomElement &element) override;
     void toXmlElementFromChild(QXmlStreamWriter *writer) const override;
     /// \endcond
@@ -57,12 +51,6 @@ private:
     QString m_sid;
 };
 
-///
-/// \brief QXmppIbbCloseIq represents an IBB close request as defined by
-/// \xep{0047}: In-Band Bytestreams.
-///
-/// \ingroup Stanzas
-///
 class QXmppIbbCloseIq : public QXmppIq
 {
 public:
@@ -71,10 +59,10 @@ public:
     QString sid() const;
     void setSid(const QString &sid);
 
+    /// \cond
     static bool isIbbCloseIq(const QDomElement &element);
 
 protected:
-    /// \cond
     void parseElementFromChild(const QDomElement &element) override;
     void toXmlElementFromChild(QXmlStreamWriter *writer) const override;
     /// \endcond
@@ -83,12 +71,6 @@ private:
     QString m_sid;
 };
 
-///
-/// \brief QXmppIbbCloseIq represents an IBB data request as defined by
-/// \xep{0047}: In-Band Bytestreams.
-///
-/// \ingroup Stanzas
-///
 class QXMPP_EXPORT QXmppIbbDataIq : public QXmppIq
 {
 public:
@@ -103,10 +85,10 @@ public:
     QByteArray payload() const;
     void setPayload(const QByteArray &data);
 
+    /// \cond
     static bool isIbbDataIq(const QDomElement &element);
 
 protected:
-    /// \cond
     void parseElementFromChild(const QDomElement &element) override;
     void toXmlElementFromChild(QXmlStreamWriter *writer) const override;
     /// \endcond