From 8844c6ef379f466a12a5f4981c78bdb990d92db8 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 20 Dec 2022 11:45:25 +0000 Subject: [PATCH] Doc: Remove incorrect CMake instructions for QtCore-private MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Drop the use of \qtcmakepackage for the module page that results in incorrect instructions, and replace it with a snippet with the correct commands to use. Pick-to: 6.5 6.4 6.2 Fixes: QTBUG-109214 Change-Id: I936910ddb9e4118f931d85e4b096ad52006dcc32 Reviewed-by: Kai Köhne --- src/corelib/doc/src/qtcore.qdoc | 14 +++++++++++--- src/corelib/platform/android/qandroidextras.cpp | 14 ++++++++++++++ 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/src/corelib/doc/src/qtcore.qdoc b/src/corelib/doc/src/qtcore.qdoc index 2ef705dd75c..a46add13425 100644 --- a/src/corelib/doc/src/qtcore.qdoc +++ b/src/corelib/doc/src/qtcore.qdoc @@ -18,9 +18,17 @@ /*! \module QtCorePrivate \title Qt Core Private C++ Classes - \qtcmakepackage CorePrivate \qtvariable core-private - - \brief Provides private core functionality. \preliminary + \brief Provides private core functionality. + +//! [qtcoreprivate-usage] + When building with CMake, use the following commands to use + private Qt Core APIs: + + \badcode + find_package(Qt6 REQUIRED COMPONENTS Core) + target_link_libraries(mytarget PRIVATE Qt6::CorePrivate) + \endcode +//! [qtcoreprivate-usage] */ diff --git a/src/corelib/platform/android/qandroidextras.cpp b/src/corelib/platform/android/qandroidextras.cpp index 414374d1e03..7499a6ac812 100644 --- a/src/corelib/platform/android/qandroidextras.cpp +++ b/src/corelib/platform/android/qandroidextras.cpp @@ -126,6 +126,8 @@ 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 */ @@ -243,6 +245,8 @@ 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 */ @@ -383,6 +387,8 @@ QJniObject QAndroidBinder::handle() const It is useful when you perform a QtAndroidPrivate::bindService operation. + \include qtcore.qdoc qtcoreprivate-usage + \since 6.2 */ @@ -507,6 +513,8 @@ 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 */ /*! @@ -604,6 +612,8 @@ public: \l {https://developer.android.com/reference/android/app/Service.html}{Android Service} methods. + \include qtcore.qdoc qtcoreprivate-usage + \since 6.2 */ @@ -674,6 +684,8 @@ QAndroidBinder* QAndroidService::onBind(const QAndroidIntent &/*intent*/) \l {https://developer.android.com/reference/android/content/Intent.html}{Android Intent} methods. + \include qtcore.qdoc qtcoreprivate-usage + \since 6.2 */ @@ -799,6 +811,8 @@ 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 */ /*!