summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAlexandru Croitor <alexandru.croitor@qt.io>2019-05-28 16:41:49 +0200
committerAlexandru Croitor <alexandru.croitor@qt.io>2019-06-03 15:14:42 +0200
commite4079eca49adce16e31dac2a18d49d7a55817891 (patch)
tree1dfb960ec1115b1f552afe8a013058542389505e /doc
parentf32a6cfb6b6236533508901f114ab57396da8ff3 (diff)
parentec6dc5f78453048c4f0604655a34c6c20c79d819 (diff)
Merge remote-tracking branch 'origin/dev' into wip/cmake
Diffstat (limited to 'doc')
-rw-r--r--doc/global/externalsites/external-resources.qdoc19
-rw-r--r--doc/global/includes/module-use.qdocinc52
-rw-r--r--doc/global/qt-html-templates-offline.qdocconf2
-rw-r--r--doc/global/qt-html-templates-online.qdocconf3
4 files changed, 70 insertions, 6 deletions
diff --git a/doc/global/externalsites/external-resources.qdoc b/doc/global/externalsites/external-resources.qdoc
index 6019f5013f..1c3d37c199 100644
--- a/doc/global/externalsites/external-resources.qdoc
+++ b/doc/global/externalsites/external-resources.qdoc
@@ -62,28 +62,37 @@
*/
/*!
- \externalpage http://www.cmake.org/cmake/help/v2.8.11/cmake.html#command:find_package
+ \externalpage https://cmake.org/cmake/help/latest/command/find_package.html
\title CMake find_package Documentation
*/
/*!
- \externalpage http://www.cmake.org/cmake/help/v2.8.11/cmake.html#prop_tgt:AUTOMOC
+ \externalpage https://cmake.org/cmake/help/latest/manual/cmake-qt.7.html#automoc
\title CMake AUTOMOC Documentation
*/
+/*!
+ \externalpage https://cmake.org/cmake/help/latest/manual/cmake-qt.7.html#autorcc
+ \title CMake AUTORCC Documentation
+*/
+
+/*!
+ \externalpage https://cmake.org/cmake/help/latest/manual/cmake-qt.7.html#autouic
+ \title CMake AUTOUIC Documentation
+*/
/*!
- \externalpage http://www.cmake.org/cmake/help/v2.8.11/cmake.html#prop_tgt:LOCATION
+ \externalpage https://cmake.org/cmake/help/latest/prop_tgt/LOCATION.html
\title CMake LOCATION Documentation
*/
/*!
- \externalpage http://www.cmake.org/cmake/help/v2.8.11/cmake.html#prop_tgt:POSITION_INDEPENDENT_CODE
+ \externalpage https://cmake.org/cmake/help/latest/prop_tgt/POSITION_INDEPENDENT_CODE.html
\title CMake POSITION_INDEPENDENT_CODE Documentation
*/
/*!
- \externalpage http://www.cmake.org/cmake/help/v2.8.11/cmake.html#command:target_link_libraries
+ \externalpage https://cmake.org/cmake/help/latest/command/target_link_libraries.html
\title CMake target_link_libraries Documentation
*/
diff --git a/doc/global/includes/module-use.qdocinc b/doc/global/includes/module-use.qdocinc
new file mode 100644
index 0000000000..df33d1d16d
--- /dev/null
+++ b/doc/global/includes/module-use.qdocinc
@@ -0,0 +1,52 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+//! [using qt module]
+
+ \section1 Using the Module
+
+ Using a Qt module requires linking against the module library, either
+ directly or through other dependencies. Several build tools have dedicated
+ support for this, including \l{CMake Documentation}{CMake} and
+ \l{qmake}.
+
+ \section2 Building with CMake
+
+ Use the \c{find_package()} command to locate the needed module components in
+ the \c{Qt5} package:
+
+//! [using qt module]
+
+
+//! [building with qmake]
+
+ \section2 Building with qmake
+
+ To configure the module for building with qmake, add the module as a value
+ of the \c QT variable in the project's .pro file:
+
+//! [building with qmake]
diff --git a/doc/global/qt-html-templates-offline.qdocconf b/doc/global/qt-html-templates-offline.qdocconf
index f9baab9d19..39f49fd3da 100644
--- a/doc/global/qt-html-templates-offline.qdocconf
+++ b/doc/global/qt-html-templates-offline.qdocconf
@@ -18,6 +18,8 @@ HTML.extraimages += template/images/ico_out.png \
template/images/bullet_sq.png \
template/images/bgrContent.png
+sourcedirs += includes
+
#specify which files in the output directory should be packed into the qch file.
qhp.extraFiles += style/offline.css \
images/ico_out.png \
diff --git a/doc/global/qt-html-templates-online.qdocconf b/doc/global/qt-html-templates-online.qdocconf
index f1437a2d9c..468cbe1808 100644
--- a/doc/global/qt-html-templates-online.qdocconf
+++ b/doc/global/qt-html-templates-online.qdocconf
@@ -9,4 +9,5 @@ defines += onlinedocs
#uncomment if navigation bar is not wanted
#HTML.nonavigationbar = "true"
-sourcedirs += includes-online
+sourcedirs += includes-online \
+ includes