From 78f9131efe9bb79d25f0f2f5a2deb548bf7bc8ba Mon Sep 17 00:00:00 2001 From: Alexei Cazacov Date: Tue, 13 May 2025 15:32:36 +0300 Subject: [PATCH] Doc: QLatin1StringView documentation misses string literals namespace QLatin1StringView documentation assumes knowledge of string literals namespace. This commit adds a 'using' statement to the code samplles that use string literals. Fixes: QTBUG-135945 Pick-to: 6.8 Change-Id: I17971d343d9dad132394b91d93ac045c2c8d019f Reviewed-by: Mitch Curtis Reviewed-by: Fabian Kosmale (cherry picked from commit 72becc7c124f27ad1506ed4fc49d9abe1242629b) Reviewed-by: Qt Cherry-pick Bot --- .../snippets/code/src_corelib_io_qabstractfileengine.cpp | 4 ++-- .../snippets/code/src_corelib_mimetype_qmimedatabase.cpp | 2 ++ .../code/src_corelib_serialization_qcborstream.cpp | 4 ++++ .../doc/snippets/code/src_corelib_text_qstring.cpp | 8 ++++++-- src/corelib/doc/snippets/hellotrmain.cpp | 3 ++- src/corelib/doc/snippets/qstring/stringbuilder.cpp | 6 ++++-- 6 files changed, 20 insertions(+), 7 deletions(-) diff --git a/src/corelib/doc/snippets/code/src_corelib_io_qabstractfileengine.cpp b/src/corelib/doc/snippets/code/src_corelib_io_qabstractfileengine.cpp index 4300fc2da94..440eb506405 100644 --- a/src/corelib/doc/snippets/code/src_corelib_io_qabstractfileengine.cpp +++ b/src/corelib/doc/snippets/code/src_corelib_io_qabstractfileengine.cpp @@ -1,9 +1,9 @@ // Copyright (C) 2016 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause -using namespace Qt::StringLiterals; - //! [0] +using namespace Qt::StringLiterals; +// ... class ZipEngineHandler : public QAbstractFileEngineHandler { public: diff --git a/src/corelib/doc/snippets/code/src_corelib_mimetype_qmimedatabase.cpp b/src/corelib/doc/snippets/code/src_corelib_mimetype_qmimedatabase.cpp index 7ed52617e78..0b8d1e93340 100644 --- a/src/corelib/doc/snippets/code/src_corelib_mimetype_qmimedatabase.cpp +++ b/src/corelib/doc/snippets/code/src_corelib_mimetype_qmimedatabase.cpp @@ -12,6 +12,8 @@ if (mime.inherits("text/plain")) { //! [0] //! [1] +using namespace Qt::StringLiterals; +// ... QStandardPaths::locateAll(QStandardPaths::GenericDataLocation, "mime/packages"_L1, QStandardPaths::LocateDirectory); //! [1] diff --git a/src/corelib/doc/snippets/code/src_corelib_serialization_qcborstream.cpp b/src/corelib/doc/snippets/code/src_corelib_serialization_qcborstream.cpp index acb5a6272e8..e3483d9683e 100644 --- a/src/corelib/doc/snippets/code/src_corelib_serialization_qcborstream.cpp +++ b/src/corelib/doc/snippets/code/src_corelib_serialization_qcborstream.cpp @@ -8,6 +8,8 @@ using namespace Qt::StringLiterals; //! [0] //! [1] +using namespace Qt::StringLiterals; +// ... writer.startMap(4); // 4 elements in the map writer.append("label"_L1); @@ -73,6 +75,8 @@ using namespace Qt::StringLiterals; //! [7] //! [8] +using namespace Qt::StringLiterals; +// ... writer.append("Hello, World"_L1); //! [8] diff --git a/src/corelib/doc/snippets/code/src_corelib_text_qstring.cpp b/src/corelib/doc/snippets/code/src_corelib_text_qstring.cpp index efb529657ad..254985a1923 100644 --- a/src/corelib/doc/snippets/code/src_corelib_text_qstring.cpp +++ b/src/corelib/doc/snippets/code/src_corelib_text_qstring.cpp @@ -1,9 +1,10 @@ // Copyright (C) 2016 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause -using namespace Qt::StringLiterals; - //! [1] +// Required for using the '_L1' string literal. +using namespace Qt::StringLiterals; +// ... QString url = "https://www.unicode.org/"_L1; //! [1] @@ -35,6 +36,9 @@ str.append("Hello ").append("World"); //! [4bis] //! [5] +// Required for using the '_L1' string literal. +using namespace Qt::StringLiterals; +// ... if (str == "auto"_L1 || str == "extern"_L1 || str == "static"_L1 diff --git a/src/corelib/doc/snippets/hellotrmain.cpp b/src/corelib/doc/snippets/hellotrmain.cpp index d780f19117a..6f08a9761f2 100644 --- a/src/corelib/doc/snippets/hellotrmain.cpp +++ b/src/corelib/doc/snippets/hellotrmain.cpp @@ -1,9 +1,10 @@ // Copyright (C) 2016 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause +//! [0] +// Required for using the '_L1' string literal. using namespace Qt::StringLiterals; -//! [0] int main(int argc, char *argv[]) { QApplication app(argc, argv); diff --git a/src/corelib/doc/snippets/qstring/stringbuilder.cpp b/src/corelib/doc/snippets/qstring/stringbuilder.cpp index c3a709bd4cd..339253123ed 100644 --- a/src/corelib/doc/snippets/qstring/stringbuilder.cpp +++ b/src/corelib/doc/snippets/qstring/stringbuilder.cpp @@ -3,9 +3,11 @@ #include -using namespace Qt::StringLiterals; - //! [0] +// Required for using the '_L1' string literal. +using namespace Qt::StringLiterals; +// ... + QString foo; QString type = "long";