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.9 6.8 6.5
Change-Id: I4b52247a4ed52047242a06404e6d3aa19de9c16c
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
This commit is contained in:
Nicholas Bennett 2025-02-26 10:20:48 +02:00
parent cb382450aa
commit 9c6c6d7d38
8 changed files with 17 additions and 16 deletions

View File

@ -81,6 +81,7 @@ macro.QQV = "Qt QML Viewer"
macro.QtAA = "Qt for Android Automotive" macro.QtAA = "Qt for Android Automotive"
macro.QUL = "Qt Quick Ultralite" macro.QUL = "Qt Quick Ultralite"
macro.QtTAS = "Qt Tools for Android Studio" 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 # 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. # it as simple as updating these instead of updating multiple lines in scattered locations.

View File

@ -35,7 +35,7 @@ manifestmeta.highlighted.attributes = isHighlighted:true
manifestmeta.android.names = "Qt3D/Qt 3D: Basic Shapes C++ Example" \ manifestmeta.android.names = "Qt3D/Qt 3D: Basic Shapes C++ Example" \
"Qt3D/Qt 3D: Planets QML Example" \ "Qt3D/Qt 3D: Planets QML Example" \
"Qt3D/Qt 3D: Simple Custom Material 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 Low Energy Scanner Example" \
"QtBluetooth/Bluetooth Scanner Example" \ "QtBluetooth/Bluetooth Scanner Example" \
"QtBluetooth/QML Bluetooth Scanner Example" \ "QtBluetooth/QML Bluetooth Scanner Example" \

View File

@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*! /*!
\title Qt Android Notifier \title \Q4A Notifier
\example platform/androidnotifier \example platform/androidnotifier
\meta tag {widgets,android,notification} \meta tag {widgets,android,notification}
\brief Demonstrates calling Java code from Qt in an Android application. \brief Demonstrates calling Java code from Qt in an Android application.
@ -58,5 +58,5 @@
\snippet platform/androidnotifier/main.cpp Connect button signals \snippet platform/androidnotifier/main.cpp Connect button signals
\sa {Qt for Android} \sa {\Q4A}
*/ */

View File

@ -1066,7 +1066,7 @@
The path specified by this variable can contain custom Java classes under The path specified by this variable can contain custom Java classes under
\c src directory. By default, the \l androiddeployqt tool copies the \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 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 by this variable on top of that, overwriting any existing files. For
instance, you can make a custom \c {AndroidManifest.xml} for your application, instance, you can make a custom \c {AndroidManifest.xml} for your application,

View File

@ -3,7 +3,7 @@
/*! /*!
\page android-manifest-file-configuration.html \page android-manifest-file-configuration.html
\title Qt Android Manifest File Configuration \title \Q4A Manifest File Configuration
\ingroup androidplatform \ingroup androidplatform
\brief Provides details on the AndroidManifest.xml configuration. \brief Provides details on the AndroidManifest.xml configuration.
\previouspage android-openssl-support.html \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. 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. 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 configuration that include features, permissions and other configuration
used by the build system which are needed for building and running Qt apps used by the build system which are needed for building and running Qt apps
on Android. on Android.

View File

@ -194,13 +194,13 @@ finalization occurs automatically when using CMake 3.19 or later.
\title QT_ANDROID_BUILD_ALL_ABIS \title QT_ANDROID_BUILD_ALL_ABIS
\target cmake-variable-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 \cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
\cmakevariableandroidonly \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 build a package. The automatic detection expects the default directory structure
supplied by the Qt installer, with the corresponding naming of the directories. supplied by the Qt installer, with the corresponding naming of the directories.
\include cmake-android-supported-abis.qdocinc \include cmake-android-supported-abis.qdocinc
@ -242,8 +242,8 @@ subprojects.
Specifies a list of ABIs to be used to build the project packages. Specifies a list of ABIs to be used to build the project packages.
\include cmake-android-supported-abis.qdocinc \include cmake-android-supported-abis.qdocinc
Each ABI should have the corresponding Qt for Android either installed or Each ABI should have the corresponding \Q4A either installed or
user-built. To specify the path to the Qt for Android ABI, use user-built. To specify the path to the \Q4A ABI, use
the corresponding \c{QT_PATH_ANDROID_ABI_<ABI>} variable. the corresponding \c{QT_PATH_ANDROID_ABI_<ABI>} variable.
\note \c{QT_ANDROID_BUILD_ALL_ABIS} has the higher priority and ignores the \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_<ABI> \title QT_PATH_ANDROID_ABI_<ABI>
\target cmake-variable-QT_PATH_ANDROID_ABI_<ABI> \target cmake-variable-QT_PATH_ANDROID_ABI_<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 \cmakevariablesince 6.3
\preliminarycmakevariable \preliminarycmakevariable
\cmakevariableandroidonly \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 \include cmake-android-supported-abis.qdocinc
\sa{cmake-variable-QT_ANDROID_ABIS}{QT_ANDROID_ABIS} \sa{cmake-variable-QT_ANDROID_ABIS}{QT_ANDROID_ABIS}

View File

@ -190,7 +190,7 @@ template contains:
The path specified by this variable can contain custom Java classes under The path specified by this variable can contain custom Java classes under
\c src directory. By default, the \l androiddeployqt tool copies the \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 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 by this variable on top of that, overwriting any existing files. For
instance, you can make a custom \c {AndroidManifest.xml} for your application, 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. long, strictfp, volatile, const, float, native, super, while.
\endlist \endlist
The default package name for Qt for Android apps is \c org.qtproject.example.<target_name>. The default package name for \Q4A apps is \c org.qtproject.example.<target_name>.
\note Setting the package name manually in \c build.gradle (via \note Setting the package name manually in \c build.gradle (via
\c namespace property) takes precedence over \c AndroidManifest.xml \c namespace property) takes precedence over \c AndroidManifest.xml

View File

@ -22,7 +22,7 @@
To prepare the environment for androiddeployqt, configure your project in To prepare the environment for androiddeployqt, configure your project in
a separate directory than your source directory. For more information on 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 \section1 Command Line Arguments
@ -90,6 +90,6 @@
and intuitive user interfaces to specify various options. For more information, and intuitive user interfaces to specify various options. For more information,
see \l{\QC: Android Deploy Configuration}. 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}. see \l {Deploying an Application on Android}.
*/ */