summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLuca Di Sera <luca.disera@qt.io>2023-11-10 15:30:48 +0100
committerLuca Di Sera <luca.disera@qt.io>2023-11-20 09:46:01 +0100
commit6c62951a88eac9e6ded2cf3adb7dd5bb842d38e2 (patch)
treed44966751493bb93835c1afa7e6eb4106c34114a
parent70275f1ea7085584741e49ee9bb971ea8fcca5d0 (diff)
Doc: Fix template information for qRegisterRemoteObjectsServer/Client
When QDoc parses a project, it parses the source code to extract the user-provided documentation and perform sanity checkings based on the code itself on it. When QDoc parses an "\fn" command as part of this process, it tries to understand, based on its intermediate representation built on the information extracted from the code-base, which "documentable element" the "\fn" refers to. When QDoc performs this "matching" process, it takes into consideration only a certain amount of information. For example, no checking is performed over the template declaration of a callable. Due to some upcoming documentation, where two callables are indistinguishable to the current process, as they differ only in their template declaration, QDoc will start to take into consideration the template declaration of a callable when matching. This implies that an "\fn" command should now provide information parity, with regards to template declaration for callables, with the code-base so that QDoc can perform the match correctly. The documentation for `qRegisterRemoteObjectsServer` / `qRegisterRemoteObjectssClient` are not in sync with the intended target template declaration. Hence, add the missing information to the relevant "\fn" commands. Task-number: QTBUG-118080 Change-Id: Ia70ad3a0ded11818b298b31d8fab64b62efdd0ce Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r--src/remoteobjects/qconnectionfactories.cpp4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/remoteobjects/qconnectionfactories.cpp b/src/remoteobjects/qconnectionfactories.cpp
index 38ab07f..fa127f7 100644
--- a/src/remoteobjects/qconnectionfactories.cpp
+++ b/src/remoteobjects/qconnectionfactories.cpp
@@ -298,7 +298,7 @@ QtROClientFactory *QtROClientFactory::instance()
}
/*!
- \fn void qRegisterRemoteObjectsClient(const QString &id)
+ \fn template <typename T> void qRegisterRemoteObjectsClient(const QString &id)
\relates QtROClientFactory
Registers the Remote Objects client \a id for the type \c{T}.
@@ -325,7 +325,7 @@ QtROClientFactory *QtROClientFactory::instance()
*/
/*!
- \fn void qRegisterRemoteObjectsServer(const QString &id)
+ \fn template <typename T> void qRegisterRemoteObjectsServer(const QString &id)
\relates QtROServerFactory
Registers the Remote Objects server \a id for the type \c{T}.