Doc: Specify target_link_libraries item for CorePrivate module

QDoc has a new command, `\qtcmaketargetitem`, that allows for overriding
the content generated for the `target_link_libraries` instructions on
class/namespace pages. The new command must be used on the documentation
for the module, in conjunction with the `\qtcmakepackage` command.

This patch makes use of the new command for a limited number of
Android-related classes that belong to the CorePrivate module. It also
removes the "usage snippet" and drops its inclusion from the few classes
that included said snippet, as that's no longer needed.

Task-number: QTBUG-109214
Task-number: QTBUG-121991
Change-Id: Ic715b6512a26b3b89e24f418295640f9bbda9417
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
(cherry picked from commit 4ed994487484b37ff960144806445f8f9ce42286)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Paul Wicking 2024-02-08 13:53:56 +01:00 committed by Qt Cherry-pick Bot
parent 1909435b03
commit 9c032ad5fe
2 changed files with 2 additions and 15 deletions

View File

@ -19,10 +19,11 @@
\module QtCorePrivate
\title Qt Core Private C++ Classes
\qtvariable core-private
\qtcmakepackage Core
\qtcmaketargetitem CorePrivate
\preliminary
\brief Provides private core functionality.
//! [qtcoreprivate-usage]
When building with CMake, use the following commands to use
private Qt Core APIs:
@ -30,5 +31,4 @@
find_package(Qt6 REQUIRED COMPONENTS Core)
target_link_libraries(mytarget PRIVATE Qt6::CorePrivate)
\endcode
//! [qtcoreprivate-usage]
*/

View File

@ -126,8 +126,6 @@ QAndroidBinder QAndroidParcelPrivate::readBinder() const
\l {https://developer.android.com/reference/android/os/Parcel.html}{Android Parcel}
methods.
\include qtcore.qdoc qtcoreprivate-usage
\since 6.2
*/
@ -245,8 +243,6 @@ QJniObject QAndroidParcel::handle() const
\l {https://developer.android.com/reference/android/os/Binder.html}{Android Binder}
methods.
\include qtcore.qdoc qtcoreprivate-usage
\since 6.2
*/
@ -387,8 +383,6 @@ QJniObject QAndroidBinder::handle() const
It is useful when you perform a QtAndroidPrivate::bindService operation.
\include qtcore.qdoc qtcoreprivate-usage
\since 6.2
*/
@ -514,7 +508,6 @@ public:
Create a subclass of this class to be notified of the results when using the
\c QtAndroidPrivate::startActivity() and \c QtAndroidPrivate::startIntentSender() APIs.
\include qtcore.qdoc qtcoreprivate-usage
*/
/*!
@ -612,8 +605,6 @@ public:
\l {https://developer.android.com/reference/android/app/Service.html}{Android Service}
methods.
\include qtcore.qdoc qtcoreprivate-usage
\since 6.2
*/
@ -723,8 +714,6 @@ bool QtAndroidPrivate::registerExtrasNatives(QJniEnvironment &env)
\l {https://developer.android.com/reference/android/content/Intent.html}{Android Intent}
methods.
\include qtcore.qdoc qtcoreprivate-usage
\since 6.2
*/
@ -850,8 +839,6 @@ QJniObject QAndroidIntent::handle() const
\brief The QtAndroidPrivate namespace provides miscellaneous functions
to aid Android development.
\inheaderfile QtCore/private/qandroidextras_p.h
\include qtcore.qdoc qtcoreprivate-usage
*/
/*!