Add \since tags for QXmpp 1.0 everywhere

13 files changed, 81 insertions, 28 deletions

diff --git a/src/base/QXmppIq.cpp b/src/base/QXmppIq.cpp
index 5cc51791..5b405048 100644
--- a/src/base/QXmppIq.cpp
+++ b/src/base/QXmppIq.cpp
@@ -89,9 +89,12 @@ void QXmppIq::setType(QXmppIq::Type type)
     d->type = type;
 }
 
+///
 /// Indicates if the QXmppStanza is a stanza in the XMPP sense (i. e. a message,
 /// iq or presence)
-
+///
+/// \since QXmpp 1.0
+///
 bool QXmppIq::isXmppStanza() const
 {
     return true;
diff --git a/src/base/QXmppMamIq.h b/src/base/QXmppMamIq.h
index 96c8f719..d0a05c6c 100644
--- a/src/base/QXmppMamIq.h
+++ b/src/base/QXmppMamIq.h
@@ -39,6 +39,8 @@ class QXmppMamResultIqPrivate;
 ///
 /// \ingroup Stanzas
 ///
+/// \since QXmpp 1.0
+///
 class QXmppMamQueryIq : public QXmppIq
 {
 public:
@@ -73,6 +75,8 @@ private:
 ///
 /// \ingroup Stanzas
 ///
+/// \since QXmpp 1.0
+///
 class QXmppMamResultIq : public QXmppIq
 {
 public:
diff --git a/src/base/QXmppMessage.cpp b/src/base/QXmppMessage.cpp
index a66a6743..556558d7 100644
--- a/src/base/QXmppMessage.cpp
+++ b/src/base/QXmppMessage.cpp
@@ -211,9 +211,12 @@ QXmppMessage::~QXmppMessage() = default;
 
 QXmppMessage &QXmppMessage::operator=(const QXmppMessage &other) = default;
 
+///
 /// Indicates if the QXmppStanza is a stanza in the XMPP sense (i. e. a message,
 /// iq or presence)
-
+///
+/// \since QXmpp 1.0
+///
 bool QXmppMessage::isXmppStanza() const
 {
     return true;
diff --git a/src/base/QXmppPresence.cpp b/src/base/QXmppPresence.cpp
index 207ac8b6..edecc961 100644
--- a/src/base/QXmppPresence.cpp
+++ b/src/base/QXmppPresence.cpp
@@ -117,9 +117,12 @@ QXmppPresence::~QXmppPresence() = default;
 
 QXmppPresence &QXmppPresence::operator=(const QXmppPresence &other) = default;
 
+///
 /// Indicates if the QXmppStanza is a stanza in the XMPP sence (i. e. a message,
 /// iq or presence)
-
+///
+/// \since QXmpp 1.0
+///
 bool QXmppPresence::isXmppStanza() const
 {
     return true;
@@ -331,17 +334,23 @@ void QXmppPresence::setMucSupported(bool supported)
     d->mucSupported = supported;
 }
 
+///
 /// Returns when the last user interaction with the client took place. See
 /// \xep{0319}: Last User Interaction in Presence for details.
-
+///
+/// \since QXmpp 1.0
+///
 QDateTime QXmppPresence::lastUserInteraction() const
 {
     return d->lastUserInteraction;
 }
 
+///
 /// Sets the time of the last user interaction as defined in \xep{0319}: Last
 /// User Interaction in Presence.
-
+///
+/// \since QXmpp 1.0
+///
 void QXmppPresence::setLastUserInteraction(const QDateTime &lastUserInteraction)
 {
     d->lastUserInteraction = lastUserInteraction;
diff --git a/src/base/QXmppRosterIq.cpp b/src/base/QXmppRosterIq.cpp
index ef06dd0a..d20a1ec1 100644
--- a/src/base/QXmppRosterIq.cpp
+++ b/src/base/QXmppRosterIq.cpp
@@ -75,6 +75,8 @@ QList<QXmppRosterIq::Item> QXmppRosterIq::items() const
 ///
 /// \return version as a QString
 ///
+/// \since QXmpp 1.0
+///
 QString QXmppRosterIq::version() const
 {
     return d->version;
@@ -85,6 +87,8 @@ QString QXmppRosterIq::version() const
 ///
 /// \param version as a QString
 ///
+/// \since QXmpp 1.0
+///
 void QXmppRosterIq::setVersion(const QString &version)
 {
     d->version = version;
diff --git a/src/base/QXmppStanza.cpp b/src/base/QXmppStanza.cpp
index 2c2af1d5..859f0977 100644
--- a/src/base/QXmppStanza.cpp
+++ b/src/base/QXmppStanza.cpp
@@ -701,9 +701,12 @@ void QXmppStanza::setExtendedAddresses(const QList<QXmppExtendedAddress> &addres
     d->extendedAddresses = addresses;
 }
 
+///
 /// Indicates if the QXmppStanza is a stanza in the XMPP sense (i. e. a message,
 /// iq or presence)
-
+///
+/// \since QXmpp 1.0
+///
 bool QXmppStanza::isXmppStanza() const
 {
     return false;
diff --git a/src/base/QXmppStream.cpp b/src/base/QXmppStream.cpp
index dac3a02a..b05499c4 100644
--- a/src/base/QXmppStream.cpp
+++ b/src/base/QXmppStream.cpp
@@ -283,8 +283,10 @@ void QXmppStream::_q_socketReadyRead()
 ///
 /// 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.
+/// \param resetSequenceNumber Indicates if the sequence numbers should be
+/// reset. This must be done if the stream is not resumed.
+///
+/// \since QXmpp 1.0
 ///
 void QXmppStream::enableStreamManagement(bool resetSequenceNumber)
 {
@@ -317,6 +319,8 @@ void QXmppStream::enableStreamManagement(bool resetSequenceNumber)
 ///
 /// Returns the sequence number of the last incoming stanza (\xep{0198}).
 ///
+/// \since QXmpp 1.0
+///
 unsigned QXmppStream::lastIncomingSequenceNumber() const
 {
     return d->lastIncomingSequenceNumber;
@@ -326,6 +330,8 @@ unsigned QXmppStream::lastIncomingSequenceNumber() const
 /// Sets the last acknowledged sequence number for outgoing stanzas
 /// (\xep{0198}).
 ///
+/// \since QXmpp 1.0
+///
 void QXmppStream::setAcknowledgedSequenceNumber(unsigned sequenceNumber)
 {
     for (QMap<unsigned, QByteArray>::iterator it = d->unacknowledgedStanzas.begin(); it != d->unacknowledgedStanzas.end();) {
@@ -341,6 +347,8 @@ void QXmppStream::setAcknowledgedSequenceNumber(unsigned sequenceNumber)
 ///
 /// \param element
 ///
+/// \since QXmpp 1.0
+///
 void QXmppStream::handleAcknowledgement(QDomElement &element)
 {
     if (!d->streamManagementEnabled)
@@ -354,6 +362,8 @@ void QXmppStream::handleAcknowledgement(QDomElement &element)
 ///
 /// Sends an acknowledgement as defined in \xep{0198}.
 ///
+/// \since QXmpp 1.0
+///
 void QXmppStream::sendAcknowledgement()
 {
     if (!d->streamManagementEnabled)
@@ -372,6 +382,8 @@ void QXmppStream::sendAcknowledgement()
 ///
 /// Sends an acknowledgement request as defined in \xep{0198}.
 ///
+/// \since QXmpp 1.0
+///
 void QXmppStream::sendAcknowledgementRequest()
 {
     if (!d->streamManagementEnabled)
diff --git a/src/base/QXmppStream.h b/src/base/QXmppStream.h
index ce1f62f9..0156fe80 100644
--- a/src/base/QXmppStream.h
+++ b/src/base/QXmppStream.h
@@ -74,28 +74,15 @@ protected:
     /// \param element
     virtual void handleStream(const QDomElement &element) = 0;
 
-    /// 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.
+    // XEP-0198: Stream Management
     void enableStreamManagement(bool resetSequenceNumber);
-
-    /// 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}).
     void setAcknowledgedSequenceNumber(unsigned sequenceNumber);
 
 private:
-    /// Handles an incoming acknowledgement from \xep{0198}.
-    ///
-    /// \param element
+    // XEP-0198: Stream Management
     void handleAcknowledgement(QDomElement &element);
-
-    /// Sends an acknowledgement as defined in \xep{0198}.
     void sendAcknowledgement();
-
-    /// Sends an acknowledgement request as defined in \xep{0198}.
     void sendAcknowledgementRequest();
 
 public Q_SLOTS:
diff --git a/src/base/QXmppStreamFeatures.cpp b/src/base/QXmppStreamFeatures.cpp
index 70d4dc46..4ca57de2 100644
--- a/src/base/QXmppStreamFeatures.cpp
+++ b/src/base/QXmppStreamFeatures.cpp
@@ -132,6 +132,8 @@ void QXmppStreamFeatures::setTlsMode(QXmppStreamFeatures::Mode mode)
 /// Returns the mode (disabled, enabled or required) for \xep{0198}: Stream
 /// Management
 ///
+/// \since QXmpp 1.0
+///
 QXmppStreamFeatures::Mode QXmppStreamFeatures::streamManagementMode() const
 {
     return d->streamManagementMode;
@@ -142,6 +144,8 @@ QXmppStreamFeatures::Mode QXmppStreamFeatures::streamManagementMode() const
 ///
 /// \param mode The mode to set.
 ///
+/// \since QXmpp 1.0
+///
 void QXmppStreamFeatures::setStreamManagementMode(QXmppStreamFeatures::Mode mode)
 {
     d->streamManagementMode = mode;
@@ -150,6 +154,8 @@ void QXmppStreamFeatures::setStreamManagementMode(QXmppStreamFeatures::Mode mode
 ///
 /// Returns the mode for \xep{0352}: Client State Indication
 ///
+/// \since QXmpp 1.0
+///
 QXmppStreamFeatures::Mode QXmppStreamFeatures::clientStateIndicationMode() const
 {
     return d->csiMode;
@@ -160,6 +166,8 @@ QXmppStreamFeatures::Mode QXmppStreamFeatures::clientStateIndicationMode() const
 ///
 /// \param mode The mode to set.
 ///
+/// \since QXmpp 1.0
+///
 void QXmppStreamFeatures::setClientStateIndicationMode(QXmppStreamFeatures::Mode mode)
 {
     d->csiMode = mode;
diff --git a/src/client/QXmppCarbonManager.h b/src/client/QXmppCarbonManager.h
index 7ac62713..d1e113be 100644
--- a/src/client/QXmppCarbonManager.h
+++ b/src/client/QXmppCarbonManager.h
@@ -28,6 +28,7 @@
 
 class QXmppMessage;
 
+///
 /// \brief The QXmppCarbonManager class handles message carbons
 /// as described in \xep{0280}: Message Carbons.
 ///
@@ -35,7 +36,9 @@ class QXmppMessage;
 /// currently connected client account sent or received a message.
 ///
 /// \ingroup Managers
-
+///
+/// \since QXmpp 1.0
+///
 class QXMPP_EXPORT QXmppCarbonManager : public QXmppClientExtension
 {
     Q_OBJECT
diff --git a/src/client/QXmppClient.cpp b/src/client/QXmppClient.cpp
index da285315..a377c55e 100644
--- a/src/client/QXmppClient.cpp
+++ b/src/client/QXmppClient.cpp
@@ -323,20 +323,26 @@ bool QXmppClient::isConnected() const
     return d->stream->isConnected();
 }
 
+///
 /// Returns true if the current client state is "active", false if it is
 /// "inactive". See \xep{0352}: Client State Indication for details.
 ///
 /// On connect this is always reset to true.
-
+///
+/// \since QXmpp 1.0
+///
 bool QXmppClient::isActive() const
 {
     return d->isActive;
 }
 
+///
 /// Sets the client state as described in \xep{0352}: Client State Indication.
 ///
 /// On connect this is always reset to true.
-
+///
+/// \since QXmpp 1.0
+///
 void QXmppClient::setActive(bool active)
 {
     if (active != d->isActive && isConnected() && d->stream->isClientStateIndicationEnabled()) {
diff --git a/src/client/QXmppMamManager.h b/src/client/QXmppMamManager.h
index 6757c96c..313871bf 100644
--- a/src/client/QXmppMamManager.h
+++ b/src/client/QXmppMamManager.h
@@ -31,6 +31,7 @@
 
 class QXmppMessage;
 
+///
 /// \brief The QXmppMamManager class makes it possible to access message
 /// archives as defined by \xep{0313}: Message Archive Management.
 ///
@@ -43,7 +44,9 @@ class QXmppMessage;
 /// \endcode
 ///
 /// \ingroup Managers
-
+///
+/// \since QXmpp 1.0
+///
 class QXMPP_EXPORT QXmppMamManager : public QXmppClientExtension
 {
     Q_OBJECT
diff --git a/src/client/QXmppOutgoingClient.cpp b/src/client/QXmppOutgoingClient.cpp
index d6a8ff8f..058b629e 100644
--- a/src/client/QXmppOutgoingClient.cpp
+++ b/src/client/QXmppOutgoingClient.cpp
@@ -232,6 +232,11 @@ void QXmppOutgoingClient::connectToHost()
     d->nextSrvRecordIdx = 0;
 }
 
+///
+/// Disconnects from the server and resets the stream management state.
+///
+/// \since QXmpp 1.0
+///
 void QXmppOutgoingClient::disconnectFromHost()
 {
     d->canResume = false;
@@ -266,8 +271,11 @@ bool QXmppOutgoingClient::isConnected() const
     return QXmppStream::isConnected() && d->sessionStarted;
 }
 
+///
 /// Returns true if client state indication (xep-0352) is supported by the server
-
+///
+/// \since QXmpp 1.0
+///
 bool QXmppOutgoingClient::isClientStateIndicationEnabled() const
 {
     return d->clientStateIndicationEnabled;