From d8dbd2b963adf4774ca600fca729bf9ae1a41fef Mon Sep 17 00:00:00 2001
From: Linus Jahn <lnj@kaidan.im>
Date: Fri, 2 Apr 2021 16:48:39 +0200
Subject: Document QXmppIbb{Open,Close,Data}Iq

---
 src/base/QXmppIbbIq.cpp | 79 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)

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

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;
-- 
cgit v1.2.3