From cede00ec892805ad0f04db6566bf002195c4cb09 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Fri, 22 May 2020 16:20:58 +0200 Subject: Document how to use CMake for Qt Xml Task-number: QTBUG-73058 Change-Id: I2d19670016c9aef5e96d74b2b7e22c675058f30c Reviewed-by: Paul Wicking --- src/xml/doc/qtxml.qdocconf | 3 +- src/xml/doc/snippets/CMakeLists.txt | 4 +++ src/xml/doc/snippets/code/doc_src_qtxml.cpp | 53 ----------------------------- src/xml/doc/snippets/code/doc_src_qtxml.pro | 3 -- src/xml/doc/snippets/snippets.pro | 9 +++++ src/xml/doc/src/qtxml-index.qdoc | 20 +++++------ src/xml/doc/src/qtxml.qdoc | 14 +------- 7 files changed, 24 insertions(+), 82 deletions(-) create mode 100644 src/xml/doc/snippets/CMakeLists.txt delete mode 100644 src/xml/doc/snippets/code/doc_src_qtxml.cpp delete mode 100644 src/xml/doc/snippets/code/doc_src_qtxml.pro create mode 100644 src/xml/doc/snippets/snippets.pro (limited to 'src') diff --git a/src/xml/doc/qtxml.qdocconf b/src/xml/doc/qtxml.qdocconf index 25a463fecd..5b00e1cab8 100644 --- a/src/xml/doc/qtxml.qdocconf +++ b/src/xml/doc/qtxml.qdocconf @@ -27,13 +27,14 @@ qhp.QtXml.subprojects.classes.sortPages = true tagfile = ../../../doc/qtxml/qtxml.tags -depends += qtcore qtnetwork qtdoc qtwidgets qmake +depends += qtcore qtnetwork qtdoc qtwidgets qmake qtcmake headerdirs += .. sourcedirs += .. exampledirs += ../../../examples/xml \ + . \ snippets imagedirs += images \ diff --git a/src/xml/doc/snippets/CMakeLists.txt b/src/xml/doc/snippets/CMakeLists.txt new file mode 100644 index 0000000000..bcfc5cd0b6 --- /dev/null +++ b/src/xml/doc/snippets/CMakeLists.txt @@ -0,0 +1,4 @@ +#! [cmake_use] +find_package(Qt6 COMPONENTS Xml REQUIRED) +target_link_libraries(mytarget Qt::Xml) +#! [cmake_use] diff --git a/src/xml/doc/snippets/code/doc_src_qtxml.cpp b/src/xml/doc/snippets/code/doc_src_qtxml.cpp deleted file mode 100644 index dfda547242..0000000000 --- a/src/xml/doc/snippets/code/doc_src_qtxml.cpp +++ /dev/null @@ -1,53 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:BSD$ -** 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. -** -** BSD License Usage -** Alternatively, you may use this file under the terms of the BSD license -** as follows: -** -** "Redistribution and use in source and binary forms, with or without -** modification, are permitted provided that the following conditions are -** met: -** * Redistributions of source code must retain the above copyright -** notice, this list of conditions and the following disclaimer. -** * Redistributions in binary form must reproduce the above copyright -** notice, this list of conditions and the following disclaimer in -** the documentation and/or other materials provided with the -** distribution. -** * Neither the name of The Qt Company Ltd nor the names of its -** contributors may be used to endorse or promote products derived -** from this software without specific prior written permission. -** -** -** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -//! [0] -#include -//! [0] diff --git a/src/xml/doc/snippets/code/doc_src_qtxml.pro b/src/xml/doc/snippets/code/doc_src_qtxml.pro deleted file mode 100644 index 71d23856b0..0000000000 --- a/src/xml/doc/snippets/code/doc_src_qtxml.pro +++ /dev/null @@ -1,3 +0,0 @@ -#! [1] -QT += xml -#! [1] diff --git a/src/xml/doc/snippets/snippets.pro b/src/xml/doc/snippets/snippets.pro new file mode 100644 index 0000000000..df72b89d98 --- /dev/null +++ b/src/xml/doc/snippets/snippets.pro @@ -0,0 +1,9 @@ +TEMPLATE = lib + +TARGET = xml_snippets + +#! [qmake_use] +QT += xml +#! [qmake_use] + +load(qt_common) diff --git a/src/xml/doc/src/qtxml-index.qdoc b/src/xml/doc/src/qtxml-index.qdoc index 0b8010395f..6a0f1da613 100644 --- a/src/xml/doc/src/qtxml-index.qdoc +++ b/src/xml/doc/src/qtxml-index.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -35,20 +35,16 @@ QXmlStreamWriter classes. The classes are both easier to use and more compliant with the XML standard. - To include the definitions of the module's classes, use the - following directive: - - \snippet code/doc_src_qtxml.cpp 0 + The \l{Qt XML C++ Classes} page gives an overview over the available classes + in this module. - \if !defined(qtforpython) - To link against the module, add this line to your \l qmake \c - .pro file: + \include module-use.qdocinc using qt module + \snippet snippets/CMakeLists.txt cmake_use - \snippet code/doc_src_qtxml.pro 1 - \endif + See also the \l[QtDoc]{Building with CMake} overview. - The \l{Qt XML C++ Classes} page gives an overview over the available classes - in this module. + \include module-use.qdocinc building with qmake + \snippet snippets/snippets.pro qmake_use \section1 Licenses diff --git a/src/xml/doc/src/qtxml.qdoc b/src/xml/doc/src/qtxml.qdoc index 452e39d745..b12089841d 100644 --- a/src/xml/doc/src/qtxml.qdoc +++ b/src/xml/doc/src/qtxml.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -37,16 +37,4 @@ documents iteratively (SAX), we recommend using Qt Core's QXmlStreamReader and QXmlStreamWriter classes. The classes are both easier to use and more compliant with the XML standard. - - To include the definitions of the module's classes, use the - following directive: - - \snippet code/doc_src_qtxml.cpp 0 - - \if !defined(qtforpython) - To link against the module, add this line to your \l qmake \c - .pro file: - - \snippet code/doc_src_qtxml.pro 1 - \endif */ -- cgit v1.2.3