summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKavindra Palaraja <kpalaraja@luxoft.com>2019-11-08 13:31:07 +0100
committerKavindra Palaraja <kpalaraja@luxoft.com>2020-02-04 08:10:43 +0100
commitc8caad549f55040adbf839e05f2cf91b29ee6880 (patch)
tree3d113456038eddd4d4c8b2faf7dc2ce2a9a2e199
parent8994a565c7c1d5319bcec7ce37f215bfc22da56d (diff)
downloadqtdoc-c8caad549f55040adbf839e05f2cf91b29ee6880.tar.gz
docs: Provide details on the environment variables supported
* Added an "s" to update a URL to use HTTPS * Also fixed a typo in the Qt for Android landing page Change-Id: Ic8e463124e445454cba083769981379a31352b06 Fixes: QTBUG-57405 Reviewed-by: Andy Shaw <andy.shaw@qt.io>
-rw-r--r--doc/src/platforms/android-platform-notes.qdoc41
-rw-r--r--doc/src/platforms/android.qdoc2
2 files changed, 40 insertions, 3 deletions
diff --git a/doc/src/platforms/android-platform-notes.qdoc b/doc/src/platforms/android-platform-notes.qdoc
index ee3e237b..d357acde 100644
--- a/doc/src/platforms/android-platform-notes.qdoc
+++ b/doc/src/platforms/android-platform-notes.qdoc
@@ -40,7 +40,7 @@
\section1 Android Development in Qt Creator
The easiest way to develop with Qt for Android is to use
- \l{http://doc.qt.io/qtcreator/creator-developing-android.html}{Qt Creator}. When you apply
+ \l{https://doc.qt.io/qtcreator/creator-developing-android.html}{Qt Creator}. When you apply
a \b{Qt for Android Kit} to a Qt Creator project, it will create and maintain a set of files which
are required to make your application run on Android.
@@ -117,7 +117,7 @@
\section1 Multimedia Special Considerations
The \l{Qt Multimedia Widgets} module is not supported on Android, which means
video display is only available using the VideoOutput and the \l [QML]{QtMultimedia::}{Video}
- QML Type.
+ QML Type.
\section1 Assets File System
@@ -158,4 +158,41 @@
keyboards such as Gboard. If you use a language like Japanese, with Gboard, only a QWERTY
keyboard is displayed. This environment variable is queried each time the keyboard is displayed,
so it's possible to toggle the workaround on and off, as necessary.
+
+ \section1 Supported Environment Variables
+
+ The following environment variables are available for building applications with Qt for Android.
+
+ \table
+ \header
+ \li Variable
+ \li Description
+ \row
+ \li ANDROID_NDK_ROOT
+ \li Specifies where the Android NDK is located.
+ \row
+ \li ANDROID_SDK_ROOT
+ \li Specifies where the Android SDK is located.
+ \row
+ \li ANDROID_NDK_PLATFORM
+ \li Specifies the NDK API version; the default is android-21.
+ \row
+ \li ANDROID_API_VERSION
+ \li Specifies the Java API version, which can differ from your NDK API version
+ (ANDROID_NDK_PLATFORM). The default is the highest API version found on your
+ system.
+ \row
+ \li ANDROID_NDK_HOST
+ \li Specifies the host for which the toolchain was built.
+ For example, \c{linux-x86_64} for Linux, \c{windows{} for Windows, and
+ \c{darwin-x86_64} for macOS.
+ \note This variable is detected automatically. Normally, you don't have to change
+ it.
+ \row
+ \li ANDROID_BUILD_TOOLS_REVISION
+ \li Specifies the version of the SDK build tools used as part of the deployment process.
+ For example, 28.0.3.
+ \note Currently in the \c{build.gradle} script file, a known working value is
+ hardcoded; so you don't have to change it.
+ \endtable
*/
diff --git a/doc/src/platforms/android.qdoc b/doc/src/platforms/android.qdoc
index 0f107017..a0580ea3 100644
--- a/doc/src/platforms/android.qdoc
+++ b/doc/src/platforms/android.qdoc
@@ -31,7 +31,7 @@
\brief Provides information about Android support in Qt.
\ingroup supportedplatform
-Qt for Android enables you to run Qt 5 applications Android devices.
+Qt for Android enables you to run Qt 5 applications on Android devices.
All Qt modules (essential and add-on) are supported except Qt \WebEngine,
Qt Serial Port, and the platform-specific ones (Qt Mac Extras,
Qt Windows Extras, and Qt X11 Extras).