summaryrefslogtreecommitdiffstats
path: root/src/corelib
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2022-06-02 18:06:34 +0200
committerNicholas Bennett <nicholas.bennett@qt.io>2022-06-13 13:04:01 +0000
commitbdfb65dc33055da4c246b48ee3d752802b4a92e3 (patch)
tree1468fde3010c1b1d6638803c653778b1d4377544 /src/corelib
parent2d4dbcf01ba4ba9688c44a34ccca30180b38c27e (diff)
Doc: Document the CorePrivate module
Classes to aid Android development are currently available in the CorePrivate module. In order to have correct information for the requisites table (for CMake and qmake inclusion), document the private module, mark it \preliminary, and link the classes to it using the \inmodule command. Fixes: QTBUG-103865 Change-Id: Id913148751ab925eb4e8488aa28a54b0e0c2d78d Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> (cherry picked from commit e4f9a78c18039a013326307f4884eeb7e83bd976)
Diffstat (limited to 'src/corelib')
-rw-r--r--src/corelib/doc/src/qtcore.qdoc10
-rw-r--r--src/corelib/platform/android/qandroidextras.cpp12
2 files changed, 16 insertions, 6 deletions
diff --git a/src/corelib/doc/src/qtcore.qdoc b/src/corelib/doc/src/qtcore.qdoc
index 4dd56e4227..2ef705dd75 100644
--- a/src/corelib/doc/src/qtcore.qdoc
+++ b/src/corelib/doc/src/qtcore.qdoc
@@ -14,3 +14,13 @@
The \l{Qt Core} page contains information about how to use the module.
*/
+
+/*!
+ \module QtCorePrivate
+ \title Qt Core Private C++ Classes
+ \qtcmakepackage CorePrivate
+ \qtvariable core-private
+
+ \brief Provides private core functionality.
+ \preliminary
+*/
diff --git a/src/corelib/platform/android/qandroidextras.cpp b/src/corelib/platform/android/qandroidextras.cpp
index 859cc5d255..0fa67eacaf 100644
--- a/src/corelib/platform/android/qandroidextras.cpp
+++ b/src/corelib/platform/android/qandroidextras.cpp
@@ -118,7 +118,7 @@ QAndroidBinder QAndroidParcelPrivate::readBinder() const
/*!
\class QAndroidParcel
\preliminary
- \inmodule QtCore
+ \inmodule QtCorePrivate
\brief Wraps the most important methods of Android Parcel class.
The QAndroidParcel is a convenience class that wraps the most important
@@ -234,7 +234,7 @@ QJniObject QAndroidParcel::handle() const
/*!
\class QAndroidBinder
\preliminary
- \inmodule QtCore
+ \inmodule QtCorePrivate
\brief Wraps the most important methods of Android Binder class.
The QAndroidBinder is a convenience class that wraps the most important
@@ -371,7 +371,7 @@ QJniObject QAndroidBinder::handle() const
/*!
\class QAndroidServiceConnection
\preliminary
- \inmodule QtCore
+ \inmodule QtCorePrivate
\brief Wraps the most important methods of Android ServiceConnection class.
The QAndroidServiceConnection is a convenience abstract class which wraps the
@@ -497,7 +497,7 @@ public:
/*!
\class QAndroidActivityResultReceiver
\preliminary
- \inmodule QtCore
+ \inmodule QtCorePrivate
\since 6.2
\brief Interface used for callbacks from onActivityResult() in the main Android activity.
@@ -592,7 +592,7 @@ public:
/*!
\class QAndroidService
\preliminary
- \inmodule QtCore
+ \inmodule QtCorePrivate
\brief Wraps the most important methods of Android Service class.
The QAndroidService is a convenience class that wraps the most important
@@ -661,7 +661,7 @@ QAndroidBinder* QAndroidService::onBind(const QAndroidIntent &/*intent*/)
/*!
\class QAndroidIntent
\preliminary
- \inmodule QtCore
+ \inmodule QtCorePrivate
\brief Wraps the most important methods of Android Intent class.
The QAndroidIntent is a convenience class that wraps the most important