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
Pick-to: 6.3
Change-Id: Id913148751ab925eb4e8488aa28a54b0e0c2d78d
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
This commit is contained in:
Topi Reinio 2022-06-02 18:06:34 +02:00 committed by Nicholas Bennett
parent 720de98824
commit e4f9a78c18
2 changed files with 16 additions and 6 deletions

View File

@ -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
*/

View File

@ -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