From 2ec235a2235a119887683e55787b93f99dc5f12f Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Thu, 6 Mar 2025 13:15:17 +0000 Subject: Doc: Fix issues with \fn signatures MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Move QQmlSA::LoggerWarningId function documentation out of the QQmlJS namespace, as that causes match failures with QDoc. Qualify QQmlSA::Method and Element \fn signatures with the correct scope to help QDoc match them. Task-number: QTBUG-134250 Change-Id: I89407afe251158d99a93f44c25bb6db1a83a6024 Reviewed-by: Paul Wicking Reviewed-by: Olivier De Cannière (cherry picked from commit f1862814b0c6f7bdd304119270fc7554411ff598) Reviewed-by: Qt Cherry-pick Bot (cherry picked from commit 6cf992796781ad3060196e6229b547019a97ab4e) (cherry picked from commit 83eda05c84a7ee878afbbb610028ae0d1a04a57f) Reviewed-by: Topi Reiniö --- src/qmlcompiler/qqmljsloggingutils.cpp | 36 +++++++++++++++++----------------- src/qmlcompiler/qqmlsa.cpp | 6 +++--- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/src/qmlcompiler/qqmljsloggingutils.cpp b/src/qmlcompiler/qqmljsloggingutils.cpp index 1b08df8720..6479a6c8fc 100644 --- a/src/qmlcompiler/qqmljsloggingutils.cpp +++ b/src/qmlcompiler/qqmljsloggingutils.cpp @@ -10,6 +10,24 @@ QT_BEGIN_NAMESPACE using namespace Qt::StringLiterals; +/*! + \class QQmlSA::LoggerWarningId + \inmodule QtQmlCompiler + + \brief A wrapper around a string literal to uniquely identify + warning categories in the \c{QQmlSA} framework. +*/ + +/*! + \fn QQmlSA::LoggerWarningId::LoggerWarningId(QAnyStringView name) + Constructs a LoggerWarningId object with logging catergory name \a name. +*/ + +/*! + \fn QAnyStringView QQmlSA::LoggerWarningId::name() const + Returns the name of the wrapped warning category. +*/ + namespace QQmlJS { LoggerCategory::LoggerCategory() : d_ptr{ new LoggerCategoryPrivate } { } @@ -127,24 +145,6 @@ LoggerCategoryPrivate *LoggerCategoryPrivate::get(LoggerCategory *loggerCategory return loggerCategory->d_func(); } -/*! - \class QQmlSA::LoggerWarningId - \inmodule QtQmlCompiler - - \brief A wrapper around a string literal to uniquely identify - warning categories in the \c{QQmlSA} framework. -*/ - -/*! - \fn constexpr LoggerWarningId::LoggerWarningId(QAnyStringView name) - Constructs a LoggerWarningId object with logging catergory name \a name. - */ - -/*! - \fn QAnyStringView LoggerWarningId::name() const - Returns the name of the wrapped warning category. - */ - namespace LoggingUtils { QString levelToString(const QQmlJS::LoggerCategory &category) diff --git a/src/qmlcompiler/qqmlsa.cpp b/src/qmlcompiler/qqmlsa.cpp index 0be0de264c..cbe0370032 100644 --- a/src/qmlcompiler/qqmlsa.cpp +++ b/src/qmlcompiler/qqmlsa.cpp @@ -452,7 +452,7 @@ QMultiHash::const_iterator Method::Methods::constBegin() const } /*! - \fn QMultiHash::const_iterator Methods::begin() const + \fn QMultiHash::const_iterator QQmlSA::Method::Methods::begin() const Returns an iterator to the beginning of the methods. */ @@ -471,7 +471,7 @@ QMultiHash::const_iterator Method::Methods::constEnd() const } /*! - \fn QMultiHash::const_iterator Methods::end() const + \fn QMultiHash::const_iterator QQmlSA::Method::Methods::end() const Returns an iterator to the end of the methods. */ @@ -839,7 +839,7 @@ Element &Element::operator=(const Element &other) } /*! - \fn Element &Element::operator=(Element &&) noexpect; + \fn QQmlSA::Element &QQmlSA::Element::operator=(QQmlSA::Element &&other) Move-assigns \a other to this Element instance. */ -- cgit v1.2.3