From f5de04d9c47b4257e784ec8b5106c6a9ac4fc024 Mon Sep 17 00:00:00 2001 From: Nicholas Bennett Date: Wed, 26 Feb 2025 10:20:48 +0200 Subject: [PATCH] Docs: Create \Q4A macro for "Qt for Android" and replace instances "Android" is trademarked and needs to be referenced in a certain way. The following steps were taken: -Created qdoc macro. -Updated "Qt Android" and "Qt for Android" to use \Q4A in qdoc files. The macro will need to be adopted in all documentation projects. Task-number: QAA-2836 Pick-to: 6.8 6.5 Change-Id: I4b52247a4ed52047242a06404e6d3aa19de9c16c Reviewed-by: Assam Boudjelthia (cherry picked from commit 9c6c6d7d388bee01ea4e5ea102d3b0ed359c3f00) Reviewed-by: Qt Cherry-pick Bot --- doc/global/macros.qdocconf | 1 + doc/global/manifest-meta.qdocconf | 2 +- .../doc/src/androidnotifier-example.qdoc | 4 ++-- qmake/doc/src/qmake-manual.qdoc | 2 +- .../doc/src/android-manifest-file-configuration.qdoc | 4 ++-- .../doc/src/cmake/cmake-configure-variables.qdoc | 12 ++++++------ src/corelib/doc/src/cmake/cmake-properties.qdoc | 4 ++-- .../androiddeployqt/doc/src/androiddeployqt.qdoc | 4 ++-- 8 files changed, 17 insertions(+), 16 deletions(-) diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf index 5a73bd5bd4d..76de9d9a52e 100644 --- a/doc/global/macros.qdocconf +++ b/doc/global/macros.qdocconf @@ -81,6 +81,7 @@ macro.QQV = "Qt QML Viewer" macro.QtAA = "Qt for Android Automotive" macro.QUL = "Qt Quick Ultralite" macro.QtTAS = "Qt Tools for Android Studio" +macro.Q4A = "Qt for Android" # The following macros are used for various Android docs. The purpose is to keep # it as simple as updating these instead of updating multiple lines in scattered locations. diff --git a/doc/global/manifest-meta.qdocconf b/doc/global/manifest-meta.qdocconf index 863451681a8..b35bb59c789 100644 --- a/doc/global/manifest-meta.qdocconf +++ b/doc/global/manifest-meta.qdocconf @@ -35,7 +35,7 @@ manifestmeta.highlighted.attributes = isHighlighted:true manifestmeta.android.names = "Qt3D/Qt 3D: Basic Shapes C++ Example" \ "Qt3D/Qt 3D: Planets QML Example" \ "Qt3D/Qt 3D: Simple Custom Material QML Example" \ - "QtCore/Qt Android Notifier" \ + "QtCore/Qt for Android Notifier" \ "QtBluetooth/Bluetooth Low Energy Scanner Example" \ "QtBluetooth/Bluetooth Scanner Example" \ "QtBluetooth/QML Bluetooth Scanner Example" \ diff --git a/examples/corelib/platform/androidnotifier/doc/src/androidnotifier-example.qdoc b/examples/corelib/platform/androidnotifier/doc/src/androidnotifier-example.qdoc index 1315ad7762f..e1f76d2173f 100644 --- a/examples/corelib/platform/androidnotifier/doc/src/androidnotifier-example.qdoc +++ b/examples/corelib/platform/androidnotifier/doc/src/androidnotifier-example.qdoc @@ -2,7 +2,7 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! - \title Qt Android Notifier + \title \Q4A Notifier \example platform/androidnotifier \meta tag {widgets,android,notification} \brief Demonstrates calling Java code from Qt in an Android application. @@ -58,5 +58,5 @@ \snippet platform/androidnotifier/main.cpp Connect button signals - \sa {Qt for Android} + \sa {\Q4A} */ diff --git a/qmake/doc/src/qmake-manual.qdoc b/qmake/doc/src/qmake-manual.qdoc index a64169e8756..fc893891f7c 100644 --- a/qmake/doc/src/qmake-manual.qdoc +++ b/qmake/doc/src/qmake-manual.qdoc @@ -1066,7 +1066,7 @@ The path specified by this variable can contain custom Java classes under \c src directory. By default, the \l androiddeployqt tool copies the - application template from the Qt for Android installation path into your + application template from the \Q4A installation path into your project's build directory, then it copies the contents of the path specified by this variable on top of that, overwriting any existing files. For instance, you can make a custom \c {AndroidManifest.xml} for your application, diff --git a/src/android/templates/doc/src/android-manifest-file-configuration.qdoc b/src/android/templates/doc/src/android-manifest-file-configuration.qdoc index cfc3b1c2f6d..a278fb05549 100644 --- a/src/android/templates/doc/src/android-manifest-file-configuration.qdoc +++ b/src/android/templates/doc/src/android-manifest-file-configuration.qdoc @@ -3,7 +3,7 @@ /*! \page android-manifest-file-configuration.html -\title Qt Android Manifest File Configuration +\title \Q4A Manifest File Configuration \ingroup androidplatform \brief Provides details on the AndroidManifest.xml configuration. \previouspage android-openssl-support.html @@ -14,7 +14,7 @@ app configuration for different settings and features that the app uses, as well as details on the app itself, such as, package name, app name, version, etc. Permissions and hardware features can also be set from the manifest. -Qt for Android maintains a version of \c {AndroidManifest.xml} with default +\Q4A maintains a version of \c {AndroidManifest.xml} with default configuration that include features, permissions and other configuration used by the build system which are needed for building and running Qt apps on Android. diff --git a/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc b/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc index b2607e879b1..191f6043b2d 100644 --- a/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc +++ b/src/corelib/doc/src/cmake/cmake-configure-variables.qdoc @@ -194,13 +194,13 @@ finalization occurs automatically when using CMake 3.19 or later. \title QT_ANDROID_BUILD_ALL_ABIS \target cmake-variable-QT_ANDROID_BUILD_ALL_ABIS -\summary {Enables building multi-ABI packages using the autodetected Qt for Android SDK list.} +\summary {Enables building multi-ABI packages using the autodetected \Q4A SDK list.} \cmakevariablesince 6.3 \preliminarycmakevariable \cmakevariableandroidonly -Automatically detects available ABIs of Qt for Android and uses them to +Automatically detects available ABIs of \Q4A and uses them to build a package. The automatic detection expects the default directory structure supplied by the Qt installer, with the corresponding naming of the directories. \include cmake-android-supported-abis.qdocinc @@ -242,8 +242,8 @@ subprojects. Specifies a list of ABIs to be used to build the project packages. \include cmake-android-supported-abis.qdocinc -Each ABI should have the corresponding Qt for Android either installed or -user-built. To specify the path to the Qt for Android ABI, use +Each ABI should have the corresponding \Q4A either installed or +user-built. To specify the path to the \Q4A ABI, use the corresponding \c{QT_PATH_ANDROID_ABI_} variable. \note \c{QT_ANDROID_BUILD_ALL_ABIS} has the higher priority and ignores the @@ -259,13 +259,13 @@ QT_ANDROID_ABIS logic. \title QT_PATH_ANDROID_ABI_ \target cmake-variable-QT_PATH_ANDROID_ABI_ -\summary {Set of variables to specify the path to Qt for Android for the corresponding ABI.} +\summary {Set of variables to specify the path to \Q4A for the corresponding ABI.} \cmakevariablesince 6.3 \preliminarycmakevariable \cmakevariableandroidonly -Each variable can be used to specify the path to Qt for Android for the corresponding ABI. +Each variable can be used to specify the path to \Q4A for the corresponding ABI. \include cmake-android-supported-abis.qdocinc \sa{cmake-variable-QT_ANDROID_ABIS}{QT_ANDROID_ABIS} diff --git a/src/corelib/doc/src/cmake/cmake-properties.qdoc b/src/corelib/doc/src/cmake/cmake-properties.qdoc index 6df145f87f1..50cfc131cfe 100644 --- a/src/corelib/doc/src/cmake/cmake-properties.qdoc +++ b/src/corelib/doc/src/cmake/cmake-properties.qdoc @@ -190,7 +190,7 @@ template contains: The path specified by this variable can contain custom Java classes under \c src directory. By default, the \l androiddeployqt tool copies the -application template from the Qt for Android installation path into your +application template from the \Q4A installation path into your project's build directory, then it copies the contents of the path specified by this variable on top of that, overwriting any existing files. For instance, you can make a custom \c {AndroidManifest.xml} for your application, @@ -317,7 +317,7 @@ illegal characters or is appended to illegal words. long, strictfp, volatile, const, float, native, super, while. \endlist -The default package name for Qt for Android apps is \c org.qtproject.example.. +The default package name for \Q4A apps is \c org.qtproject.example.. \note Setting the package name manually in \c build.gradle (via \c namespace property) takes precedence over \c AndroidManifest.xml diff --git a/src/tools/androiddeployqt/doc/src/androiddeployqt.qdoc b/src/tools/androiddeployqt/doc/src/androiddeployqt.qdoc index c3a47d50a01..fec34b216f0 100644 --- a/src/tools/androiddeployqt/doc/src/androiddeployqt.qdoc +++ b/src/tools/androiddeployqt/doc/src/androiddeployqt.qdoc @@ -22,7 +22,7 @@ To prepare the environment for androiddeployqt, configure your project in a separate directory than your source directory. For more information on - configuring your project, see \l {Building Qt for Android Projects from Command Line}. + configuring your project, see \l {Building \Q4A Projects from Command Line}. \section1 Command Line Arguments @@ -90,6 +90,6 @@ and intuitive user interfaces to specify various options. For more information, see \l{\QC: Android Deploy Configuration}. - For more information about customizing and deploying a Qt for Android app, + For more information about customizing and deploying a \Q4A app, see \l {Deploying an Application on Android}. */