From f2b5baf9d0b723b721d9cb7c60a3c04afe904d4f Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Fri, 12 Apr 2019 16:48:21 +0200 Subject: Update external links to CMake documentation We don't support CMake version 2 anymore. Instead of just updating to a newer (but fixed) version let's link to the latest documentation. This might create a bigger risk that links get stale, but hopefully let people find always the latest information. Task-number: QTBUG-72159 Change-Id: I082de80cf9ee107b5d017ab8ad6369f2448b0e1b Reviewed-by: Leena Miettinen --- doc/global/externalsites/external-resources.qdoc | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/global/externalsites/external-resources.qdoc b/doc/global/externalsites/external-resources.qdoc index 6019f5013f..01c6939dca 100644 --- a/doc/global/externalsites/external-resources.qdoc +++ b/doc/global/externalsites/external-resources.qdoc @@ -62,28 +62,27 @@ */ /*! - \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 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 */ -- cgit v1.2.3 From c57520e491f420dc83d44ce5382c403192ce4836 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Mon, 1 Apr 2019 15:49:47 +0200 Subject: Document how to use CMake on Qt Core, Qt GUI's central pages Add documentation on how to use a module from CMake, alongside the existing documentation about qmake. Separate generic info from module-specific examples, to make it possible to use one include file in all modules. While at it, also remove the mentioning of the central include; it is not something we should actively advocate anymore. Instead, the documentation of every class gives the correct include to use. Task-number: QTBUG-73058 Change-Id: I6b3c0e5ea218dd9c06a491c8fb799a7fcf42dd92 Reviewed-by: Leena Miettinen --- doc/global/includes/module-use.qdocinc | 52 +++++++++++++++++++++++++++ doc/global/qt-html-templates-offline.qdocconf | 2 ++ doc/global/qt-html-templates-online.qdocconf | 3 +- 3 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 doc/global/includes/module-use.qdocinc (limited to 'doc') 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 d5780a35da..0c012f11d6 100644 --- a/doc/global/qt-html-templates-offline.qdocconf +++ b/doc/global/qt-html-templates-offline.qdocconf @@ -16,6 +16,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 69c399d05a..502c406453 100644 --- a/doc/global/qt-html-templates-online.qdocconf +++ b/doc/global/qt-html-templates-online.qdocconf @@ -7,4 +7,5 @@ include(html-footer-online.qdocconf) #uncomment if navigation bar is not wanted #HTML.nonavigationbar = "true" -sourcedirs += includes-online +sourcedirs += includes-online \ + includes -- cgit v1.2.3 From 57b4f6d56ee1724f454d406562362dbd16366bf2 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Tue, 9 Apr 2019 17:31:18 +0200 Subject: Qt Core: Document CMake macros Document public macros in Qt5CoreMacros.cmake. This will replace the list in the current CMake Manual. Task-number: QTBUG-72159 Change-Id: I377412fe0c1d0a9b232162bbab88ac830d2cac80 Reviewed-by: Leena Miettinen Reviewed-by: Paul Wicking --- doc/global/externalsites/external-resources.qdoc | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'doc') diff --git a/doc/global/externalsites/external-resources.qdoc b/doc/global/externalsites/external-resources.qdoc index 01c6939dca..22c281bd87 100644 --- a/doc/global/externalsites/external-resources.qdoc +++ b/doc/global/externalsites/external-resources.qdoc @@ -71,6 +71,11 @@ \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/prop_tgt/LOCATION.html \title CMake LOCATION Documentation -- cgit v1.2.3 From b7aea2bcd3b67031066e9c23f1827d4c83cfe1f3 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Fri, 26 Apr 2019 17:00:25 +0200 Subject: Qt Widgets: Document CMake macros Task-number: QTBUG-72159 Change-Id: Ib9fdf852583964cf07c4d26e0a6c74f0058e29f1 Reviewed-by: Kevin Funk Reviewed-by: Leena Miettinen --- doc/global/externalsites/external-resources.qdoc | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'doc') diff --git a/doc/global/externalsites/external-resources.qdoc b/doc/global/externalsites/external-resources.qdoc index 22c281bd87..1c3d37c199 100644 --- a/doc/global/externalsites/external-resources.qdoc +++ b/doc/global/externalsites/external-resources.qdoc @@ -76,6 +76,11 @@ \title CMake AUTORCC Documentation */ +/*! + \externalpage https://cmake.org/cmake/help/latest/manual/cmake-qt.7.html#autouic + \title CMake AUTOUIC Documentation +*/ + /*! \externalpage https://cmake.org/cmake/help/latest/prop_tgt/LOCATION.html \title CMake LOCATION Documentation -- cgit v1.2.3