From 929b5a2273d410304d475585ebd49b378fd69949 Mon Sep 17 00:00:00 2001 From: Luca Di Sera Date: Fri, 10 Nov 2023 14:15:55 +0100 Subject: [PATCH] Doc: Fix template information for QAnyStringView members MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 `QAnyStringView` 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: I6c37a8bf90e3de8cc254e9b1ff3077fc9ebe6636 Reviewed-by: Topi Reiniö --- src/corelib/text/qanystringview.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/corelib/text/qanystringview.cpp b/src/corelib/text/qanystringview.cpp index 89ff248f8d6..7aff4c7e4d3 100644 --- a/src/corelib/text/qanystringview.cpp +++ b/src/corelib/text/qanystringview.cpp @@ -129,7 +129,7 @@ QT_BEGIN_NAMESPACE */ /*! - \fn template QAnyStringView::QAnyStringView(const Char *str, qsizetype len) + \fn template = true> QAnyStringView::QAnyStringView(const Char *str, qsizetype len) Constructs a string view on \a str with length \a len. @@ -146,7 +146,7 @@ QT_BEGIN_NAMESPACE */ /*! - \fn template QAnyStringView::QAnyStringView(const Char *first, const Char *last) + \fn template = true> QAnyStringView::QAnyStringView(const Char *first, const Char *last) Constructs a string view on \a first with length (\a last - \a first).