diff options
| author | Luca Di Sera <luca.disera@qt.io> | 2023-11-10 15:30:17 +0100 |
|---|---|---|
| committer | Luca Di Sera <luca.disera@qt.io> | 2023-11-20 09:45:55 +0100 |
| commit | 70275f1ea7085584741e49ee9bb971ea8fcca5d0 (patch) | |
| tree | fe2e31b93da07916f84ba0ffbbdba7bad5d72250 | |
| parent | 596e96a7c2a581c353ca817efe80b2e8d983ab39 (diff) | |
Doc: Fix template information for QRemoteObjectNode members
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 some of the members of `QRemoteObjectNode` is 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: Ie7420f65980b6a83db107812361b88eebb4212a1
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
| -rw-r--r-- | src/remoteobjects/qremoteobjectnode.cpp | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/remoteobjects/qremoteobjectnode.cpp b/src/remoteobjects/qremoteobjectnode.cpp index cef1e84..c1b5e0f 100644 --- a/src/remoteobjects/qremoteobjectnode.cpp +++ b/src/remoteobjects/qremoteobjectnode.cpp @@ -1700,7 +1700,7 @@ void QRemoteObjectNodePrivate::onClientRead(QObject *obj) */ /*! - \fn ObjectType *QRemoteObjectNode::acquire(const QString &name) + \fn template <class ObjectType> ObjectType *QRemoteObjectNode::acquire(const QString &name) Returns a pointer to a Replica of type ObjectType (which is a template parameter and must inherit from \l QRemoteObjectReplica). That is, the @@ -2351,7 +2351,7 @@ void QRemoteObjectNode::addClientSideConnection(QIODevice *ioDevice) */ /*! - \fn QStringList QRemoteObjectNode::instances() const + \fn template<typename T> QStringList QRemoteObjectNode::instances() const This templated function (taking a \l repc generated type as the template parameter) will return the list of names of every instance of that type on the Remote |