aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicholas Bennett <nicholas.bennett@qt.io>2024-09-30 12:57:54 +0300
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2024-10-02 04:30:33 +0000
commit1b1ff89e43aeda3324051df01b0a97769c9b9fbf (patch)
tree2791e6d5712cc911446b18afcc65804bfeb24d92
parent404cc6f19c266a29d9d52a670312840630f475ee (diff)
Docs: Add links to Android classes and examples
Added links to the Qt Quick Android Classes page for examples. Added links to the Android Java classes provided by Qt Core. Renamed QML in Android Studio Projects example as Qt Quick for Android-related. Rename filename using qml in Android. Change-Id: I79f79971ea7d224545c939a906bb449bd2b886c5 Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io> (cherry picked from commit d37583094a73ca85151f07c4570db916424d7a94) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit ce24530b8c8144bbd9d6de5f700e8efed5851a83)
-rw-r--r--examples/platforms/android/doc/src/qtabstractitemmodel_in_android_studio_projects.qdoc2
-rw-r--r--examples/platforms/android/doc/src/qtquick_for_android_studio_projects.qdoc (renamed from examples/platforms/android/doc/src/qml_in_android_studio_projects.qdoc)4
-rw-r--r--src/qml/doc/src/cmake/cmake-properties.qdoc2
-rw-r--r--src/quick/doc/src/examples.qdoc8
-rw-r--r--src/quick/doc/src/qtquick-android.qdoc20
-rw-r--r--src/quick/platform/android/jar/src/org/qtproject/qt/android/QtQuickView.qdoc2
6 files changed, 27 insertions, 11 deletions
diff --git a/examples/platforms/android/doc/src/qtabstractitemmodel_in_android_studio_projects.qdoc b/examples/platforms/android/doc/src/qtabstractitemmodel_in_android_studio_projects.qdoc
index 019c43d8e1..9d75e82af3 100644
--- a/examples/platforms/android/doc/src/qtabstractitemmodel_in_android_studio_projects.qdoc
+++ b/examples/platforms/android/doc/src/qtabstractitemmodel_in_android_studio_projects.qdoc
@@ -3,7 +3,7 @@
/*!
\page qtabstractitemmodel-in-android-studio-projects-example.html
- \title QtAbstractItemModel Example in Android Studio Projects
+ \title Using QtAbstractItemModel in Android Studio Projects
\brief Shows how to handle complex data types and apply conditional
formatting to a table view format using QtAbstractItemModel class and
QtModelIndex class.
diff --git a/examples/platforms/android/doc/src/qml_in_android_studio_projects.qdoc b/examples/platforms/android/doc/src/qtquick_for_android_studio_projects.qdoc
index 6e56519cdf..2634207c12 100644
--- a/examples/platforms/android/doc/src/qml_in_android_studio_projects.qdoc
+++ b/examples/platforms/android/doc/src/qtquick_for_android_studio_projects.qdoc
@@ -3,9 +3,9 @@
/*!
\page qml-in-android-studio-projects-example.html
- \title QML in Android Studio Projects
+ \title Qt Quick for Android Studio Projects
\brief Uses a \l {Qt Quick View Android Class}{QtQuickView}
- to embed a QML component into Android projects.
+ to embed Qt Quick content in Android projects.
\ingroup qtquickexamples
\section1 Overview
diff --git a/src/qml/doc/src/cmake/cmake-properties.qdoc b/src/qml/doc/src/cmake/cmake-properties.qdoc
index a1d6c5aea9..36499ca155 100644
--- a/src/qml/doc/src/cmake/cmake-properties.qdoc
+++ b/src/qml/doc/src/cmake/cmake-properties.qdoc
@@ -223,7 +223,7 @@ To mark a \c {.qml} file for code generation, set its \c QT_QML_GENERATE_ANDROID
source property to \c TRUE. The source property must be set before
\l {qt_add_qml_module}{creating} the module. \note The \c {.qml} file name must start with
an uppercase letter and define a QML component. This property is valid only if
-\l QT_ANDROID_GENERATE_JAVA_QML_COMPONENTS is defined.
+\l QT_ANDROID_GENERATE_JAVA_QTQUICKVIEW_CONTENTS is defined.
\sa {Naming Custom QML Object Types}
*/
diff --git a/src/quick/doc/src/examples.qdoc b/src/quick/doc/src/examples.qdoc
index 291a9eed4e..5773343361 100644
--- a/src/quick/doc/src/examples.qdoc
+++ b/src/quick/doc/src/examples.qdoc
@@ -186,5 +186,13 @@ Creator.
\li \l{Qt Quick Examples - Embedded in Widgets}{Embedding a QQuickView as Native Window}
\endlist
\enddiv
+ \div {class="doc-column"}
+ \b{Qt Quick for Android}
+ \list
+ \li \l{Qt Quick for Android Studio Projects}
+ \li \l{Exposing QtAbstractListModel to QML}
+ \li \l{Using QtAbstractItemModel in Android Studio Projects}
+ \endlist
+ \enddiv
\enddiv
*/
diff --git a/src/quick/doc/src/qtquick-android.qdoc b/src/quick/doc/src/qtquick-android.qdoc
index b21378565d..8cc45cbfbc 100644
--- a/src/quick/doc/src/qtquick-android.qdoc
+++ b/src/quick/doc/src/qtquick-android.qdoc
@@ -2,13 +2,21 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
-\page qtquick-android-classes.html
-\title Qt Quick Android Classes
-\summary The Qt Quick module provides classes for embedding Qt Quick in Android Applications.
+ \page qtquick-android-classes.html
+ \title Qt Quick Android Classes
+ \summary The Qt Quick module provides classes for embedding Qt Quick in Android Applications.
- \note Classes under this module requires \l{Qt for Android}.
+ \note Classes under this module requires \l{Qt for Android}.
- \annotatedlist qt_android_classes
+ \annotatedlist qt_android_classes
- For more information on Qt Quick module, see the \l{Qt Quick} module documentation.
+ \note For a complete list of Android Java classes, see \l{Android Classes}.
+
+ Examples:
+ \list
+ \li \l{Qt Quick for Android Studio Projects}
+ \li \l{Exposing QtAbstractListModel to QML}
+ \li \l{Using QtAbstractItemModel in Android Studio Projects}
+ \endlist
+ For more information on the Qt Quick module, see the \l{Qt Quick} module documentation.
*/
diff --git a/src/quick/platform/android/jar/src/org/qtproject/qt/android/QtQuickView.qdoc b/src/quick/platform/android/jar/src/org/qtproject/qt/android/QtQuickView.qdoc
index f22aefc876..c11a82275e 100644
--- a/src/quick/platform/android/jar/src/org/qtproject/qt/android/QtQuickView.qdoc
+++ b/src/quick/platform/android/jar/src/org/qtproject/qt/android/QtQuickView.qdoc
@@ -76,7 +76,7 @@
}
\endcode
- For a more detailed example, see \l {QML in Android Studio Projects}.
+ For a more detailed example, see \l {Qt Quick for Android Studio Projects}.
\section1 Known issues