Document how to use CMake for Qt PrintSupport

Move the details on how to build after the index page.
Remove mentioning of the central include. Instead, mention
the CMake functions to use.

Task-number: QTBUG-73058
Change-Id: Ibf5952530c3b86915c9fb6562f7d9e0b010720ee
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
bb10
Kai Koehne 2020-05-22 14:41:44 +02:00
parent 292d49c5e9
commit 3c31dd0330
7 changed files with 21 additions and 73 deletions

View File

@ -27,14 +27,15 @@ qhp.QtPrintSupport.subprojects.classes.sortPages = true
tagfile = ../../../doc/qtprintsupport/qtprintsupport.tags
depends += qtcore qtgui qtwidgets qtdoc qmake
depends += qtcore qtgui qtwidgets qtdoc qmake qtcmake
headerdirs += ..
sourcedirs += ..
exampledirs += ../ \
snippets
exampledirs += . \
snippets \
..
excludedirs += ../../../examples/widgets/doc

View File

@ -0,0 +1,4 @@
#! [cmake_use]
find_package(Qt6 COMPONENTS PrintSupport REQUIRED)
target_link_libraries(mytarget Qt::PrintSupport)
#! [cmake_use]

View File

@ -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$
**
****************************************************************************/
//! [1]
#include <QtPrintSupport>
//! [1]

View File

@ -1,3 +0,0 @@
#! [0]
QT += printsupport
#! [0]

View File

@ -0,0 +1,3 @@
#! [qmake_use]
QT += printsupport
#! [qmake_use]

View File

@ -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.
@ -166,6 +166,14 @@
about the configured page dimensions in order to insert page breaks at the most
appropriate places in printed documents.
\include module-use.qdocinc using qt module
\snippet snippets/CMakeLists.txt cmake_use
See also the \l[QtDoc]{Building with CMake} overview.
\include module-use.qdocinc building with qmake
\snippet snippets/snippets.pro qmake_use
\section1 Licenses and Trademarks
The Qt Print Support module is available under commercial licenses from \l{The Qt Company}.

View File

@ -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.
@ -32,16 +32,4 @@
\ingroup modules
\qtvariable printsupport
To include the definitions of the module's classes, use the
following directive:
\snippet code/doc_src_qtprintsupport.cpp 1
\if !defined(qtforpython)
To link against the module, add this line to your \l qmake \c
.pro file:
\snippet code/doc_src_qtprintsupport.pro 0
\endif
*/