From a3bc8fc560c1b1d4b3173d142c5484fb0a85b11b Mon Sep 17 00:00:00 2001
From: Paul Wicking <paul.wicking@qt.io>
Date: Tue, 6 Feb 2024 14:05:05 +0100
Subject: [PATCH] Doc: QRhi corrections
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* There's no convenience header for the `QRhi` class, so add the
  `\inheaderfile` command to specify the correct include.
* The `QRhi` class belongs to the `QtGuiPrivate` module; use the
  correct name.
* QDoc needs to know about the QtGuiPrivate module. Add basic
  documentation for the private module.

Task-number: QTBUG-121855
Task-number: QTBUG-121991
Change-Id: I1ffd729a5f9c928f4cf91ce7127f40c7733fc42f
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
---
 src/gui/doc/src/qtgui.qdoc | 17 +++++++++++++++++
 src/gui/rhi/qrhi.cpp       |  3 ++-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/src/gui/doc/src/qtgui.qdoc b/src/gui/doc/src/qtgui.qdoc
index 4ea352323ac..2a1d69d4d3d 100644
--- a/src/gui/doc/src/qtgui.qdoc
+++ b/src/gui/doc/src/qtgui.qdoc
@@ -14,6 +14,23 @@
     The \l{Qt GUI} page contains information about how to use the module.
 */
 
+/*!
+    \module QtGuiPrivate
+    \title Qt GUI Private C++ Classes
+    \qtcmakepackage Gui
+    \qtvariable gui-private
+
+    \brief Provides access to private GUI functionality.
+
+    Use the following CMake commands in your \c {CMakeLists.txt} to access
+    private Qt GUI APIs:
+
+    \badcode
+    find_package(Qt6 REQUIRED COMPONENTS Gui)
+    target_link_libraries(mytarget PRIVATE Qt6::GuiPrivate)
+    \endcode
+*/
+
 /*!
     \page qtgui-index.html
     \title Qt GUI
diff --git a/src/gui/rhi/qrhi.cpp b/src/gui/rhi/qrhi.cpp
index e873e980ffe..5f94250bc16 100644
--- a/src/gui/rhi/qrhi.cpp
+++ b/src/gui/rhi/qrhi.cpp
@@ -29,7 +29,8 @@ Q_LOGGING_CATEGORY(QRHI_LOG_INFO, "qt.rhi.general")
 /*!
     \class QRhi
     \ingroup painting-3D
-    \inmodule QtGui
+    \inmodule QtGuiPrivate
+    \inheaderfile rhi/qrhi.h
     \since 6.6
 
     \brief Accelerated 2D/3D graphics API abstraction.