diff options
| author | Linus Jahn <lnj@kaidan.im> | 2020-03-11 19:53:00 +0100 |
|---|---|---|
| committer | Linus Jahn <lnj@kaidan.im> | 2020-03-11 19:53:00 +0100 |
| commit | a7f801700291b7a42dd8191e3fc6f5ffe1072550 (patch) | |
| tree | 49e4208c3984210ccaa1a718c20c05386d7ad8c6 /src/base | |
| parent | 46c5e6b9dfc6d125d5608cf80603f0df87655f83 (diff) | |
| download | qxmpp-a7f801700291b7a42dd8191e3fc6f5ffe1072550.tar.gz | |
Add missing class documentation to trigger doxygen page generation
Diffstat (limited to 'src/base')
| -rw-r--r-- | src/base/QXmppByteStreamIq.h | 8 | ||||
| -rw-r--r-- | src/base/QXmppDiscoveryIq.h | 16 | ||||
| -rw-r--r-- | src/base/QXmppElement.h | 4 | ||||
| -rw-r--r-- | src/base/QXmppEntityTimeIq.h | 6 | ||||
| -rw-r--r-- | src/base/QXmppIbbIq.h | 18 | ||||
| -rw-r--r-- | src/base/QXmppMamIq.h | 8 | ||||
| -rw-r--r-- | src/base/QXmppNonSASLAuth.h | 6 | ||||
| -rw-r--r-- | src/base/QXmppPingIq.h | 6 | ||||
| -rw-r--r-- | src/base/QXmppStartTlsPacket.h | 5 |
9 files changed, 75 insertions, 2 deletions
diff --git a/src/base/QXmppByteStreamIq.h b/src/base/QXmppByteStreamIq.h index 1e2cdb07..b22d8e5d 100644 --- a/src/base/QXmppByteStreamIq.h +++ b/src/base/QXmppByteStreamIq.h @@ -28,6 +28,10 @@ #include <QHostAddress> +/// +/// \brief QXmppByteStreamIq represents a SOCKS5 bytestreams negoatiation IQ as +/// defined by \xep{0065}: SOCKS5 Bytestreams. +/// class QXMPP_EXPORT QXmppByteStreamIq : public QXmppIq { public: @@ -37,6 +41,10 @@ public: Udp }; + /// + /// \brief StreamHost represents information about a specific SOCKS5 + /// bytestreams host. + /// class QXMPP_EXPORT StreamHost { public: diff --git a/src/base/QXmppDiscoveryIq.h b/src/base/QXmppDiscoveryIq.h index d4502eb1..cd78802d 100644 --- a/src/base/QXmppDiscoveryIq.h +++ b/src/base/QXmppDiscoveryIq.h @@ -33,9 +33,21 @@ class QXmppDiscoveryIdentityPrivate; class QXmppDiscoveryItemPrivate; class QXmppDiscoveryIqPrivate; +/// +/// \brief QXmppDiscoveryIq represents a discovery IQ request or result +/// containing a list of features and other information about an entity as +/// defined by \xep{0030}: Service Discovery. +/// +/// \ingroup Stanzas +/// class QXMPP_EXPORT QXmppDiscoveryIq : public QXmppIq { public: + /// + /// \brief Identity represents one of possibly multiple identities of an + /// XMPP entity obtained from a service discovery request as defined in + /// \xep{0030}: Service Discovery. + /// class QXMPP_EXPORT Identity { public: @@ -61,6 +73,10 @@ public: QSharedDataPointer<QXmppDiscoveryIdentityPrivate> d; }; + /// + /// \brief Item represents a related XMPP entity that can be queried using + /// \xep{0030}: Service Discovery. + /// class QXMPP_EXPORT Item { public: diff --git a/src/base/QXmppElement.h b/src/base/QXmppElement.h index 99f58989..ad10c13e 100644 --- a/src/base/QXmppElement.h +++ b/src/base/QXmppElement.h @@ -35,6 +35,10 @@ class QXmppElement; class QXmppElementPrivate; using QXmppElementList = QList<QXmppElement>; + +/// +/// \brief QXmppElement represents a raw XML element with possible children. +/// class QXMPP_EXPORT QXmppElement { public: diff --git a/src/base/QXmppEntityTimeIq.h b/src/base/QXmppEntityTimeIq.h index ba9b5629..d9fb85d0 100644 --- a/src/base/QXmppEntityTimeIq.h +++ b/src/base/QXmppEntityTimeIq.h @@ -28,8 +28,12 @@ #include <QDateTime> +/// +/// \brief QXmppEntityTimeIq represents an entity time request/response as +/// defined in \xep{0202}: Entity Time. +/// /// \ingroup Stanzas - +/// class QXMPP_EXPORT QXmppEntityTimeIq : public QXmppIq { public: diff --git a/src/base/QXmppIbbIq.h b/src/base/QXmppIbbIq.h index a9e3ce0f..f38dc917 100644 --- a/src/base/QXmppIbbIq.h +++ b/src/base/QXmppIbbIq.h @@ -27,6 +27,12 @@ #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: @@ -51,6 +57,12 @@ 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,6 +83,12 @@ 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: diff --git a/src/base/QXmppMamIq.h b/src/base/QXmppMamIq.h index 0047a370..96c8f719 100644 --- a/src/base/QXmppMamIq.h +++ b/src/base/QXmppMamIq.h @@ -33,8 +33,12 @@ class QXmppMamQueryIqPrivate; class QXmppMamResultIqPrivate; +/// /// \brief The QXmppMamQueryIq class represents the query IQ for /// \xep{0313}: Message Archive Management. +/// +/// \ingroup Stanzas +/// class QXmppMamQueryIq : public QXmppIq { public: @@ -63,8 +67,12 @@ private: QSharedDataPointer<QXmppMamQueryIqPrivate> d; }; +/// /// \brief The QXmppMamQueryIq class represents the result IQ for /// \xep{0313}: Message Archive Management. +/// +/// \ingroup Stanzas +/// class QXmppMamResultIq : public QXmppIq { public: diff --git a/src/base/QXmppNonSASLAuth.h b/src/base/QXmppNonSASLAuth.h index df9517a8..652c8009 100644 --- a/src/base/QXmppNonSASLAuth.h +++ b/src/base/QXmppNonSASLAuth.h @@ -26,6 +26,12 @@ #include "QXmppIq.h" +/// +/// \brief QXmppNonSASLAuthIq represents a Non-SASL authentication IQ as +/// defined by \xep{0078}: Non-SASL Authentication. +/// +/// \ingroup Stanzas +/// class QXMPP_EXPORT QXmppNonSASLAuthIq : public QXmppIq { public: diff --git a/src/base/QXmppPingIq.h b/src/base/QXmppPingIq.h index 9120340c..a856ff1c 100644 --- a/src/base/QXmppPingIq.h +++ b/src/base/QXmppPingIq.h @@ -26,6 +26,12 @@ #include "QXmppIq.h" +/// +/// \brief QXmppPingIq represents a Ping IQ as defined by \xep{0199}: XMPP +/// Ping. +/// +/// \ingroup Stanzas +/// class QXMPP_EXPORT QXmppPingIq : public QXmppIq { public: diff --git a/src/base/QXmppStartTlsPacket.h b/src/base/QXmppStartTlsPacket.h index 26c8dfbb..a330e234 100644 --- a/src/base/QXmppStartTlsPacket.h +++ b/src/base/QXmppStartTlsPacket.h @@ -26,9 +26,12 @@ #include "QXmppStanza.h" +/// /// \brief The QXmppStartTlsPacket represents packets used for initiating /// STARTTLS negotiation when connecting. - +/// +/// \ingroup Stanzas +/// class QXMPP_EXPORT QXmppStartTlsPacket : public QXmppStanza { public: |
