diff options
author | Luca Di Sera <luca.disera@qt.io> | 2023-11-03 15:20:54 +0100 |
---|---|---|
committer | Luca Di Sera <luca.disera@qt.io> | 2023-11-13 16:35:54 +0100 |
commit | 3ab35eeefa44998f58557d12a090b3ec0928a7b0 (patch) | |
tree | 560c34084c69348f4792d15d78864be9a4fb3062 | |
parent | b71aa3c661797a916effd29171665ea838816595 (diff) |
Doc: Fix template information for QRandomGenerator::fillRange
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 `QAbstractGrpcClient::fillRange` overload set 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: I0b9c197019c0ba03d488d7b7c3351de75a0023f3
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
-rw-r--r-- | src/corelib/global/qrandom.cpp | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/corelib/global/qrandom.cpp b/src/corelib/global/qrandom.cpp index c1c2792736..9eef41b1dc 100644 --- a/src/corelib/global/qrandom.cpp +++ b/src/corelib/global/qrandom.cpp @@ -765,7 +765,7 @@ inline QRandomGenerator::SystemGenerator &QRandomGenerator::SystemGenerator::sel */ /*! - \fn template <typename UInt> void QRandomGenerator::fillRange(UInt *buffer, qsizetype count) + \fn template <typename UInt, IfValidUInt<UInt> = true> void QRandomGenerator::fillRange(UInt *buffer, qsizetype count) Generates \a count 32- or 64-bit quantities (depending on the type \c UInt) and stores them in the buffer pointed by \a buffer. This is the most @@ -781,7 +781,7 @@ inline QRandomGenerator::SystemGenerator &QRandomGenerator::SystemGenerator::sel */ /*! - \fn template <typename UInt, size_t N> void QRandomGenerator::fillRange(UInt (&buffer)[N]) + \fn template <typename UInt, size_t N, IfValidUInt<UInt> = true> void QRandomGenerator::fillRange(UInt (&buffer)[N]) Generates \c N 32- or 64-bit quantities (depending on the type \c UInt) and stores them in the \a buffer array. This is the most efficient way to |