diff options
| author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2021-09-07 12:00:42 +0200 |
|---|---|---|
| committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2021-09-13 10:38:07 +0200 |
| commit | 8fe8c384b8de737131db67b14fcaaaa598a5e11a (patch) | |
| tree | 36144e93c8ce41a3dc9e5d08d6787f8c235cd690 /src | |
| parent | 7aaf5b5793a74b76d052212423c70b0c61e23b23 (diff) | |
Doc: Add a section for using the module with CMake
All the Qt module pages for C++ offer info. about using
the module with CMake and qmake.
Pick-to: 6.2
Change-Id: I0f9dcd76ef5e6da16102797af6b0eea058d62f3b
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'src')
| -rw-r--r-- | src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf | 2 | ||||
| -rw-r--r-- | src/virtualkeyboard/doc/snippets/cmake.txt | 4 | ||||
| -rw-r--r-- | src/virtualkeyboard/doc/src/qtvirtualkeyboard-module-cpp.qdoc | 10 |
3 files changed, 14 insertions, 2 deletions
diff --git a/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf b/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf index 35c4aa63..0822d594 100644 --- a/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf +++ b/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf @@ -25,7 +25,7 @@ manifestmeta.highlighted.names = "QtVirtualKeyboard/Qt Quick Virtual Keyboard - imagedirs += images -depends += qtdoc qtcore qtgui qtwidgets qtwaylandcompositor qtqml qtquick qtquickcontrols +depends += qtdoc qtcore qtgui qtwidgets qtwaylandcompositor qtqml qtquick qtquickcontrols qtcmake qmake qhp.projects = QtVirtualKeyboard diff --git a/src/virtualkeyboard/doc/snippets/cmake.txt b/src/virtualkeyboard/doc/snippets/cmake.txt new file mode 100644 index 00000000..8a9b722f --- /dev/null +++ b/src/virtualkeyboard/doc/snippets/cmake.txt @@ -0,0 +1,4 @@ +//! [find-and-link] +find_package(Qt6 COMPONENTS VirtualKeyboard REQUIRED) +target_link_libraries(mytarget PRIVATE Qt6::VirtualKeyboard) +//! [find-and-link] diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-module-cpp.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-module-cpp.qdoc index ed069630..89fc6d83 100644 --- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-module-cpp.qdoc +++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-module-cpp.qdoc @@ -40,7 +40,15 @@ #include <QtVirtualKeyboard> \endcode - To link against the module, add this line to your qmake .pro file: + \include module-use.qdocinc using qt module + \snippet cmake.txt find-and-link + + See \l{Getting started with CMake} for more information. + + \section2 Building with qmake + + To link against this module, add the following line to your qmake \c .pro + file: \badcode QT += virtualkeyboard |