From 6a4e8ce18bb2659b5a85c1a1ccf4c1b8631ea45f Mon Sep 17 00:00:00 2001 From: Andreas Eliasson Date: Fri, 21 Apr 2023 09:29:17 +0200 Subject: Doc: Add CMake build sections Only qmake instructions exists as of today. Add CMake instructions and make use of the global include snippets. Fixes: QTBUG-113023 Pick-to: 6.5 Change-Id: I50d5f503b5f0c116bc9c1d48b6e09ad2de45a3bb Reviewed-by: Venugopal Shivashankar Reviewed-by: Safiyyah Moosa --- .../doc/src/qtwaylandcompositor-cpp.qdoc | 14 ++++++++++---- .../doc/src/qtwaylandcompositor-qmltypes.qdoc | 22 +++++++++++++++------- 2 files changed, 25 insertions(+), 11 deletions(-) diff --git a/src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc b/src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc index 1738a0f0..a61278d7 100644 --- a/src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc +++ b/src/compositor/doc/src/qtwaylandcompositor-cpp.qdoc @@ -10,11 +10,17 @@ \brief Provides C++ classes for writing custom Wayland display servers. - To link against the module, add this line to your \l qmake \c .pro file: + \section1 Using the Module - \code - QT += waylandcompositor - \endcode + \include {module-use.qdocinc} {using the c++ api} {WaylandCompositor} + + \section2 Building with CMake + + \include {module-use.qdocinc} {building with cmake} {WaylandCompositor} + + \section2 Building with qmake + + \include {module-use.qdocinc} {building_with_qmake} {waylandcompositor} For more information about using these classes in your application, see the \l{Qt Wayland Compositor} documentation. diff --git a/src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc b/src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc index 7d0a52d6..61f38e0a 100644 --- a/src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc +++ b/src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc @@ -13,15 +13,23 @@ The QML types can be imported into your application using the following import statement: - \qml - import QtWayland.Compositor - \endqml + \section1 Using the Module + + \include {module-use.qdocinc} {using the c++ api} {WaylandCompositor} + + \section2 Building with CMake + + \include {module-use.qdocinc} {building with cmake} {WaylandCompositor} - To link against the module, add this line to your \l qmake \c .pro file: + \section2 Building with qmake - \badcode - QT += waylandcompositor - \endcode + \include {module-use.qdocinc} {building_with_qmake} {waylandcompositor} + + \section2 QML import + + \qml + import QtWayland.Compositor + \endqml For more information about using these types in your application, see the \l{Qt Wayland Compositor} documentation. -- cgit v1.2.1