aboutsummaryrefslogtreecommitdiff
path: root/src/client
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/client
parent776f028d9f3f51e9dbba834a01d1decd737c4a27 (diff)
downloadqxmpp-bc4c3ee94442c9b80993ce109d5070862dc9f170.tar.gz
doc: Use XEP links everywhere
Diffstat (limited to 'src/client')
-rw-r--r--src/client/QXmppArchiveManager.h2
-rw-r--r--src/client/QXmppBookmarkManager.h2
-rw-r--r--src/client/QXmppCallManager.h4
-rw-r--r--src/client/QXmppCarbonManager.h2
-rw-r--r--src/client/QXmppClient.cpp16
-rw-r--r--src/client/QXmppDiscoveryManager.cpp4
-rw-r--r--src/client/QXmppDiscoveryManager.h2
-rw-r--r--src/client/QXmppEntityTimeManager.h2
-rw-r--r--src/client/QXmppMamManager.h2
-rw-r--r--src/client/QXmppMessageReceiptManager.h2
-rw-r--r--src/client/QXmppMucManager.h4
-rw-r--r--src/client/QXmppRpcManager.h2
-rw-r--r--src/client/QXmppTransferManager.h13
-rw-r--r--src/client/QXmppUploadRequestManager.h5
-rw-r--r--src/client/QXmppVCardManager.h5
-rw-r--r--src/client/QXmppVersionManager.h5
16 files changed, 39 insertions, 33 deletions
diff --git a/src/client/QXmppArchiveManager.h b/src/client/QXmppArchiveManager.h
index 5f0cb88e..fca5e1c4 100644
--- a/src/client/QXmppArchiveManager.h
+++ b/src/client/QXmppArchiveManager.h
@@ -35,7 +35,7 @@ class QXmppArchiveListIq;
class QXmppArchivePrefIq;
/// \brief The QXmppArchiveManager class makes it possible to access message
-/// archives as defined by XEP-0136: Message Archiving.
+/// archives as defined by \xep{0136}: Message Archiving.
///
/// To make use of this manager, you need to instantiate it and load it into
/// the QXmppClient instance as follows:
diff --git a/src/client/QXmppBookmarkManager.h b/src/client/QXmppBookmarkManager.h
index 8f14e1f7..2ce70a8c 100644
--- a/src/client/QXmppBookmarkManager.h
+++ b/src/client/QXmppBookmarkManager.h
@@ -32,7 +32,7 @@ class QXmppBookmarkManagerPrivate;
class QXmppBookmarkSet;
/// \brief The QXmppBookmarkManager class allows you to store and retrieve
-/// bookmarks as defined by XEP-0048: Bookmarks.
+/// bookmarks as defined by \xep{0048}: Bookmarks.
///
class QXMPP_EXPORT QXmppBookmarkManager : public QXmppClientExtension
diff --git a/src/client/QXmppCallManager.h b/src/client/QXmppCallManager.h
index 98579601..47ad1984 100644
--- a/src/client/QXmppCallManager.h
+++ b/src/client/QXmppCallManager.h
@@ -151,8 +151,8 @@ private:
/// \brief The QXmppCallManager class provides support for making and
/// receiving voice calls.
///
-/// Session initiation is performed as described by XEP-0166: Jingle,
-/// XEP-0167: Jingle RTP Sessions and XEP-0176: Jingle ICE-UDP Transport
+/// Session initiation is performed as described by \xep{0166}: Jingle,
+/// \xep{0167}: Jingle RTP Sessions and \xep{0176}: Jingle ICE-UDP Transport
/// Method.
///
/// The data stream is connected using Interactive Connectivity Establishment
diff --git a/src/client/QXmppCarbonManager.h b/src/client/QXmppCarbonManager.h
index 52ddf960..26f70c25 100644
--- a/src/client/QXmppCarbonManager.h
+++ b/src/client/QXmppCarbonManager.h
@@ -29,7 +29,7 @@
class QXmppMessage;
/// \brief The QXmppCarbonManager class handles message carbons
-/// as described in XEP-0280: Message Carbons.
+/// as described in \xep{0280}: Message Carbons.
///
/// This class emits signals whenever another resource of the
/// currently connected client account sent or received a message.
diff --git a/src/client/QXmppClient.cpp b/src/client/QXmppClient.cpp
index c72ef078..76ab9f5e 100644
--- a/src/client/QXmppClient.cpp
+++ b/src/client/QXmppClient.cpp
@@ -284,7 +284,7 @@ bool QXmppClient::isConnected() const
}
/// Returns true if the current client state is "active", false if it is
-/// "inactive". See XEP-0352: Client State Indication for details.
+/// "inactive". See \xep{0352}: Client State Indication for details.
///
/// On connect this is always reset to true.
@@ -293,7 +293,7 @@ bool QXmppClient::isActive() const
return d->isActive;
}
-/// Sets the client state as described in XEP-0352: Client State Indication.
+/// Sets the client state as described in \xep{0352}: Client State Indication.
///
/// On connect this is always reset to true.
@@ -325,7 +325,7 @@ QXmppRosterManager& QXmppClient::rosterManager()
/// the bareJid.
///
/// \note Usage of this method is discouraged because most modern clients use
-/// carbon messages (XEP-0280: Message Carbons) and MAM (XEP-0313: Message
+/// carbon messages (\xep{0280}: Message Carbons) and MAM (\xep{0313}: Message
/// Archive Management) and so could possibly receive messages multiple times
/// or not receive them at all.
/// \c QXmppClient::sendPacket() should be used instead with a \c QXmppMessage.
@@ -426,23 +426,25 @@ QXmppStanza::Error::Condition QXmppClient::xmppStreamError()
return d->stream->xmppStreamError();
}
-/// Returns the reference to QXmppVCardManager, implementation of XEP-0054.
+///
+/// Returns the reference to QXmppVCardManager, implementation of \xep{0054}.
/// http://xmpp.org/extensions/xep-0054.html
///
/// \deprecated This method is deprecated since QXmpp 1.1. Use
/// \c QXmppClient::findExtension<QXmppVCardManager>() instead.
-
+///
QXmppVCardManager& QXmppClient::vCardManager()
{
return *findExtension<QXmppVCardManager>();
}
-/// Returns the reference to QXmppVersionManager, implementation of XEP-0092.
+///
+/// Returns the reference to QXmppVersionManager, implementation of \xep{0092}.
/// http://xmpp.org/extensions/xep-0092.html
///
/// \deprecated This method is deprecated since QXmpp 1.1. Use
/// \c QXmppClient::findExtension<QXmppVersionManager>() instead.
-
+///
QXmppVersionManager& QXmppClient::versionManager()
{
return *findExtension<QXmppVersionManager>();
diff --git a/src/client/QXmppDiscoveryManager.cpp b/src/client/QXmppDiscoveryManager.cpp
index 0088fb2b..81ff1144 100644
--- a/src/client/QXmppDiscoveryManager.cpp
+++ b/src/client/QXmppDiscoveryManager.cpp
@@ -232,7 +232,7 @@ QString QXmppDiscoveryManager::clientName() const
}
/// Returns the client's extended information form, as defined
-/// by XEP-0128 Service Discovery Extensions.
+/// by \xep{0128}: Service Discovery Extensions.
QXmppDataForm QXmppDiscoveryManager::clientInfoForm() const
{
@@ -240,7 +240,7 @@ QXmppDataForm QXmppDiscoveryManager::clientInfoForm() const
}
/// Sets the client's extended information form, as defined
-/// by XEP-0128 Service Discovery Extensions.
+/// by \xep{0128}: Service Discovery Extensions.
void QXmppDiscoveryManager::setClientInfoForm(const QXmppDataForm& form)
{
diff --git a/src/client/QXmppDiscoveryManager.h b/src/client/QXmppDiscoveryManager.h
index bf447280..5d59db2b 100644
--- a/src/client/QXmppDiscoveryManager.h
+++ b/src/client/QXmppDiscoveryManager.h
@@ -31,7 +31,7 @@ class QXmppDiscoveryIq;
class QXmppDiscoveryManagerPrivate;
/// \brief The QXmppDiscoveryManager class makes it possible to discover information
-/// about other entities as defined by XEP-0030: Service Discovery.
+/// about other entities as defined by \xep{0030}: Service Discovery.
///
/// \ingroup Managers
diff --git a/src/client/QXmppEntityTimeManager.h b/src/client/QXmppEntityTimeManager.h
index 0a02e154..8370e8eb 100644
--- a/src/client/QXmppEntityTimeManager.h
+++ b/src/client/QXmppEntityTimeManager.h
@@ -29,7 +29,7 @@
class QXmppEntityTimeIq;
/// \brief The QXmppEntityTimeManager class provided the functionality to get
-/// the local time of an entity as defined by XEP-0202: Entity Time.
+/// the local time of an entity as defined by \xep{0202}: Entity Time.
///
/// \ingroup Managers
diff --git a/src/client/QXmppMamManager.h b/src/client/QXmppMamManager.h
index f66db3b1..96ff022f 100644
--- a/src/client/QXmppMamManager.h
+++ b/src/client/QXmppMamManager.h
@@ -32,7 +32,7 @@
class QXmppMessage;
/// \brief The QXmppMamManager class makes it possible to access message
-/// archives as defined by XEP-0313: Message Archive Management.
+/// archives as defined by \xep{0313}: Message Archive Management.
///
/// To make use of this manager, you need to instantiate it and load it into
/// the QXmppClient instance as follows:
diff --git a/src/client/QXmppMessageReceiptManager.h b/src/client/QXmppMessageReceiptManager.h
index 42aa9099..80d591ca 100644
--- a/src/client/QXmppMessageReceiptManager.h
+++ b/src/client/QXmppMessageReceiptManager.h
@@ -29,7 +29,7 @@
/// \brief The QXmppMessageReceiptManager class makes it possible to
/// send and receive message delivery receipts as defined in
-/// XEP-0184: Message Delivery Receipts.
+/// \xep{0184}: Message Delivery Receipts.
///
/// \ingroup Managers
diff --git a/src/client/QXmppMucManager.h b/src/client/QXmppMucManager.h
index f1656b45..bfe354f7 100644
--- a/src/client/QXmppMucManager.h
+++ b/src/client/QXmppMucManager.h
@@ -36,7 +36,7 @@ class QXmppMucRoom;
class QXmppMucRoomPrivate;
/// \brief The QXmppMucManager class makes it possible to interact with
-/// multi-user chat rooms as defined by XEP-0045: Multi-User Chat.
+/// multi-user chat rooms as defined by \xep{0045}: Multi-User Chat.
///
/// To make use of this manager, you need to instantiate it and load it into
/// the QXmppClient instance as follows:
@@ -97,7 +97,7 @@ private:
};
/// \brief The QXmppMucRoom class represents a multi-user chat room
-/// as defined by XEP-0045: Multi-User Chat.
+/// as defined by \xep{0045}: Multi-User Chat.
///
/// \sa QXmppMucManager
diff --git a/src/client/QXmppRpcManager.h b/src/client/QXmppRpcManager.h
index 13ad0aac..0c2beedf 100644
--- a/src/client/QXmppRpcManager.h
+++ b/src/client/QXmppRpcManager.h
@@ -37,7 +37,7 @@ class QXmppRpcResponseIq;
/// \brief The QXmppRpcManager class make it possible to invoke remote methods
/// and to expose local interfaces for remote procedure calls, as specified by
-/// XEP-0009: Jabber-RPC.
+/// \xep{0009}: Jabber-RPC.
///
/// To make use of this manager, you need to instantiate it and load it into
/// the QXmppClient instance as follows:
diff --git a/src/client/QXmppTransferManager.h b/src/client/QXmppTransferManager.h
index 84f7278b..7b7c82d4 100644
--- a/src/client/QXmppTransferManager.h
+++ b/src/client/QXmppTransferManager.h
@@ -124,8 +124,8 @@ public:
/// This enum is used to describe a transfer method.
enum Method {
NoMethod = 0, ///< No transfer method.
- InBandMethod = 1, ///< XEP-0047: In-Band Bytestreams
- SocksMethod = 2, ///< XEP-0065: SOCKS5 Bytestreams
+ InBandMethod = 1, ///< \xep{0047}: In-Band Bytestreams
+ SocksMethod = 2, ///< \xep{0065}: SOCKS5 Bytestreams
AnyMethod = 3 ///< Any supported transfer method.
};
Q_ENUM(Method)
@@ -213,12 +213,13 @@ private:
friend class QXmppTransferOutgoingJob;
};
+///
/// \brief The QXmppTransferManager class provides support for sending and
/// receiving files.
///
-/// Stream initiation is performed as described in XEP-0095: Stream Initiation
-/// and XEP-0096: SI File Transfer. The actual file transfer is then performed
-/// using either XEP-0065: SOCKS5 Bytestreams or XEP-0047: In-Band Bytestreams.
+/// Stream initiation is performed as described in \xep{0095}: Stream Initiation
+/// and \xep{0096}: SI File Transfer. The actual file transfer is then performed
+/// using either \xep{0065}: SOCKS5 Bytestreams or \xep{0047}: In-Band Bytestreams.
///
/// To make use of this manager, you need to instantiate it and load it into
/// the QXmppClient instance as follows:
@@ -229,7 +230,7 @@ private:
/// \endcode
///
/// \ingroup Managers
-
+///
class QXMPP_EXPORT QXmppTransferManager : public QXmppClientExtension
{
Q_OBJECT
diff --git a/src/client/QXmppUploadRequestManager.h b/src/client/QXmppUploadRequestManager.h
index f04b4563..e11c7d02 100644
--- a/src/client/QXmppUploadRequestManager.h
+++ b/src/client/QXmppUploadRequestManager.h
@@ -58,7 +58,8 @@ private:
QSharedDataPointer<QXmppUploadServicePrivate> d;
};
-/// \brief The QXmppUploadRequestManager implements the core of XEP-0369: HTTP
+///
+/// \brief The QXmppUploadRequestManager implements the core of \xep{0369}: HTTP
/// File Upload.
///
/// It handles the discovery of QXmppUploadServices and can send upload
@@ -92,7 +93,7 @@ private:
/// \since QXmpp 1.1
///
/// \ingroup Managers
-
+///
class QXMPP_EXPORT QXmppUploadRequestManager : public QXmppClientExtension
{
Q_OBJECT
diff --git a/src/client/QXmppVCardManager.h b/src/client/QXmppVCardManager.h
index 265fb66d..5a2f62be 100644
--- a/src/client/QXmppVCardManager.h
+++ b/src/client/QXmppVCardManager.h
@@ -29,8 +29,9 @@
class QXmppVCardIq;
class QXmppVCardManagerPrivate;
+///
/// \brief The QXmppVCardManager class gets/sets XMPP vCards. It is an
-/// implementation of XEP-0054: vcard-temp.
+/// implementation of \xep{0054}: vcard-temp.
///
/// \note It's object should not be created using it's constructor. Instead
/// \c QXmppClient::findExtension<QXmppVCardManager>() should be used to get
@@ -51,7 +52,7 @@ class QXmppVCardManagerPrivate;
/// \note Client can't set/change vCards of roster entries.
///
/// \ingroup Managers
-
+///
class QXMPP_EXPORT QXmppVCardManager : public QXmppClientExtension
{
Q_OBJECT
diff --git a/src/client/QXmppVersionManager.h b/src/client/QXmppVersionManager.h
index 9bbf081d..26f559fc 100644
--- a/src/client/QXmppVersionManager.h
+++ b/src/client/QXmppVersionManager.h
@@ -29,15 +29,16 @@
class QXmppVersionIq;
class QXmppVersionManagerPrivate;
+///
/// \brief The QXmppVersionManager class makes it possible to request for
-/// the software version of an entity as defined by XEP-0092: Software Version.
+/// the software version of an entity as defined by \xep{0092}: Software Version.
///
/// \note It's object should not be created using it's constructor. Instead
/// \c QXmppClient::findExtension<QXmppVersionManager>() should be used to get
/// the instantiated object of this class.
///
/// \ingroup Managers
-
+///
class QXMPP_EXPORT QXmppVersionManager : public QXmppClientExtension
{
Q_OBJECT