diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2024-02-06 14:05:05 +0100 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2024-02-09 12:39:28 +0100 |
| commit | a3bc8fc560c1b1d4b3173d142c5484fb0a85b11b (patch) | |
| tree | aface4c4f10b9f937b7c26155bb2f9d408986ee7 /src/gui/doc/src | |
| parent | b28bad0b20719f72fb335a65f76382132e326ad0 (diff) | |
Doc: QRhi corrections
* 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>
Diffstat (limited to 'src/gui/doc/src')
| -rw-r--r-- | src/gui/doc/src/qtgui.qdoc | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/src/gui/doc/src/qtgui.qdoc b/src/gui/doc/src/qtgui.qdoc index 4ea352323a..2a1d69d4d3 100644 --- a/src/gui/doc/src/qtgui.qdoc +++ b/src/gui/doc/src/qtgui.qdoc @@ -15,6 +15,23 @@ */ /*! + \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 |