From 3bc421595e621aa2f0561356e36876bae176c5bf Mon Sep 17 00:00:00 2001 From: Linus Jahn Date: Mon, 6 Apr 2020 16:46:06 +0200 Subject: Add \since tags for QXmpp 1.0 everywhere --- src/client/QXmppCarbonManager.h | 5 ++++- src/client/QXmppClient.cpp | 10 ++++++++-- src/client/QXmppMamManager.h | 5 ++++- src/client/QXmppOutgoingClient.cpp | 10 +++++++++- 4 files changed, 25 insertions(+), 5 deletions(-) (limited to 'src/client') 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; -- cgit v1.2.3