summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2020-01-27 13:43:04 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2020-02-03 15:20:11 +0100
commitc435f8efa2e30016c58f150a1ebe1ca560bfd2dc (patch)
tree57c9a898813b94d1dd0e70f921669b213bede477
parentccbd6fbdbe071f42e1c060ca579786758701f358 (diff)
Doc: Add information about building the module with CMake
Task-number: QTBUG-81560 Change-Id: I9d75606634da4c604f34913908f97a91797d1813 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Leander Beernaert <leander.beernaert@qt.io> Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
-rw-r--r--src/pdf/doc/qtpdf.qdocconf3
-rw-r--r--src/pdf/doc/snippets/qtpdf-build.cmake2
-rw-r--r--src/pdf/doc/src/qtpdf-index.qdoc7
3 files changed, 10 insertions, 2 deletions
diff --git a/src/pdf/doc/qtpdf.qdocconf b/src/pdf/doc/qtpdf.qdocconf
index 7f7a0e80b..7a77105c9 100644
--- a/src/pdf/doc/qtpdf.qdocconf
+++ b/src/pdf/doc/qtpdf.qdocconf
@@ -39,7 +39,8 @@ depends += qtcore \
qtdoc \
qmake \
qtdesigner \
- qtquick
+ qtquick \
+ qtcmake
headerdirs += ../api \
../quick
diff --git a/src/pdf/doc/snippets/qtpdf-build.cmake b/src/pdf/doc/snippets/qtpdf-build.cmake
new file mode 100644
index 000000000..d46b9c3ee
--- /dev/null
+++ b/src/pdf/doc/snippets/qtpdf-build.cmake
@@ -0,0 +1,2 @@
+find_package(Qt5 COMPONENTS Pdf REQUIRED)
+target_link_libraries(mytarget Qt5::Pdf)
diff --git a/src/pdf/doc/src/qtpdf-index.qdoc b/src/pdf/doc/src/qtpdf-index.qdoc
index d50d1482c..b32787eb5 100644
--- a/src/pdf/doc/src/qtpdf-index.qdoc
+++ b/src/pdf/doc/src/qtpdf-index.qdoc
@@ -39,7 +39,12 @@
\l QPdfPageNavigation class handles the navigation through a
PDF document.
- \section1 Getting Started
+ \include module-use.qdocinc using qt module
+ \quotefile qtpdf-build.cmake
+
+ See also the \l{Build with CMake} overview.
+
+ \section2 Building with qmake
To include the definitions of the module's classes, use the
following directive: