aboutsummaryrefslogtreecommitdiff
path: root/src/base
diff options
context:
space:
mode:
authorLinus Jahn <lnj@kaidan.im>2020-02-11 17:12:45 +0100
committerLinus Jahn <lnj@kaidan.im>2020-02-11 17:12:45 +0100
commitbc4c3ee94442c9b80993ce109d5070862dc9f170 (patch)
treeb782a135e84dfcbeb33254df8a33bf7fe53fb786 /src/base
parent776f028d9f3f51e9dbba834a01d1decd737c4a27 (diff)
downloadqxmpp-bc4c3ee94442c9b80993ce109d5070862dc9f170.tar.gz
doc: Use XEP links everywhere
Diffstat (limited to 'src/base')
-rw-r--r--src/base/QXmppArchiveIq.h14
-rw-r--r--src/base/QXmppBitsOfBinaryContentId.cpp8
-rw-r--r--src/base/QXmppBitsOfBinaryContentId.h2
-rw-r--r--src/base/QXmppBitsOfBinaryData.cpp2
-rw-r--r--src/base/QXmppBitsOfBinaryData.h2
-rw-r--r--src/base/QXmppBitsOfBinaryDataList.h2
-rw-r--r--src/base/QXmppBitsOfBinaryIq.cpp2
-rw-r--r--src/base/QXmppBitsOfBinaryIq.h2
-rw-r--r--src/base/QXmppBookmarkSet.h6
-rw-r--r--src/base/QXmppDataForm.cpp12
-rw-r--r--src/base/QXmppDataForm.h8
-rw-r--r--src/base/QXmppDiscoveryIq.cpp6
-rw-r--r--src/base/QXmppHttpUploadIq.h4
-rw-r--r--src/base/QXmppJingleIq.cpp12
-rw-r--r--src/base/QXmppJingleIq.h6
-rw-r--r--src/base/QXmppMamIq.h4
-rw-r--r--src/base/QXmppMessage.cpp94
-rw-r--r--src/base/QXmppMessage.h16
-rw-r--r--src/base/QXmppMixIq.h4
-rw-r--r--src/base/QXmppMixItem.h4
-rw-r--r--src/base/QXmppMucIq.h4
-rw-r--r--src/base/QXmppPresence.cpp18
-rw-r--r--src/base/QXmppPresence.h6
-rw-r--r--src/base/QXmppPubSubIq.h2
-rw-r--r--src/base/QXmppPubSubItem.h2
-rw-r--r--src/base/QXmppRegisterIq.cpp15
-rw-r--r--src/base/QXmppRegisterIq.h2
-rw-r--r--src/base/QXmppResultSet.h4
-rw-r--r--src/base/QXmppRpcIq.h4
-rw-r--r--src/base/QXmppStanza.cpp4
-rw-r--r--src/base/QXmppStanza.h13
-rw-r--r--src/base/QXmppStream.cpp48
-rw-r--r--src/base/QXmppStream.h12
-rw-r--r--src/base/QXmppStreamFeatures.cpp29
-rw-r--r--src/base/QXmppStreamFeatures.h20
-rw-r--r--src/base/QXmppUtils.cpp20
-rw-r--r--src/base/QXmppVCardIq.h2
-rw-r--r--src/base/QXmppVersionIq.h2
38 files changed, 227 insertions, 190 deletions
diff --git a/src/base/QXmppArchiveIq.h b/src/base/QXmppArchiveIq.h
index 3955c4b9..d3fe5ef2 100644
--- a/src/base/QXmppArchiveIq.h
+++ b/src/base/QXmppArchiveIq.h
@@ -30,7 +30,7 @@
#include <QDateTime>
/// \brief The QXmppArchiveMessage class represents an archived message
-/// as defined by XEP-0136: Message Archiving.
+/// as defined by \xep{0136}: Message Archiving.
class QXMPP_EXPORT QXmppArchiveMessage
{
@@ -53,7 +53,7 @@ private:
};
/// \brief The QXmppArchiveChat class represents an archived conversation
-/// as defined by XEP-0136: Message Archiving.
+/// as defined by \xep{0136}: Message Archiving.
class QXMPP_EXPORT QXmppArchiveChat
{
@@ -92,7 +92,7 @@ private:
QString m_with;
};
-/// \brief Represents an archive chat as defined by XEP-0136: Message Archiving.
+/// \brief Represents an archive chat as defined by \xep{0136}: Message Archiving.
///
/// It is used to get chat as a QXmppArchiveChat.
///
@@ -120,7 +120,7 @@ private:
QXmppResultSetReply m_rsmReply;
};
-/// \brief Represents an archive list as defined by XEP-0136: Message Archiving.
+/// \brief Represents an archive list as defined by \xep{0136}: Message Archiving.
///
/// \ingroup Stanzas
@@ -166,7 +166,7 @@ private:
QXmppResultSetReply m_rsmReply;
};
-/// \brief Represents an archive remove IQ as defined by XEP-0136: Message Archiving.
+/// \brief Represents an archive remove IQ as defined by \xep{0136}: Message Archiving.
///
/// \ingroup Stanzas
@@ -196,7 +196,7 @@ private:
QDateTime m_end;
};
-/// \brief Represents an archive retrieve IQ as defined by XEP-0136: Message Archiving.
+/// \brief Represents an archive retrieve IQ as defined by \xep{0136}: Message Archiving.
///
/// \ingroup Stanzas
@@ -228,7 +228,7 @@ private:
QXmppResultSetQuery m_rsmQuery;
};
-/// \brief Represents an archive preference IQ as defined by XEP-0136: Message Archiving.
+/// \brief Represents an archive preference IQ as defined by \xep{0136}: Message Archiving.
///
/// \ingroup Stanzas
diff --git a/src/base/QXmppBitsOfBinaryContentId.cpp b/src/base/QXmppBitsOfBinaryContentId.cpp
index 24f9cbcd..630e59a7 100644
--- a/src/base/QXmppBitsOfBinaryContentId.cpp
+++ b/src/base/QXmppBitsOfBinaryContentId.cpp
@@ -63,7 +63,7 @@ QXmppBitsOfBinaryContentIdPrivate::QXmppBitsOfBinaryContentIdPrivate()
{
}
-/// Parses a \c QXmppBitsOfBinaryContentId from a XEP-0231: Bits of Binary
+/// Parses a \c QXmppBitsOfBinaryContentId from a \xep{0231}: Bits of Binary
/// \c cid: URL
///
/// In case parsing failed, the returned \c QXmppBitsOfBinaryContentId is
@@ -79,7 +79,7 @@ QXmppBitsOfBinaryContentId QXmppBitsOfBinaryContentId::fromCidUrl(const QString
return {};
}
-/// Parses a \c QXmppBitsOfBinaryContentId from a XEP-0231: Bits of Binary
+/// Parses a \c QXmppBitsOfBinaryContentId from a \xep{0231}: Bits of Binary
/// content id
///
/// In case parsing failed, the returned \c QXmppBitsOfBinaryContentId is
@@ -133,7 +133,7 @@ QXmppBitsOfBinaryContentId::QXmppBitsOfBinaryContentId(const QXmppBitsOfBinaryCo
QXmppBitsOfBinaryContentId &QXmppBitsOfBinaryContentId::operator=(const QXmppBitsOfBinaryContentId &other) = default;
-/// Returns a XEP-0231: Bits of Binary content id
+/// Returns a \xep{0231}: Bits of Binary content id
QString QXmppBitsOfBinaryContentId::toContentId() const
{
@@ -146,7 +146,7 @@ QString QXmppBitsOfBinaryContentId::toContentId() const
CONTENTID_POSTFIX;
}
-/// Returns a XEP-0231: Bits of Binary \c cid: URL
+/// Returns a \xep{0231}: Bits of Binary \c cid: URL
QString QXmppBitsOfBinaryContentId::toCidUrl() const
{
diff --git a/src/base/QXmppBitsOfBinaryContentId.h b/src/base/QXmppBitsOfBinaryContentId.h
index 049bc54a..1488dfd8 100644
--- a/src/base/QXmppBitsOfBinaryContentId.h
+++ b/src/base/QXmppBitsOfBinaryContentId.h
@@ -32,7 +32,7 @@
class QXmppBitsOfBinaryContentIdPrivate;
/// \class QXmppBitsOfBinaryContentId represents a link to or an identifier of
-/// XEP-0231: Bits of Binary data.
+/// \xep{0231}: Bits of Binary data.
///
/// \since QXmpp 1.2
diff --git a/src/base/QXmppBitsOfBinaryData.cpp b/src/base/QXmppBitsOfBinaryData.cpp
index dd69a763..2528b494 100644
--- a/src/base/QXmppBitsOfBinaryData.cpp
+++ b/src/base/QXmppBitsOfBinaryData.cpp
@@ -129,7 +129,7 @@ void QXmppBitsOfBinaryData::setData(const QByteArray &data)
d->data = data;
}
-/// Returns true, if \c element is a XEP-0231: Bits of Binary data element
+/// Returns true, if \c element is a \xep{0231}: Bits of Binary data element
bool QXmppBitsOfBinaryData::isBitsOfBinaryData(const QDomElement &element)
{
diff --git a/src/base/QXmppBitsOfBinaryData.h b/src/base/QXmppBitsOfBinaryData.h
index 28fe9dfd..34b7bb05 100644
--- a/src/base/QXmppBitsOfBinaryData.h
+++ b/src/base/QXmppBitsOfBinaryData.h
@@ -34,7 +34,7 @@ class QXmlStreamWriter;
class QXmppBitsOfBinaryDataPrivate;
class QXmppBitsOfBinaryContentId;
-/// \class QXmppBitsOfBinaryData represents a data element for XEP-0231: Bits
+/// \class QXmppBitsOfBinaryData represents a data element for \xep{0231}: Bits
/// of Binary. It can be used as an extension in other stanzas.
///
/// \see QXmppBitsOfBinaryIq, QXmppBitsOfBinaryDataList
diff --git a/src/base/QXmppBitsOfBinaryDataList.h b/src/base/QXmppBitsOfBinaryDataList.h
index e4c05794..0aacd286 100644
--- a/src/base/QXmppBitsOfBinaryDataList.h
+++ b/src/base/QXmppBitsOfBinaryDataList.h
@@ -32,7 +32,7 @@ class QDomElement;
class QXmlStreamWriter;
/// \class QXmppBitsOfBinaryDataList represents a list of data elements from
-/// XEP-0231: Bits of Binary.
+/// \xep{0231}: Bits of Binary.
///
/// \since QXmpp 1.2
diff --git a/src/base/QXmppBitsOfBinaryIq.cpp b/src/base/QXmppBitsOfBinaryIq.cpp
index 700c8bce..f9cf608c 100644
--- a/src/base/QXmppBitsOfBinaryIq.cpp
+++ b/src/base/QXmppBitsOfBinaryIq.cpp
@@ -32,7 +32,7 @@ QXmppBitsOfBinaryIq::QXmppBitsOfBinaryIq() = default;
QXmppBitsOfBinaryIq::~QXmppBitsOfBinaryIq() = default;
-/// Returns true, if \c element is a XEP-0231: Bits of Binary IQ
+/// Returns true, if \c element is a \xep{0231}: Bits of Binary IQ
///
/// \note This may also return true, if the IQ is not a Bits of Binary IQ in
/// first place, but only contains a Bits of Binary data element.
diff --git a/src/base/QXmppBitsOfBinaryIq.h b/src/base/QXmppBitsOfBinaryIq.h
index 524deaf0..3cf2f110 100644
--- a/src/base/QXmppBitsOfBinaryIq.h
+++ b/src/base/QXmppBitsOfBinaryIq.h
@@ -27,7 +27,7 @@
#include "QXmppBitsOfBinaryData.h"
#include "QXmppIq.h"
-/// \class QXmppBitsOfBinaryIq represents a XEP-0231: Bits of Binary IQ to
+/// \class QXmppBitsOfBinaryIq represents a \xep{0231}: Bits of Binary IQ to
/// request and transmit Bits of Binary data elements.
///
/// \since QXmpp 1.2
diff --git a/src/base/QXmppBookmarkSet.h b/src/base/QXmppBookmarkSet.h
index 9b9b0d4c..3b1b6655 100644
--- a/src/base/QXmppBookmarkSet.h
+++ b/src/base/QXmppBookmarkSet.h
@@ -30,7 +30,7 @@
#include <QUrl>
/// \brief The QXmppBookmarkConference class represents a bookmark for a conference room,
-/// as defined by XEP-0048: Bookmarks.
+/// as defined by \xep{0048}: Bookmarks.
///
class QXMPP_EXPORT QXmppBookmarkConference
{
@@ -57,7 +57,7 @@ private:
};
/// \brief The QXmppBookmarkUrl class represents a bookmark for a web page,
-/// as defined by XEP-0048: Bookmarks.
+/// as defined by \xep{0048}: Bookmarks.
///
class QXMPP_EXPORT QXmppBookmarkUrl
{
@@ -74,7 +74,7 @@ private:
};
/// \brief The QXmppbookmarkSets class represents a set of bookmarks, as defined
-/// by XEP-0048: Bookmarks.
+/// by \xep{0048}: Bookmarks.
///
class QXMPP_EXPORT QXmppBookmarkSet
{
diff --git a/src/base/QXmppDataForm.cpp b/src/base/QXmppDataForm.cpp
index 54442cb5..8239b86a 100644
--- a/src/base/QXmppDataForm.cpp
+++ b/src/base/QXmppDataForm.cpp
@@ -425,7 +425,7 @@ void QXmppDataForm::Field::setValue(const QVariant &value)
d->value = value;
}
-/// Returns the size of the attached media according to XEP-0221: Data Forms
+/// Returns the size of the attached media according to \xep{0221}: Data Forms
/// Media Element.
///
/// \since QXmpp 1.1
@@ -435,7 +435,7 @@ QSize QXmppDataForm::Field::mediaSize() const
return d->mediaSize;
}
-/// Returns the size of the attached media according to XEP-0221: Data Forms
+/// Returns the size of the attached media according to \xep{0221}: Data Forms
/// Media Element.
///
/// \since QXmpp 1.1
@@ -445,7 +445,7 @@ QSize &QXmppDataForm::Field::mediaSize()
return d->mediaSize;
}
-/// Sets the size of the attached media according to XEP-0221: Data Forms Media
+/// Sets the size of the attached media according to \xep{0221}: Data Forms Media
/// Element.
///
/// \since QXmpp 1.1
@@ -455,7 +455,7 @@ void QXmppDataForm::Field::setMediaSize(const QSize &size)
d->mediaSize = size;
}
-/// Returns the sources for the attached media according to XEP-0221: Data
+/// Returns the sources for the attached media according to \xep{0221}: Data
/// Forms Media Element.
///
/// \since QXmpp 1.1
@@ -465,7 +465,7 @@ QVector<QXmppDataForm::MediaSource> QXmppDataForm::Field::mediaSources() const
return d->mediaSources;
}
-/// Returns the sources for the attached media according to XEP-0221: Data
+/// Returns the sources for the attached media according to \xep{0221}: Data
/// Forms Media Element.
///
/// \since QXmpp 1.1
@@ -475,7 +475,7 @@ QVector<QXmppDataForm::MediaSource> &QXmppDataForm::Field::mediaSources()
return d->mediaSources;
}
-/// Sets the sources to the attached media of the field according to XEP-0221:
+/// Sets the sources to the attached media of the field according to \xep{0221}:
/// Data Forms Media Element.
///
/// \since QXmpp 1.1
diff --git a/src/base/QXmppDataForm.h b/src/base/QXmppDataForm.h
index c8cda135..b58cb680 100644
--- a/src/base/QXmppDataForm.h
+++ b/src/base/QXmppDataForm.h
@@ -42,13 +42,13 @@ class QXmppDataFormMediaPrivate;
class QXmppDataFormMediaSourcePrivate;
/// \brief The QXmppDataForm class represents a data form as defined by
-/// XEP-0004: Data Forms.
+/// \xep{0004}: Data Forms.
class QXMPP_EXPORT QXmppDataForm
{
public:
/// \brief The \c QXmppDataForm::MediaSource class represents a link to one
- /// of possibly multiple sources for a media element from XEP-0221: Data
+ /// of possibly multiple sources for a media element from \xep{0221}: Data
/// Forms Media Element consisting of a MIME type and a QUrl.
///
/// \since QXmpp 1.1
@@ -77,7 +77,7 @@ public:
#if QXMPP_DEPRECATED_SINCE(1, 1)
/// \brief The QXmppDataForm::Media class represents a media field as
- /// defined by XEP-0221: Data Forms Media Element.
+ /// defined by \xep{0221}: Data Forms Media Element.
///
/// \deprecated This class is deprecated since QXmpp 1.1.
@@ -116,7 +116,7 @@ public:
#endif
/// \brief The QXmppDataForm::Field class represents a data form field
- /// as defined by XEP-0004: Data Forms.
+ /// as defined by \xep{0004}: Data Forms.
class QXMPP_EXPORT Field
{
diff --git a/src/base/QXmppDiscoveryIq.cpp b/src/base/QXmppDiscoveryIq.cpp
index cf50355e..9e76e59f 100644
--- a/src/base/QXmppDiscoveryIq.cpp
+++ b/src/base/QXmppDiscoveryIq.cpp
@@ -217,7 +217,7 @@ void QXmppDiscoveryIq::setItems(const QList<QXmppDiscoveryIq::Item> &items)
}
/// Returns the QXmppDataForm for this IQ, as defined by
-/// XEP-0128: Service Discovery Extensions.
+/// \xep{0128}: Service Discovery Extensions.
///
QXmppDataForm QXmppDiscoveryIq::form() const
@@ -226,7 +226,7 @@ QXmppDataForm QXmppDiscoveryIq::form() const
}
/// Sets the QXmppDataForm for this IQ, as define by
-/// XEP-0128: Service Discovery Extensions.
+/// \xep{0128}: Service Discovery Extensions.
///
/// \param form
///
@@ -256,7 +256,7 @@ void QXmppDiscoveryIq::setQueryType(enum QXmppDiscoveryIq::QueryType type)
d->queryType = type;
}
-/// Calculate the verification string for XEP-0115 : Entity Capabilities
+/// Calculate the verification string for \xep{0115}: Entity Capabilities
QByteArray QXmppDiscoveryIq::verificationString() const
{
diff --git a/src/base/QXmppHttpUploadIq.h b/src/base/QXmppHttpUploadIq.h
index 4b39e5b9..b92a7f36 100644
--- a/src/base/QXmppHttpUploadIq.h
+++ b/src/base/QXmppHttpUploadIq.h
@@ -35,7 +35,7 @@ class QXmppHttpUploadRequestIqPrivate;
class QXmppHttpUploadSlotIqPrivate;
/// \brief Represents an HTTP File Upload IQ for requesting an upload slot as
-/// defined by XEP-0363: HTTP File Upload.
+/// defined by \xep{0363}: HTTP File Upload.
///
/// \since QXmpp 1.1
///
@@ -72,7 +72,7 @@ private:
};
/// \brief Represents an HTTP File Upload IQ result for receiving an upload slot as
-/// defined by XEP-0363: HTTP File Upload.
+/// defined by \xep{0363}: HTTP File Upload.
///
/// \since QXmpp 1.1
///
diff --git a/src/base/QXmppJingleIq.cpp b/src/base/QXmppJingleIq.cpp
index 8920c781..ea95c0e0 100644
--- a/src/base/QXmppJingleIq.cpp
+++ b/src/base/QXmppJingleIq.cpp
@@ -301,7 +301,7 @@ void QXmppJingleIq::Content::setTransportPassword(const QString &password)
/// Returns the fingerprint hash value for the transport key.
///
-/// This is used for DTLS-SRTP as defined in XEP-0320.
+/// This is used for DTLS-SRTP as defined in \xep{0320}.
QByteArray QXmppJingleIq::Content::transportFingerprint() const
{
@@ -310,7 +310,7 @@ QByteArray QXmppJingleIq::Content::transportFingerprint() const
/// Sets the fingerprint hash value for the transport key.
///
-/// This is used for DTLS-SRTP as defined in XEP-0320.
+/// This is used for DTLS-SRTP as defined in \xep{0320}.
void QXmppJingleIq::Content::setTransportFingerprint(const QByteArray &fingerprint)
{
@@ -319,7 +319,7 @@ void QXmppJingleIq::Content::setTransportFingerprint(const QByteArray &fingerpri
/// Returns the fingerprint hash algorithm for the transport key.
///
-/// This is used for DTLS-SRTP as defined in XEP-0320.
+/// This is used for DTLS-SRTP as defined in \xep{0320}.
QString QXmppJingleIq::Content::transportFingerprintHash() const
{
@@ -328,7 +328,7 @@ QString QXmppJingleIq::Content::transportFingerprintHash() const
/// Sets the fingerprint hash algorithm for the transport key.
///
-/// This is used for DTLS-SRTP as defined in XEP-0320.
+/// This is used for DTLS-SRTP as defined in \xep{0320}.
void QXmppJingleIq::Content::setTransportFingerprintHash(const QString &hash)
{
@@ -337,7 +337,7 @@ void QXmppJingleIq::Content::setTransportFingerprintHash(const QString &hash)
/// Returns the setup role for the encrypted transport.
///
-/// This is used for DTLS-SRTP as defined in XEP-0320.
+/// This is used for DTLS-SRTP as defined in \xep{0320}.
QString QXmppJingleIq::Content::transportFingerprintSetup() const
{
@@ -346,7 +346,7 @@ QString QXmppJingleIq::Content::transportFingerprintSetup() const
/// Sets the setup role for the encrypted transport.
///
-/// This is used for DTLS-SRTP as defined in XEP-0320.
+/// This is used for DTLS-SRTP as defined in \xep{0320}.
void QXmppJingleIq::Content::setTransportFingerprintSetup(const QString &setup)
{
diff --git a/src/base/QXmppJingleIq.h b/src/base/QXmppJingleIq.h
index 5fcd1bb9..9dc0503c 100644
--- a/src/base/QXmppJingleIq.h
+++ b/src/base/QXmppJingleIq.h
@@ -34,7 +34,7 @@ class QXmppJingleIqPrivate;
class QXmppJinglePayloadTypePrivate;
/// \brief The QXmppJinglePayloadType class represents a payload type
-/// as specified by XEP-0167: Jingle RTP Sessions and RFC 5245.
+/// as specified by \xep{0167}: Jingle RTP Sessions and RFC 5245.
///
class QXMPP_EXPORT QXmppJinglePayloadType
@@ -78,7 +78,7 @@ private:
};
/// \brief The QXmppJingleCandidate class represents a transport candidate
-/// as specified by XEP-0176: Jingle ICE-UDP Transport Method.
+/// as specified by \xep{0176}: Jingle ICE-UDP Transport Method.
///
class QXMPP_EXPORT QXmppJingleCandidate
@@ -146,7 +146,7 @@ private:
};
/// \brief The QXmppJingleIq class represents an IQ used for initiating media
-/// sessions as specified by XEP-0166: Jingle.
+/// sessions as specified by \xep{0166}: Jingle.
///
/// \ingroup Stanzas
diff --git a/src/base/QXmppMamIq.h b/src/base/QXmppMamIq.h
index 6f5c251c..0047a370 100644
--- a/src/base/QXmppMamIq.h
+++ b/src/base/QXmppMamIq.h
@@ -34,7 +34,7 @@ class QXmppMamQueryIqPrivate;
class QXmppMamResultIqPrivate;
/// \brief The QXmppMamQueryIq class represents the query IQ for
-/// XEP-0313: Message Archive Management.
+/// \xep{0313}: Message Archive Management.
class QXmppMamQueryIq : public QXmppIq
{
public:
@@ -64,7 +64,7 @@ private:
};
/// \brief The QXmppMamQueryIq class represents the result IQ for
-/// XEP-0313: Message Archive Management.
+/// \xep{0313}: Message Archive Management.
class QXmppMamResultIq : public QXmppIq
{
public:
diff --git a/src/base/QXmppMessage.cpp b/src/base/QXmppMessage.cpp
index 9084d957..0c23a3b6 100644
--- a/src/base/QXmppMessage.cpp
+++ b/src/base/QXmppMessage.cpp
@@ -230,7 +230,7 @@ void QXmppMessage::setBody(const QString &body)
}
/// Returns true if the user's attention is requested, as defined
-/// by XEP-0224: Attention.
+/// by \xep{0224}: Attention.
bool QXmppMessage::isAttentionRequested() const
{
@@ -238,7 +238,7 @@ bool QXmppMessage::isAttentionRequested() const
}
/// Sets whether the user's attention is requested, as defined
-/// by XEP-0224: Attention.
+/// by \xep{0224}: Attention.
///
/// \a param requested
@@ -248,7 +248,7 @@ void QXmppMessage::setAttentionRequested(bool requested)
}
/// Returns true if a delivery receipt is requested, as defined
-/// by XEP-0184: Message Delivery Receipts.
+/// by \xep{0184}: Message Delivery Receipts.
bool QXmppMessage::isReceiptRequested() const
{
@@ -256,7 +256,7 @@ bool QXmppMessage::isReceiptRequested() const
}
/// Sets whether a delivery receipt is requested, as defined
-/// by XEP-0184: Message Delivery Receipts.
+/// by \xep{0184}: Message Delivery Receipts.
///
/// \a param requested
@@ -284,7 +284,7 @@ void QXmppMessage::setReceiptId(const QString &id)
}
/// Returns the JID for a multi-user chat direct invitation as defined
-/// by XEP-0249: Direct MUC Invitations.
+/// by \xep{0249}: Direct MUC Invitations.
QString QXmppMessage::mucInvitationJid() const
{
@@ -292,7 +292,7 @@ QString QXmppMessage::mucInvitationJid() const
}
/// Sets the JID for a multi-user chat direct invitation as defined
-/// by XEP-0249: Direct MUC Invitations.
+/// by \xep{0249}: Direct MUC Invitations.
void QXmppMessage::setMucInvitationJid(const QString &jid)
{
@@ -300,7 +300,7 @@ void QXmppMessage::setMucInvitationJid(const QString &jid)
}
/// Returns the password for a multi-user chat direct invitation as defined
-/// by XEP-0249: Direct MUC Invitations.
+/// by \xep{0249}: Direct MUC Invitations.
QString QXmppMessage::mucInvitationPassword() const
{
@@ -308,7 +308,7 @@ QString QXmppMessage::mucInvitationPassword() const
}
/// Sets the \a password for a multi-user chat direct invitation as defined
-/// by XEP-0249: Direct MUC Invitations.
+/// by \xep{0249}: Direct MUC Invitations.
void QXmppMessage::setMucInvitationPassword(const QString &password)
{
@@ -316,7 +316,7 @@ void QXmppMessage::setMucInvitationPassword(const QString &password)
}
/// Returns the reason for a multi-user chat direct invitation as defined
-/// by XEP-0249: Direct MUC Invitations.
+/// by \xep{0249}: Direct MUC Invitations.
QString QXmppMessage::mucInvitationReason() const
{
@@ -324,7 +324,7 @@ QString QXmppMessage::mucInvitationReason() const
}
/// Sets the \a reason for a multi-user chat direct invitation as defined
-/// by XEP-0249: Direct MUC Invitations.
+/// by \xep{0249}: Direct MUC Invitations.
void QXmppMessage::setMucInvitationReason(const QString &reason)
{
@@ -413,7 +413,7 @@ void QXmppMessage::setThread(const QString &thread)
}
/// Returns the message's XHTML body as defined by
-/// XEP-0071: XHTML-IM.
+/// \xep{0071}: XHTML-IM.
QString QXmppMessage::xhtml() const
{
@@ -421,7 +421,7 @@ QString QXmppMessage::xhtml() const
}
/// Sets the message's XHTML body as defined by
-/// XEP-0071: XHTML-IM.
+/// \xep{0071}: XHTML-IM.
void QXmppMessage::setXhtml(const QString &xhtml)
{
@@ -429,7 +429,7 @@ void QXmppMessage::setXhtml(const QString &xhtml)
}
/// Returns true if a message is markable, as defined
-/// XEP-0333: Chat Markers.
+/// \xep{0333}: Chat Markers.
bool QXmppMessage::isMarkable() const
{
@@ -437,7 +437,7 @@ bool QXmppMessage::isMarkable() const
}
/// Sets if the message is markable, as defined
-/// XEP-0333: Chat Markers.
+/// \xep{0333}: Chat Markers.
void QXmppMessage::setMarkable(const bool markable)
{
@@ -445,7 +445,7 @@ void QXmppMessage::setMarkable(const bool markable)
}
/// Returns the message's marker id, as defined
-/// XEP-0333: Chat Markers.
+/// \xep{0333}: Chat Markers.
QString QXmppMessage::markedId() const
{
@@ -453,7 +453,7 @@ QString QXmppMessage::markedId() const
}
/// Sets the message's marker id, as defined
-/// XEP-0333: Chat Markers.
+/// \xep{0333}: Chat Markers.
void QXmppMessage::setMarkerId(const QString &markerId)
{
@@ -461,7 +461,7 @@ void QXmppMessage::setMarkerId(const QString &markerId)
}
/// Returns the message's marker thread, as defined
-/// XEP-0333: Chat Markers.
+/// \xep{0333}: Chat Markers.
QString QXmppMessage::markedThread() const
{
@@ -469,7 +469,7 @@ QString QXmppMessage::markedThread() const
}
/// Sets the message's marked thread, as defined
-/// XEP-0333: Chat Markers.
+/// \xep{0333}: Chat Markers.
void QXmppMessage::setMarkedThread(const QString &markedThread)
{
@@ -477,7 +477,7 @@ void QXmppMessage::setMarkedThread(const QString &markedThread)
}
/// Returns the message's marker, as defined
-/// XEP-0333: Chat Markers.
+/// \xep{0333}: Chat Markers.
QXmppMessage::Marker QXmppMessage::marker() const
{
@@ -485,14 +485,14 @@ QXmppMessage::Marker QXmppMessage::marker() const
}
/// Sets the message's marker, as defined
-/// XEP-0333: Chat Markers
+/// \xep{0333}: Chat Markers
void QXmppMessage::setMarker(const Marker marker)
{
d->marker = marker;
}
-/// Returns a list of data packages attached using XEP-0231: Bits of Binary.
+/// Returns a list of data packages attached using \xep{0231}: Bits of Binary.
///
/// This could be used to resolve \c cid: URIs found in the X-HTML body.
///
@@ -503,7 +503,7 @@ QXmppBitsOfBinaryDataList QXmppMessage::bitsOfBinaryData() const
return d->bitsOfBinaryData;
}
-/// Returns a list of data attached using XEP-0231: Bits of Binary.
+/// Returns a list of data attached using \xep{0231}: Bits of Binary.
///
/// This could be used to resolve \c cid: URIs found in the X-HTML body.
///
@@ -514,7 +514,7 @@ QXmppBitsOfBinaryDataList &QXmppMessage::bitsOfBinaryData()
return d->bitsOfBinaryData;
}
-/// Sets a list of XEP-0231: Bits of Binary attachments to be included.
+/// Sets a list of \xep{0231}: Bits of Binary attachments to be included.
///
/// \since QXmpp 1.2
@@ -525,7 +525,7 @@ void QXmppMessage::setBitsOfBinaryData(const QXmppBitsOfBinaryDataList &bitsOfBi
/// Returns if the message is marked with a <private> tag,
/// in which case it will not be forwarded to other resources
-/// according to XEP-0280: Message Carbons.
+/// according to \xep{0280}: Message Carbons.
bool QXmppMessage::isPrivate() const
{
@@ -534,28 +534,28 @@ bool QXmppMessage::isPrivate() const
/// If true is passed, the message is marked with a <private> tag,
/// in which case it will not be forwarded to other resources
-/// according to XEP-0280: Message Carbons.
+/// according to \xep{0280}: Message Carbons.
void QXmppMessage::setPrivate(const bool priv)
{
d->privatemsg = priv;
}
-/// Returns a possibly attached URL from XEP-0066: Out of Band Data
+/// Returns a possibly attached URL from \xep{0066}: Out of Band Data
QString QXmppMessage::outOfBandUrl() const
{
return d->outOfBandUrl;
}
-/// Sets the attached URL for XEP-0066: Out of Band Data
+/// Sets the attached URL for \xep{0066}: Out of Band Data
void QXmppMessage::setOutOfBandUrl(const QString &url)
{
d->outOfBandUrl = url;
}
-/// Returns the message id to replace with this message as used in XEP-0308:
+/// Returns the message id to replace with this message as used in \xep{0308}:
/// Last Message Correction. If the returned string is empty, this message is
/// not replacing another.
@@ -564,7 +564,7 @@ QString QXmppMessage::replaceId() const
return d->replaceId;
}
-/// Sets the message id to replace with this message as in XEP-0308: Last
+/// Sets the message id to replace with this message as in \xep{0308}: Last
/// Message Correction.
void QXmppMessage::setReplaceId(const QString &replaceId)
@@ -573,7 +573,7 @@ void QXmppMessage::setReplaceId(const QString &replaceId)
}
/// Returns true if the message contains the hint passed, as defined in
-/// XEP-0334: Message Processing Hints
+/// \xep{0334}: Message Processing Hints
///
/// \since QXmpp 1.1
@@ -582,7 +582,7 @@ bool QXmppMessage::hasHint(const Hint hint) const
return d->hints & hint;
}
-/// Adds a hint to the message, as defined in XEP-0334: Message Processing
+/// Adds a hint to the message, as defined in \xep{0334}: Message Processing
/// Hints
///
/// \since QXmpp 1.1
@@ -592,7 +592,7 @@ void QXmppMessage::addHint(const Hint hint)
d->hints |= hint;
}
-/// Removes a hint from the message, as defined in XEP-0334: Message Processing
+/// Removes a hint from the message, as defined in \xep{0334}: Message Processing
/// Hints
///
/// \since QXmpp 1.1
@@ -602,7 +602,7 @@ void QXmppMessage::removeHint(const Hint hint)
d->hints &= ~hint;
}
-/// Removes all hints from the message, as defined in XEP-0334: Message
+/// Removes all hints from the message, as defined in \xep{0334}: Message
/// Processing Hints
///
/// \since QXmpp 1.1
@@ -678,7 +678,7 @@ void QXmppMessage::setOriginId(const QString &id)
d->originId = id;
}
-/// Returns the message id this message is linked/attached to. See XEP-0367:
+/// Returns the message id this message is linked/attached to. See \xep{0367}:
/// Message Attaching for details.
///
/// \since QXmpp 1.1
@@ -688,7 +688,7 @@ QString QXmppMessage::attachId() const
return d->attachId;
}
-/// Sets the id of the attached message as in XEP-0367: Message Attaching. This
+/// Sets the id of the attached message as in \xep{0367}: Message Attaching. This
/// can be used for a "reply to" or "reaction" function.
///
/// The used message id depends on the message context, see the Business rules
@@ -742,7 +742,7 @@ void QXmppMessage::setMixUserNick(const QString &mixUserNick)
///
/// \note QXmppMessage::NoEncryption does not necesserily mean that the message
/// is not encrypted; it may also be that the author of the message does not
-/// support XEP-0380: Explicit Message Encryption.
+/// support \xep{0380}: Explicit Message Encryption.
///
/// \note If this returns QXmppMessage::UnknownEncryption, you can still get
/// the namespace of the encryption with \c encryptionMethodNs() and possibly
@@ -762,7 +762,7 @@ QXmppMessage::EncryptionMethod QXmppMessage::encryptionMethod() const
}
/// Advertises that this message is encrypted with the given encryption method.
-/// See XEP-0380: Explicit Message Encryption for details.
+/// See \xep{0380}: Explicit Message Encryption for details.
///
/// \since QXmpp 1.1
@@ -771,7 +771,7 @@ void QXmppMessage::setEncryptionMethod(QXmppMessage::EncryptionMethod method)
d->encryptionMethod = ENCRYPTION_NAMESPACES.at(int(method));
}
-/// Returns the namespace of the advertised encryption method via. XEP-0380:
+/// Returns the namespace of the advertised encryption method via. \xep{0380}:
/// Explicit Message Encryption.
///
/// \since QXmpp 1.1
@@ -782,7 +782,7 @@ QString QXmppMessage::encryptionMethodNs() const
}
/// Sets the namespace of the encryption method this message advertises to be
-/// encrypted with. See XEP-0380: Explicit Message Encryption for details.
+/// encrypted with. See \xep{0380}: Explicit Message Encryption for details.
///
/// \since QXmpp 1.1
@@ -792,7 +792,7 @@ void QXmppMessage::setEncryptionMethodNs(const QString &encryptionMethod)
}
/// Returns the associated name of the encryption method this message
-/// advertises to be encrypted with. See XEP-0380: Explicit Message Encryption
+/// advertises to be encrypted with. See \xep{0380}: Explicit Message Encryption
/// for details.
///
/// \since QXmpp 1.1
@@ -804,7 +804,7 @@ QString QXmppMessage::encryptionName() const
return ENCRYPTION_NAMES.at(int(encryptionMethod()));
}
-/// Sets the name of the encryption method for XEP-0380: Explicit Message
+/// Sets the name of the encryption method for \xep{0380}: Explicit Message
/// Encryption.
///
/// \note This should only be used, if the encryption method is custom and is
@@ -817,7 +817,7 @@ void QXmppMessage::setEncryptionName(const QString &encryptionName)
d->encryptionName = encryptionName;
}
-/// Returns true, if this is a spoiler message according to XEP-0382: Spoiler
+/// Returns true, if this is a spoiler message according to \xep{0382}: Spoiler
/// messages. The spoiler hint however can still be empty.
///
/// A spoiler message's content should not be visible to the user by default.
@@ -829,7 +829,7 @@ bool QXmppMessage::isSpoiler() const
return d->isSpoiler;
}
-/// Sets whether this is a spoiler message as specified in XEP-0382: Spoiler
+/// Sets whether this is a spoiler message as specified in \xep{0382}: Spoiler
/// messages.
///
/// The content of spoiler messages will not be displayed by default to the
@@ -843,7 +843,7 @@ void QXmppMessage::setIsSpoiler(bool isSpoiler)
d->isSpoiler = isSpoiler;
}
-/// Returns the spoiler hint as specified in XEP-0382: Spoiler messages.
+/// Returns the spoiler hint as specified in \xep{0382}: Spoiler messages.
///
/// The hint may be empty, even if isSpoiler is true.
///
@@ -854,7 +854,7 @@ QString QXmppMessage::spoilerHint() const
return d->spoilerHint;
}
-/// Sets a spoiler hint for XEP-0382: Spoiler messages. If the spoiler hint
+/// Sets a spoiler hint for \xep{0382}: Spoiler messages. If the spoiler hint
/// is not empty, isSpoiler will be set to true.
///
/// A spoiler hint is optional for spoiler messages.
@@ -997,7 +997,7 @@ void QXmppMessage::toXml(QXmlStreamWriter *xmlWriter) const
xmlWriter->writeEndElement();
}
- // XEP-0224: Attention
+ // \xep{0224}: Attention
if (d->attentionRequested) {
xmlWriter->writeStartElement(QStringLiteral("attention"));
xmlWriter->writeDefaultNamespace(ns_attention);
@@ -1175,7 +1175,7 @@ void QXmppMessage::parseExtension(const QDomElement &element, QXmppElementList &
d->stamp = QXmppUtils::datetimeFromString(
element.attribute(QStringLiteral("stamp")));
d->stampType = DelayedDelivery;
- // XEP-0224: Attention
+ // \xep{0224}: Attention
} else if (checkElement(element, QStringLiteral("attention"), ns_attention)) {
d->attentionRequested = true;
// XEP-0231: Bits of Binary
diff --git a/src/base/QXmppMessage.h b/src/base/QXmppMessage.h
index 7b43a651..88a6edd2 100644
--- a/src/base/QXmppMessage.h
+++ b/src/base/QXmppMessage.h
@@ -50,7 +50,7 @@ public:
Headline
};
- /// This enum describes a chat state as defined by XEP-0085: Chat State
+ /// This enum describes a chat state as defined by \xep{0085}: Chat State
/// Notifications.
enum State {
None = 0, ///< The message does not contain any chat state information.
@@ -61,7 +61,7 @@ public:
Paused ///< User had been composing but now has stopped.
};
- /// This enum describes a chat marker as defined by XEP-0333: Chat Markers.
+ /// This enum describes a chat marker as defined by \xep{0333}: Chat Markers.
enum Marker {
NoMarker = 0,
Received,
@@ -69,7 +69,7 @@ public:
Acknowledged
};
- /// XEP-0334: Message Processing Hints
+ /// \xep{0334}: Message Processing Hints
///
/// \since QXmpp 1.1
enum Hint {
@@ -81,16 +81,16 @@ public:
/// This enum describes different end-to-end encryption methods. These can
/// be used to mark a message explicitly as encrypted with a specific
- /// algothim. See XEP-0380: Explicit Message Encryption for details.
+ /// algothim. See \xep{0380}: Explicit Message Encryption for details.
///
/// \since QXmpp 1.1
enum EncryptionMethod {
NoEncryption, ///< No encryption
UnknownEncryption, ///< Unknown encryption
- OTR, ///< XEP-0364: Current Off-the-Record Messaging Usage
- LegacyOpenPGP, ///< XEP-0027: Current Jabber OpenPGP Usage
- OX, ///< XEP-0373: OpenPGP for XMPP
- OMEMO ///< XEP-0384: OMEMO Encryption
+ OTR, ///< \xep{0364}: Current Off-the-Record Messaging Usage
+ LegacyOpenPGP, ///< \xep{0027}: Current Jabber OpenPGP Usage
+ OX, ///< \xep{0373}: OpenPGP for XMPP
+ OMEMO ///< \xep{0384}: OMEMO Encryption
};
QXmppMessage(const QString &from = QString(), const QString &to = QString(),
diff --git a/src/base/QXmppMixIq.h b/src/base/QXmppMixIq.h
index 7866e4ee..5eb29926 100644
--- a/src/base/QXmppMixIq.h
+++ b/src/base/QXmppMixIq.h
@@ -31,8 +31,8 @@
class QXmppMixIqPrivate;
/// \brief The QXmppMixIq class represents an IQ used to do actions on a MIX
-/// channel as defined by XEP-0369: Mediated Information eXchange (MIX) and
-/// XEP-0405: Mediated Information eXchange (MIX): Participant Server
+/// channel as defined by \xep{0369}: Mediated Information eXchange (MIX) and
+/// \xep{0405}: Mediated Information eXchange (MIX): Participant Server
/// Requirements.
///
/// \since QXmpp 1.1
diff --git a/src/base/QXmppMixItem.h b/src/base/QXmppMixItem.h
index c7107c27..9fcd258c 100644
--- a/src/base/QXmppMixItem.h
+++ b/src/base/QXmppMixItem.h
@@ -32,7 +32,7 @@ class QXmppMixInfoItemPrivate;
class QXmppMixParticipantItemPrivate;
/// \brief The QXmppMixInfoItem class represents a PubSub item of a MIX
-/// channel containing channel information as defined by XEP-0369: Mediated
+/// channel containing channel information as defined by \xep{0369}: Mediated
/// Information eXchange (MIX).
///
/// \since QXmpp 1.1
@@ -67,7 +67,7 @@ private:
};
/// \brief The QXmppMixParticipantItem class represents a PubSub item of a MIX
-/// channel participant as defined by XEP-0369: Mediated Information eXchange
+/// channel participant as defined by \xep{0369}: Mediated Information eXchange
/// (MIX).
///
/// \since QXmpp 1.1
diff --git a/src/base/QXmppMucIq.h b/src/base/QXmppMucIq.h
index 538d18ef..6877c4a0 100644
--- a/src/base/QXmppMucIq.h
+++ b/src/base/QXmppMucIq.h
@@ -95,7 +95,7 @@ private:
};
/// \brief The QXmppMucAdminIq class represents a chat room administration IQ
-/// as defined by XEP-0045: Multi-User Chat.
+/// as defined by \xep{0045}: Multi-User Chat.
///
/// It is used to get or modify room memberships.
///
@@ -122,7 +122,7 @@ private:
};
/// \brief The QXmppMucOwnerIq class represents a chat room configuration IQ as
-/// defined by XEP-0045: Multi-User Chat.
+/// defined by \xep{0045}: Multi-User Chat.
///
/// It is used to get or modify room configuration options.
///
diff --git a/src/base/QXmppPresence.cpp b/src/base/QXmppPresence.cpp
index 0a8e33cd..207ac8b6 100644
--- a/src/base/QXmppPresence.cpp
+++ b/src/base/QXmppPresence.cpp
@@ -229,43 +229,43 @@ void QXmppPresence::setVCardUpdateType(VCardUpdateType type)
d->vCardUpdateType = type;
}
-/// XEP-0115: Entity Capabilities
+/// \xep{0115}: Entity Capabilities
QString QXmppPresence::capabilityHash() const
{
return d->capabilityHash;
}
-/// XEP-0115: Entity Capabilities
+/// \xep{0115}: Entity Capabilities
void QXmppPresence::setCapabilityHash(const QString &hash)
{
d->capabilityHash = hash;
}
-/// XEP-0115: Entity Capabilities
+/// \xep{0115}: Entity Capabilities
QString QXmppPresence::capabilityNode() const
{
return d->capabilityNode;
}
-/// XEP-0115: Entity Capabilities
+/// \xep{0115}: Entity Capabilities
void QXmppPresence::setCapabilityNode(const QString &node)
{
d->capabilityNode = node;
}
-/// XEP-0115: Entity Capabilities
+/// \xep{0115}: Entity Capabilities
QByteArray QXmppPresence::capabilityVer() const
{
return d->capabilityVer;
}
-/// XEP-0115: Entity Capabilities
+/// \xep{0115}: Entity Capabilities
void QXmppPresence::setCapabilityVer(const QByteArray &ver)
{
d->capabilityVer = ver;
}
-/// Legacy XEP-0115: Entity Capabilities
+/// Legacy \xep{0115}: Entity Capabilities
QStringList QXmppPresence::capabilityExt() const
{
return d->capabilityExt;
@@ -332,14 +332,14 @@ void QXmppPresence::setMucSupported(bool supported)
}
/// Returns when the last user interaction with the client took place. See
-/// XEP-0319: Last User Interaction in Presence for details.
+/// \xep{0319}: Last User Interaction in Presence for details.
QDateTime QXmppPresence::lastUserInteraction() const
{
return d->lastUserInteraction;
}
-/// Sets the time of the last user interaction as defined in XEP-0319: Last
+/// Sets the time of the last user interaction as defined in \xep{0319}: Last
/// User Interaction in Presence.
void QXmppPresence::setLastUserInteraction(const QDateTime &lastUserInteraction)
diff --git a/src/base/QXmppPresence.h b/src/base/QXmppPresence.h
index b1502da3..f636409a 100644
--- a/src/base/QXmppPresence.h
+++ b/src/base/QXmppPresence.h
@@ -54,11 +54,11 @@ public:
XA, ///< The entity or resource is away for an extended period.
DND, ///< The entity or resource is busy ("Do Not Disturb").
Chat, ///< The entity or resource is actively interested in chatting.
- Invisible ///< obsolete XEP-0018: Invisible Presence
+ Invisible ///< obsolete \xep{0018}: Invisible Presence
};
/// This enum is used to describe vCard updates as defined by
- /// XEP-0153: vCard-Based Avatars
+ /// \xep{0153}: vCard-Based Avatars
enum VCardUpdateType {
VCardUpdateNone = 0, ///< Protocol is not supported
VCardUpdateNoPhoto, ///< User is not using any image
@@ -102,7 +102,7 @@ public:
bool isMucSupported() const;
void setMucSupported(bool supported);
- /// XEP-0153: vCard-Based Avatars
+ // XEP-0153: vCard-Based Avatars
QByteArray photoHash() const;
void setPhotoHash(const QByteArray &);
diff --git a/src/base/QXmppPubSubIq.h b/src/base/QXmppPubSubIq.h
index 1c5cefd8..6056ae95 100644
--- a/src/base/QXmppPubSubIq.h
+++ b/src/base/QXmppPubSubIq.h
@@ -35,7 +35,7 @@
class QXmppPubSubIqPrivate;
/// \brief The QXmppPubSubIq class represents an IQ used for the
-/// publish-subscribe mechanisms defined by XEP-0060: Publish-Subscribe.
+/// publish-subscribe mechanisms defined by \xep{0060}: Publish-Subscribe.
///
/// \ingroup Stanzas
diff --git a/src/base/QXmppPubSubItem.h b/src/base/QXmppPubSubItem.h
index e8e59df4..4b277383 100644
--- a/src/base/QXmppPubSubItem.h
+++ b/src/base/QXmppPubSubItem.h
@@ -35,7 +35,7 @@ class QXmppElement;
class QXmppPubSubItemPrivate;
/// \brief The QXmppPubSubItem class represents a publish-subscribe item
-/// as defined by XEP-0060: Publish-Subscribe.
+/// as defined by \xep{0060}: Publish-Subscribe.
class QXMPP_EXPORT QXmppPubSubItem
{
diff --git a/src/base/QXmppRegisterIq.cpp b/src/base/QXmppRegisterIq.cpp
index 052c4a3c..330a013d 100644
--- a/src/base/QXmppRegisterIq.cpp
+++ b/src/base/QXmppRegisterIq.cpp
@@ -221,34 +221,37 @@ void QXmppRegisterIq::setIsRemove(bool isRemove)
d->isRemove = isRemove;
}
-/// Returns a list of data packages attached using XEP-0231: Bits of Binary.
+///
+/// Returns a list of data packages attached using \xep{0231}: Bits of Binary.
///
/// This could be used to resolve a \c cid: URL of an CAPTCHA field of the
/// form.
///
/// \since QXmpp 1.2
-
+///
QXmppBitsOfBinaryDataList QXmppRegisterIq::bitsOfBinaryData() const
{
return d->bitsOfBinaryData;
}
-/// Returns a list of data attached using XEP-0231: Bits of Binary.
+///
+/// Returns a list of data attached using \xep{0231}: Bits of Binary.
///
/// This could be used to resolve a \c cid: URL of an CAPTCHA field of the
/// form.
///
/// \since QXmpp 1.2
-
+///
QXmppBitsOfBinaryDataList &QXmppRegisterIq::bitsOfBinaryData()
{
return d->bitsOfBinaryData;
}
-/// Sets a list of XEP-0231: Bits of Binary attachments to be included.
+///
+/// Sets a list of \xep{0231}: Bits of Binary attachments to be included.
///
/// \since QXmpp 1.2
-
+///
void QXmppRegisterIq::setBitsOfBinaryData(const QXmppBitsOfBinaryDataList &bitsOfBinaryData)
{
d->bitsOfBinaryData = bitsOfBinaryData;
diff --git a/src/base/QXmppRegisterIq.h b/src/base/QXmppRegisterIq.h
index 9403d4bc..01e7b791 100644
--- a/src/base/QXmppRegisterIq.h
+++ b/src/base/QXmppRegisterIq.h
@@ -32,7 +32,7 @@ class QXmppBitsOfBinaryDataList;
class QXmppRegisterIqPrivate;
/// \brief The QXmppRegisterIq class represents a registration IQ
-/// as defined by XEP-0077: In-Band Registration.
+/// as defined by \xep{0077}: In-Band Registration.
///
/// It is used to create an account on the server.
///
diff --git a/src/base/QXmppResultSet.h b/src/base/QXmppResultSet.h
index b75d7f1a..02d03645 100644
--- a/src/base/QXmppResultSet.h
+++ b/src/base/QXmppResultSet.h
@@ -29,7 +29,7 @@
#include <QDateTime>
/// \brief The QXmppResultSetQuery class represents a set element in a query
-/// as defined by XEP-0059: Result Set Management.
+/// as defined by \xep{0059}: Result Set Management.
class QXMPP_EXPORT QXmppResultSetQuery
{
@@ -63,7 +63,7 @@ private:
};
/// \brief The QXmppResultSetReply class represents a set element in a reply
-/// as defined by XEP-0059: Result Set Management.
+/// as defined by \xep{0059}: Result Set Management.
class QXMPP_EXPORT QXmppResultSetReply
{
diff --git a/src/base/QXmppRpcIq.h b/src/base/QXmppRpcIq.h
index 959491a5..a07348dd 100644
--- a/src/base/QXmppRpcIq.h
+++ b/src/base/QXmppRpcIq.h
@@ -37,7 +37,7 @@ public:
};
/// \brief The QXmppRpcResponseIq class represents an IQ used to carry
-/// an RPC response as specified by XEP-0009: Jabber-RPC.
+/// an RPC response as specified by \xep{0009}: Jabber-RPC.
///
/// \ingroup Stanzas
@@ -72,7 +72,7 @@ private:
};
/// \brief The QXmppRpcInvokeIq class represents an IQ used to carry
-/// an RPC invocation as specified by XEP-0009: Jabber-RPC.
+/// an RPC invocation as specified by \xep{0009}: Jabber-RPC.
///
/// \ingroup Stanzas
diff --git a/src/base/QXmppStanza.cpp b/src/base/QXmppStanza.cpp
index 3148181e..926c7b6f 100644
--- a/src/base/QXmppStanza.cpp
+++ b/src/base/QXmppStanza.cpp
@@ -608,7 +608,7 @@ void QXmppStanza::setExtensions(const QXmppElementList &extensions)
}
/// Returns the stanza's extended addresses as defined by
-/// XEP-0033: Extended Stanza Addressing.
+/// \xep{0033}: Extended Stanza Addressing.
QList<QXmppExtendedAddress> QXmppStanza::extendedAddresses() const
{
@@ -616,7 +616,7 @@ QList<QXmppExtendedAddress> QXmppStanza::extendedAddresses() const
}
/// Sets the stanza's extended addresses as defined by
-/// XEP-0033: Extended Stanza Addressing.
+/// \xep{0033}: Extended Stanza Addressing.
void QXmppStanza::setExtendedAddresses(const QList<QXmppExtendedAddress> &addresses)
{
diff --git a/src/base/QXmppStanza.h b/src/base/QXmppStanza.h
index 11db8f27..31f3d99f 100644
--- a/src/base/QXmppStanza.h
+++ b/src/base/QXmppStanza.h
@@ -40,12 +40,15 @@
class QXmppExtendedAddressPrivate;
-/// \brief Represents an extended address as defined by XEP-0033: Extended Stanza Addressing.
///
-/// Extended addresses maybe of different types: some are defined by XEP-0033,
-/// others are defined in separate XEPs (for instance XEP-0146: Remote Controlling Clients).
-/// That is why the "type" property is a string rather than an enumerated type.
-
+/// \brief Represents an extended address as defined by \xep{0033}: Extended
+/// Stanza Addressing.
+///
+/// Extended addresses maybe of different types: some are defined by \xep{0033},
+/// others are defined in separate XEPs (for instance \xep{0146}: Remote
+/// Controlling Clients). That is why the "type" property is a string rather
+/// than an enumerated type.
+///
class QXMPP_EXPORT QXmppExtendedAddress
{
public:
diff --git a/src/base/QXmppStream.cpp b/src/base/QXmppStream.cpp
index a97b7407..03ffeadf 100644
--- a/src/base/QXmppStream.cpp
+++ b/src/base/QXmppStream.cpp
@@ -65,10 +65,11 @@ QXmppStreamPrivate::QXmppStreamPrivate()
{
}
+///
/// Constructs a base XMPP stream.
///
/// \param parent
-
+///
QXmppStream::QXmppStream(QObject *parent)
: QXmppLoggable(parent),
d(new QXmppStreamPrivate)
@@ -80,16 +81,17 @@ QXmppStream::QXmppStream(QObject *parent)
}
}
+///
/// Destroys a base XMPP stream.
-
+///
QXmppStream::~QXmppStream()
{
delete d;
}
+///
/// Disconnects from the remote host.
///
-
void QXmppStream::disconnectFromHost()
{
d->streamManagementEnabled = false;
@@ -104,11 +106,12 @@ void QXmppStream::disconnectFromHost()
}
}
+///
/// Handles a stream start event, which occurs when the underlying transport
/// becomes ready (socket connected, encryption started).
///
/// If you redefine handleStart(), make sure to call the base class's method.
-
+///
void QXmppStream::handleStart()
{
d->streamManagementEnabled = false;
@@ -116,19 +119,20 @@ void QXmppStream::handleStart()
d->streamStart.clear();
}
+///
/// Returns true if the stream is connected.
///
-
bool QXmppStream::isConnected() const
{
return d->socket &&
d->socket->state() == QAbstractSocket::ConnectedState;
}
+///
/// Sends raw data to the peer.
///
/// \param data
-
+///
bool QXmppStream::sendData(const QByteArray &data)
{
logSent(QString::fromUtf8(data));
@@ -137,10 +141,11 @@ bool QXmppStream::sendData(const QByteArray &data)
return d->socket->write(data) == data.size();
}
+///
/// Sends an XMPP packet to the peer.
///
/// \param packet
-
+///
bool QXmppStream::sendPacket(const QXmppStanza &packet)
{
// prepare packet
@@ -159,17 +164,17 @@ bool QXmppStream::sendPacket(const QXmppStanza &packet)
return success;
}
+///
/// Returns the QSslSocket used for this stream.
///
-
QSslSocket *QXmppStream::socket() const
{
return d->socket;
}
+///
/// Sets the QSslSocket used for this stream.
///
-
void QXmppStream::setSocket(QSslSocket *socket)
{
d->socket = socket;
@@ -271,10 +276,12 @@ void QXmppStream::_q_socketReadyRead()
disconnectFromHost();
}
-/// Enables Stream Management acks / reqs (XEP-0198).
+///
+/// Enables Stream Management acks / reqs (\xep{0198}).
///
/// \param resetSequenceNumber Indicates if the sequence numbers should be reset.
/// This must be done iff the stream is not resumed.
+///
void QXmppStream::enableStreamManagement(bool resetSequenceNumber)
{
d->streamManagementEnabled = true;
@@ -303,13 +310,18 @@ void QXmppStream::enableStreamManagement(bool resetSequenceNumber)
}
}
-/// Returns the sequence number of the last incoming stanza (XEP-0198).
+///
+/// Returns the sequence number of the last incoming stanza (\xep{0198}).
+///
unsigned QXmppStream::lastIncomingSequenceNumber() const
{
return d->lastIncomingSequenceNumber;
}
-/// Sets the last acknowledged sequence number for outgoing stanzas (XEP-0198).
+///
+/// Sets the last acknowledged sequence number for outgoing stanzas
+/// (\xep{0198}).
+///
void QXmppStream::setAcknowledgedSequenceNumber(unsigned sequenceNumber)
{
for (QMap<unsigned, QByteArray>::iterator it = d->unacknowledgedStanzas.begin(); it != d->unacknowledgedStanzas.end();) {
@@ -320,9 +332,11 @@ void QXmppStream::setAcknowledgedSequenceNumber(unsigned sequenceNumber)
}
}
-/// Handles an incoming acknowledgement from XEP-0198.
+///
+/// Handles an incoming acknowledgement from \xep{0198}.
///
/// \param element
+///
void QXmppStream::handleAcknowledgement(QDomElement &element)
{
if (!d->streamManagementEnabled)
@@ -333,7 +347,9 @@ void QXmppStream::handleAcknowledgement(QDomElement &element)
setAcknowledgedSequenceNumber(ack.seqNo());
}
-/// Sends an acknowledgement as defined in XEP-0198.
+///
+/// Sends an acknowledgement as defined in \xep{0198}.
+///
void QXmppStream::sendAcknowledgement()
{
if (!d->streamManagementEnabled)
@@ -349,7 +365,9 @@ void QXmppStream::sendAcknowledgement()
sendData(data);
}
-/// Sends an acknowledgement request as defined in XEP-0198.
+///
+/// Sends an acknowledgement request as defined in \xep{0198}.
+///
void QXmppStream::sendAcknowledgementRequest()
{
if (!d->streamManagementEnabled)
diff --git a/src/base/QXmppStream.h b/src/base/QXmppStream.h
index 19c3cbea..05555d86 100644
--- a/src/base/QXmppStream.h
+++ b/src/base/QXmppStream.h
@@ -74,28 +74,28 @@ protected:
/// \param element
virtual void handleStream(const QDomElement &element) = 0;
- /// Enables Stream Management acks / reqs (XEP-0198).
+ /// Enables Stream Management acks / reqs (\xep{0198}).
///
/// \param resetSeqno Indicates if the sequence numbers should be reset.
/// This must be done iff the stream is not resumed.
void enableStreamManagement(bool resetSequenceNumber);
- /// Returns the sequence number of the last incoming stanza (XEP-0198).
+ /// Returns the sequence number of the last incoming stanza (\xep{0198}).
unsigned lastIncomingSequenceNumber() const;
- /// Sets the last acknowledged sequence number for outgoing stanzas (XEP-0198).
+ /// Sets the last acknowledged sequence number for outgoing stanzas (\xep{0198}).
void setAcknowledgedSequenceNumber(unsigned sequenceNumber);
private:
- /// Handles an incoming acknowledgement from XEP-0198.
+ /// Handles an incoming acknowledgement from \xep{0198}.
///
/// \param element
void handleAcknowledgement(QDomElement &element);
- /// Sends an acknowledgement as defined in XEP-0198.
+ /// Sends an acknowledgement as defined in \xep{0198}.
void sendAcknowledgement();
- /// Sends an acknowledgement request as defined in XEP-0198.
+ /// Sends an acknowledgement request as defined in \xep{0198}.
void sendAcknowledgementRequest();
public slots:
diff --git a/src/base/QXmppStreamFeatures.cpp b/src/base/QXmppStreamFeatures.cpp
index 37364589..8dd68e40 100644
--- a/src/base/QXmppStreamFeatures.cpp
+++ b/src/base/QXmppStreamFeatures.cpp
@@ -125,31 +125,60 @@ void QXmppStreamFeatures::setTlsMode(QXmppStreamFeatures::Mode mode)
d->tlsMode = mode;
}
+///
+/// Returns the mode (disabled, enabled or required) for \xep{0198}: Stream
+/// Management
+///
QXmppStreamFeatures::Mode QXmppStreamFeatures::streamManagementMode() const
{
return d->streamManagementMode;
}
+///
+/// Sets the mode for \xep{0198}: Stream Management
+///
+/// \param mode The mode to set.
+///
void QXmppStreamFeatures::setStreamManagementMode(QXmppStreamFeatures::Mode mode)
{
d->streamManagementMode = mode;
}
+///
+/// Returns the mode for \xep{0352}: Client State Indication
+///
QXmppStreamFeatures::Mode QXmppStreamFeatures::clientStateIndicationMode() const
{
return d->csiMode;
}
+///
+/// Sets the mode for \xep{0352}: Client State Indication
+///
+/// \param mode The mode to set.
+///
void QXmppStreamFeatures::setClientStateIndicationMode(QXmppStreamFeatures::Mode mode)
{
d->csiMode = mode;
}
+///
+/// Returns the mode for \xep{0077}: In-Band Registration
+///
+/// \since QXmpp 1.1
+///
QXmppStreamFeatures::Mode QXmppStreamFeatures::registerMode() const
{
return d->registerMode;
}
+///
+/// Sets the mode for \xep{0077}: In-Band Registration
+///
+/// \param mode The mode to set.
+///
+/// \since QXmpp 1.1
+///
void QXmppStreamFeatures::setRegisterMode(const QXmppStreamFeatures::Mode &registerMode)
{
d->registerMode = registerMode;
diff --git a/src/base/QXmppStreamFeatures.h b/src/base/QXmppStreamFeatures.h
index 4db30f77..6a56af49 100644
--- a/src/base/QXmppStreamFeatures.h
+++ b/src/base/QXmppStreamFeatures.h
@@ -67,33 +67,13 @@ public:
Mode tlsMode() const;
void setTlsMode(Mode mode);
- /// Returns the mode (disabled, enabled or required) for XEP-0198: Stream
- /// Management
Mode streamManagementMode() const;
-
- /// Sets the mode for XEP-0198: Stream Management
- ///
- /// \param mode The mode to set.
void setStreamManagementMode(Mode mode);
- /// Returns the mode for XEP-0352: Client State Indication
Mode clientStateIndicationMode() const;
-
- /// Sets the mode for XEP-0352: Client State Indication
- ///
- /// \param mode The mode to set.
void setClientStateIndicationMode(Mode mode);
- /// Returns the mode for XEP-0077: In-Band Registration
- ///
- /// \since QXmpp 1.1
Mode registerMode() const;
-
- /// Sets the mode for XEP-0077: In-Band Registration
- ///
- /// \param mode The mode to set.
- ///
- /// \since QXmpp 1.1
void setRegisterMode(const Mode &registerMode);
/// \cond
diff --git a/src/base/QXmppUtils.cpp b/src/base/QXmppUtils.cpp
index 5d09c1c7..c0ba62b2 100644
--- a/src/base/QXmppUtils.cpp
+++ b/src/base/QXmppUtils.cpp
@@ -107,9 +107,10 @@ static quint32 crctable[256] = {
0xB40BBE37L, 0xC30C8EA1L, 0x5A05DF1BL, 0x2D02EF8DL
};
+///
/// Parses a date-time from a string according to
-/// XEP-0082: XMPP Date and Time Profiles.
-
+/// \xep{0082}: XMPP Date and Time Profiles.
+///
QDateTime QXmppUtils::datetimeFromString(const QString &str)
{
QRegExp tzRe("(Z|([+-])([0-9]{2}):([0-9]{2}))");
@@ -138,9 +139,10 @@ QDateTime QXmppUtils::datetimeFromString(const QString &str)
return dt;
}
+///
/// Serializes a date-time to a string according to
-/// XEP-0082: XMPP Date and Time Profiles.
-
+/// \xep{0082}: XMPP Date and Time Profiles.
+///
QString QXmppUtils::datetimeToString(const QDateTime &dt)
{
QDateTime utc = dt.toUTC();
@@ -150,9 +152,10 @@ QString QXmppUtils::datetimeToString(const QDateTime &dt)
return utc.toString("yyyy-MM-ddThh:mm:ssZ");
}
+///
/// Parses a timezone offset (in seconds) from a string according to
-/// XEP-0082: XMPP Date and Time Profiles.
-
+/// \xep{0082}: XMPP Date and Time Profiles.
+///
int QXmppUtils::timezoneOffsetFromString(const QString &str)
{
QRegExp tzRe("(Z|([+-])([0-9]{2}):([0-9]{2}))");
@@ -172,9 +175,10 @@ int QXmppUtils::timezoneOffsetFromString(const QString &str)
return offset;
}
+///
/// Serializes a timezone offset (in seconds) to a string according to
-/// XEP-0082: XMPP Date and Time Profiles.
-
+/// \xep{0082}: XMPP Date and Time Profiles.
+///
QString QXmppUtils::timezoneOffsetToString(int secs)
{
if (!secs)
diff --git a/src/base/QXmppVCardIq.h b/src/base/QXmppVCardIq.h
index eb3ade50..954de779 100644
--- a/src/base/QXmppVCardIq.h
+++ b/src/base/QXmppVCardIq.h
@@ -216,7 +216,7 @@ QXMPP_EXPORT bool operator!=(const QXmppVCardOrganization &, const QXmppVCardOrg
/// \brief Represents the XMPP vCard.
///
/// The functions names are self explanatory.
-/// Look at QXmppVCardManager and XEP-0054: vcard-temp for more details.
+/// Look at QXmppVCardManager and \xep{0054}: vcard-temp for more details.
///
/// There are many field of XMPP vCard which are not present in
/// this class. File a issue for the same. We will add the requested
diff --git a/src/base/QXmppVersionIq.h b/src/base/QXmppVersionIq.h
index 3d69bc2f..9fddd2b0 100644
--- a/src/base/QXmppVersionIq.h
+++ b/src/base/QXmppVersionIq.h
@@ -27,7 +27,7 @@
#include "QXmppIq.h"
/// \brief The QXmppVersionIq class represents an IQ for conveying a software
-/// version as defined by XEP-0092: Software Version.
+/// version as defined by \xep{0092}: Software Version.
///
/// \ingroup Stanzas