diff options
| author | Linus Jahn <lnj@kaidan.im> | 2021-03-27 19:52:15 +0100 |
|---|---|---|
| committer | Linus Jahn <lnj@kaidan.im> | 2021-03-28 00:09:13 +0100 |
| commit | fdbe1aef602b03f35be1d5e9d8baf02fb6c8f00a (patch) | |
| tree | a3a14aca9f32793cca929ca8df635e14abcaacf5 /src/base/QXmppPingIq.cpp | |
| parent | 9fe3a0ed9dbaaf6c94b75830fbf2edee8cf94a58 (diff) | |
doc: Fix many small doxygen warnings
Diffstat (limited to 'src/base/QXmppPingIq.cpp')
| -rw-r--r-- | src/base/QXmppPingIq.cpp | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/src/base/QXmppPingIq.cpp b/src/base/QXmppPingIq.cpp index fab351a0..b2458aa7 100644 --- a/src/base/QXmppPingIq.cpp +++ b/src/base/QXmppPingIq.cpp @@ -28,10 +28,22 @@ #include <QDomElement> -QXmppPingIq::QXmppPingIq() : QXmppIq(QXmppIq::Get) +/// +/// \class QXmppPingIq +/// +/// QXmppPingIq represents a Ping IQ as defined by \xep{0199, XMPP Ping}. +/// +/// \ingroup Stanzas +/// + +QXmppPingIq::QXmppPingIq() + : QXmppIq(QXmppIq::Get) { } +/// +/// Returns true, if the element is a ping IQ. +/// bool QXmppPingIq::isPingIq(const QDomElement &element) { QDomElement pingElement = element.firstChildElement(QStringLiteral("ping")); @@ -39,9 +51,11 @@ bool QXmppPingIq::isPingIq(const QDomElement &element) pingElement.namespaceURI() == ns_ping); } +/// \cond void QXmppPingIq::toXmlElementFromChild(QXmlStreamWriter *writer) const { writer->writeStartElement(QStringLiteral("ping")); writer->writeDefaultNamespace(ns_ping); writer->writeEndElement(); } +/// \endcond |