diff options
| author | Linus Jahn <lnj@kaidan.im> | 2019-10-23 13:23:39 +0200 |
|---|---|---|
| committer | Linus Jahn <lnj@kaidan.im> | 2019-10-23 13:26:48 +0200 |
| commit | da8fbd9f39bc5cbabb6b8780a8b21763f8ad1b96 (patch) | |
| tree | 1574b80c5843f05f605099992e884668a44a30a9 | |
| parent | 979918a40759064c01f31bc099217086b81936d9 (diff) | |
Add \since QXmpp 1.1 to all new methods and classes
Methods of new classes have no \since tag.
| -rw-r--r-- | src/base/QXmppHttpUploadIq.h | 8 | ||||
| -rw-r--r-- | src/base/QXmppMessage.cpp | 40 | ||||
| -rw-r--r-- | src/base/QXmppMessage.h | 4 | ||||
| -rw-r--r-- | src/base/QXmppMixIq.h | 2 | ||||
| -rw-r--r-- | src/base/QXmppMixItem.h | 4 | ||||
| -rw-r--r-- | src/base/QXmppPresence.cpp | 8 | ||||
| -rw-r--r-- | src/base/QXmppStanza.cpp | 10 | ||||
| -rw-r--r-- | src/base/QXmppStreamFeatures.h | 4 | ||||
| -rw-r--r-- | src/client/QXmppUploadRequestManager.h | 2 |
9 files changed, 80 insertions, 2 deletions
diff --git a/src/base/QXmppHttpUploadIq.h b/src/base/QXmppHttpUploadIq.h index 064ce850..fc14467c 100644 --- a/src/base/QXmppHttpUploadIq.h +++ b/src/base/QXmppHttpUploadIq.h @@ -35,7 +35,9 @@ class QXmppHttpUploadRequestIqPrivate; class QXmppHttpUploadSlotIqPrivate; /// \brief Represents an HTTP File Upload IQ for requesting an upload slot as -/// defined by XEP-0363: HTTP File Upload [v0.9.0]. +/// defined by XEP-0363: HTTP File Upload. +/// +/// \since QXmpp 1.1 /// /// \ingroup Stanzas @@ -70,7 +72,9 @@ private: }; /// \brief Represents an HTTP File Upload IQ result for receiving an upload slot as -/// defined by XEP-0363: HTTP File Upload [v0.9.0]. +/// defined by XEP-0363: HTTP File Upload. +/// +/// \since QXmpp 1.1 /// /// \ingroup Stanzas diff --git a/src/base/QXmppMessage.cpp b/src/base/QXmppMessage.cpp index c6572f71..47f9bed9 100644 --- a/src/base/QXmppMessage.cpp +++ b/src/base/QXmppMessage.cpp @@ -532,6 +532,8 @@ void QXmppMessage::setReplaceId(const QString &replaceId) /// Returns true if the message contains the hint passed, as defined in /// XEP-0334: Message Processing Hints +/// +/// \since QXmpp 1.1 bool QXmppMessage::hasHint(const Hint hint) const { @@ -540,6 +542,8 @@ bool QXmppMessage::hasHint(const Hint hint) const /// Adds a hint to the message, as defined in XEP-0334: Message Processing /// Hints +/// +/// \since QXmpp 1.1 void QXmppMessage::addHint(const Hint hint) { @@ -548,6 +552,8 @@ void QXmppMessage::addHint(const Hint hint) /// Removes a hint from the message, as defined in XEP-0334: Message Processing /// Hints +/// +/// \since QXmpp 1.1 void QXmppMessage::removeHint(const Hint hint) { @@ -556,6 +562,8 @@ void QXmppMessage::removeHint(const Hint hint) /// Removes all hints from the message, as defined in XEP-0334: Message /// Processing Hints +/// +/// \since QXmpp 1.1 void QXmppMessage::removeAllHints() { @@ -564,6 +572,8 @@ void QXmppMessage::removeAllHints() /// Returns the message id this message is linked/attached to. See XEP-0367: /// Message Attaching for details. +/// +/// \since QXmpp 1.1 QString QXmppMessage::attachId() const { @@ -575,6 +585,8 @@ QString QXmppMessage::attachId() const /// /// The used message id depends on the message context, see the Business rules /// section of the XEP for details about when to use which id. +/// +/// \since QXmpp 1.1 void QXmppMessage::setAttachId(const QString &attachId) { @@ -582,6 +594,8 @@ void QXmppMessage::setAttachId(const QString &attachId) } /// Returns the actual JID of a MIX channel participant. +/// +/// \since QXmpp 1.1 QString QXmppMessage::mixUserJid() const { @@ -589,6 +603,8 @@ QString QXmppMessage::mixUserJid() const } /// Sets the actual JID of a MIX channel participant. +/// +/// \since QXmpp 1.1 void QXmppMessage::setMixUserJid(const QString& mixUserJid) { @@ -596,6 +612,8 @@ void QXmppMessage::setMixUserJid(const QString& mixUserJid) } /// Returns the MIX participant's nickname. +/// +/// \since QXmpp 1.1 QString QXmppMessage::mixUserNick() const { @@ -603,6 +621,8 @@ QString QXmppMessage::mixUserNick() const } /// Sets the MIX participant's nickname. +/// +/// \since QXmpp 1.1 void QXmppMessage::setMixUserNick(const QString& mixUserNick) { @@ -619,6 +639,8 @@ void QXmppMessage::setMixUserNick(const QString& mixUserNick) /// \note If this returns QXmppMessage::UnknownEncryption, you can still get /// the namespace of the encryption with \c encryptionMethodNs() and possibly /// also a name with \c encryptionName(). +/// +/// \since QXmpp 1.1 QXmppMessage::EncryptionMethod QXmppMessage::encryptionMethod() const { @@ -633,6 +655,8 @@ QXmppMessage::EncryptionMethod QXmppMessage::encryptionMethod() const /// Advertises that this message is encrypted with the given encryption method. /// See XEP-0380: Explicit Message Encryption for details. +/// +/// \since QXmpp 1.1 void QXmppMessage::setEncryptionMethod(QXmppMessage::EncryptionMethod method) { @@ -641,6 +665,8 @@ void QXmppMessage::setEncryptionMethod(QXmppMessage::EncryptionMethod method) /// Returns the namespace of the advertised encryption method via. XEP-0380: /// Explicit Message Encryption. +/// +/// \since QXmpp 1.1 QString QXmppMessage::encryptionMethodNs() const { @@ -649,6 +675,8 @@ 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. +/// +/// \since QXmpp 1.1 void QXmppMessage::setEncryptionMethodNs(const QString &encryptionMethod) { @@ -658,6 +686,8 @@ 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 /// for details. +/// +/// \since QXmpp 1.1 QString QXmppMessage::encryptionName() const { @@ -671,6 +701,8 @@ QString QXmppMessage::encryptionName() const /// /// \note This should only be used, if the encryption method is custom and is /// not one of the methods listed in the XEP. +/// +/// \since QXmpp 1.1 void QXmppMessage::setEncryptionName(const QString &encryptionName) { @@ -681,6 +713,8 @@ void QXmppMessage::setEncryptionName(const QString &encryptionName) /// messages. The spoiler hint however can still be empty. /// /// A spoiler message's content should not be visible to the user by default. +/// +/// \since QXmpp 1.1 bool QXmppMessage::isSpoiler() const { @@ -693,6 +727,8 @@ bool QXmppMessage::isSpoiler() const /// The content of spoiler messages will not be displayed by default to the /// user. However, clients not supporting spoiler messages will still display /// the content as usual. +/// +/// \since QXmpp 1.1 void QXmppMessage::setIsSpoiler(bool isSpoiler) { @@ -702,6 +738,8 @@ void QXmppMessage::setIsSpoiler(bool isSpoiler) /// Returns the spoiler hint as specified in XEP-0382: Spoiler messages. /// /// The hint may be empty, even if isSpoiler is true. +/// +/// \since QXmpp 1.1 QString QXmppMessage::spoilerHint() const { @@ -715,6 +753,8 @@ QString QXmppMessage::spoilerHint() const /// /// Keep in mind that the spoiler hint is not displayed at all by clients not /// supporting spoiler messages. +/// +/// \since QXmpp 1.1 void QXmppMessage::setSpoilerHint(const QString &spoilerHint) { diff --git a/src/base/QXmppMessage.h b/src/base/QXmppMessage.h index d0301749..3eebce81 100644 --- a/src/base/QXmppMessage.h +++ b/src/base/QXmppMessage.h @@ -69,6 +69,8 @@ public: }; /// XEP-0334: Message Processing Hints + /// + /// \since QXmpp 1.1 enum Hint { NoPermanentStore = 1 << 0, ///< Do not allow permanent storage NoStore = 1 << 1, ///< Do not store at all @@ -79,6 +81,8 @@ 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. + /// + /// \since QXmpp 1.1 enum EncryptionMethod { NoEncryption, ///< No encryption UnknownEncryption, ///< Unknown encryption diff --git a/src/base/QXmppMixIq.h b/src/base/QXmppMixIq.h index 14f25026..6f10ba5c 100644 --- a/src/base/QXmppMixIq.h +++ b/src/base/QXmppMixIq.h @@ -34,6 +34,8 @@ class QXmppMixIqPrivate; /// XEP-0405: Mediated Information eXchange (MIX): Participant Server /// Requirements. /// +/// \since QXmpp 1.1 +/// /// \ingroup Stanzas class QXMPP_EXPORT QXmppMixIq : public QXmppIq diff --git a/src/base/QXmppMixItem.h b/src/base/QXmppMixItem.h index fd4f1764..2e1a9f2c 100644 --- a/src/base/QXmppMixItem.h +++ b/src/base/QXmppMixItem.h @@ -35,6 +35,8 @@ class QXmppMixParticipantItemPrivate; /// channel containing channel information as defined by XEP-0369: Mediated /// Information eXchange (MIX). /// +/// \since QXmpp 1.1 +/// /// \ingroup Stanzas class QXMPP_EXPORT QXmppMixInfoItem @@ -68,6 +70,8 @@ private: /// channel participant as defined by XEP-0369: Mediated Information eXchange /// (MIX). /// +/// \since QXmpp 1.1 +/// /// \ingroup Stanzas class QXMPP_EXPORT QXmppMixParticipantItem diff --git a/src/base/QXmppPresence.cpp b/src/base/QXmppPresence.cpp index ad0b1c60..b2521eb8 100644 --- a/src/base/QXmppPresence.cpp +++ b/src/base/QXmppPresence.cpp @@ -543,6 +543,8 @@ void QXmppPresence::setLastUserInteraction(const QDateTime& lastUserInteraction) } /// Returns the actual (full) JID of the MIX channel participant. +/// +/// \since QXmpp 1.1 QString QXmppPresence::mixUserJid() const { @@ -550,6 +552,8 @@ QString QXmppPresence::mixUserJid() const } /// Sets the actual (full) JID of the MIX channel participant. +/// +/// \since QXmpp 1.1 void QXmppPresence::setMixUserJid(const QString& mixUserJid) { @@ -557,6 +561,8 @@ void QXmppPresence::setMixUserJid(const QString& mixUserJid) } /// Returns the MIX participant's nickname. +/// +/// \since QXmpp 1.1 QString QXmppPresence::mixUserNick() const { @@ -564,6 +570,8 @@ QString QXmppPresence::mixUserNick() const } /// Sets the MIX participant's nickname. +/// +/// \since QXmpp 1.1 void QXmppPresence::setMixUserNick(const QString& mixUserNick) { diff --git a/src/base/QXmppStanza.cpp b/src/base/QXmppStanza.cpp index 113b0b6c..22d0ce6e 100644 --- a/src/base/QXmppStanza.cpp +++ b/src/base/QXmppStanza.cpp @@ -255,6 +255,8 @@ void QXmppStanza::Error::setType(QXmppStanza::Error::Type type) /// Returns true, if an HTTP File Upload failed, because the file was too /// large. +/// +/// \since QXmpp 1.1 bool QXmppStanza::Error::fileTooLarge() const { @@ -264,6 +266,8 @@ bool QXmppStanza::Error::fileTooLarge() const /// Sets whether the requested file for HTTP File Upload was too large. /// /// You should also set maxFileSize in this case. +/// +/// \since QXmpp 1.1 void QXmppStanza::Error::setFileTooLarge(bool fileTooLarge) { @@ -271,6 +275,8 @@ void QXmppStanza::Error::setFileTooLarge(bool fileTooLarge) } /// Returns the maximum file size allowed for uploading via. HTTP File Upload. +/// +/// \since QXmpp 1.1 qint64 QXmppStanza::Error::maxFileSize() const { @@ -280,6 +286,8 @@ qint64 QXmppStanza::Error::maxFileSize() const /// Sets the maximum file size allowed for uploading via. HTTP File Upload. /// /// This sets fileTooLarge to true. +/// +/// \since QXmpp 1.1 void QXmppStanza::Error::setMaxFileSize(qint64 maxFileSize) { @@ -288,6 +296,8 @@ void QXmppStanza::Error::setMaxFileSize(qint64 maxFileSize) } /// Returns when to retry the upload request via. HTTP File Upload. +/// +/// \since QXmpp 1.1 QDateTime QXmppStanza::Error::retryDate() const { diff --git a/src/base/QXmppStreamFeatures.h b/src/base/QXmppStreamFeatures.h index 5a697b83..09ca7538 100644 --- a/src/base/QXmppStreamFeatures.h +++ b/src/base/QXmppStreamFeatures.h @@ -74,11 +74,15 @@ public: 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 /// /// \pa mode The mode to set. + /// + /// \since QXmpp 1.1 void setRegisterMode(const Mode ®isterMode); /// \cond diff --git a/src/client/QXmppUploadRequestManager.h b/src/client/QXmppUploadRequestManager.h index 7fc7e653..97eecc82 100644 --- a/src/client/QXmppUploadRequestManager.h +++ b/src/client/QXmppUploadRequestManager.h @@ -88,6 +88,8 @@ private: /// can provide the JID of the upload service which should be used for /// uploading. /// +/// \since QXmpp 1.1 +/// /// \ingroup Managers class QXMPP_EXPORT QXmppUploadRequestManager : public QXmppClientExtension |
