diff options
author | Andreas Eliasson <andreas.eliasson@qt.io> | 2022-03-23 14:43:30 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-03-28 13:19:28 +0000 |
commit | 043bc22e686a22c4d0763009397fb7f46b9c8fd6 (patch) | |
tree | 98aeaa572162c693d5a8913789100fbc238d841d | |
parent | 56bf2177c9dee693a6e09e17062dbd5a4b817669 (diff) | |
download | qtsvg-043bc22e686a22c4d0763009397fb7f46b9c8fd6.tar.gz |
Doc: Revise Qt SVG module landing page
Remove the import directive sections, and include the global CMake and
qmake snippets. Also, reorganize some of the sections structure.
Task-number: QTBUG-100369
Change-Id: I26a591f8ceb43469e6d31e263bd5b7ee58fb262d
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
(cherry picked from commit 1583306082c94b3530534d8858a77f704603b1e4)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/svg/doc/src/qtsvg-index.qdoc | 58 |
1 files changed, 30 insertions, 28 deletions
diff --git a/src/svg/doc/src/qtsvg-index.qdoc b/src/svg/doc/src/qtsvg-index.qdoc index 6e1d35a..9ab744d 100644 --- a/src/svg/doc/src/qtsvg-index.qdoc +++ b/src/svg/doc/src/qtsvg-index.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2022 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt SVG module. @@ -35,17 +35,38 @@ for rendering and displaying SVG drawings in widgets and on other paint devices. - \section1 Getting Started + \section1 Using the Module - Qt SVG provides classes for rendering SVG files. To include the definitions - of the module's classes, use the following directive: + \include {module-use.qdocinc} {using the c++ api} - \snippet doc_src_qtsvg.cpp 0 + \section2 Building with CMake - To link against the module, add this line to your \l qmake \c - .pro file: + \include {module-use.qdocinc} {building with cmake} {Svg} - \snippet doc_src_qtsvg.pro 1 + \section2 Building with qmake + + \include {module-use.qdocinc} {building with cmake} {svg} + + \section1 Articles and Guides + + \list + \li \l {Rendering SVG Files} contains information about how to + render SVG files + \endlist + + \section1 Examples + + \list + \li \l {SVG Generator Example} + \li \l {SVG Viewer Example} + \endlist + + \section1 References + + \list + \li \l {Qt SVG C++ Classes} + \li \l {Qt SVG Widgets C++ Classes} + \endlist \section1 Module Evolution \l{Changes to Qt SVG} lists important changes in the module API @@ -59,27 +80,8 @@ the \l{GNU General Public License, version 2}. See \l{Qt Licensing} for further details. - Furthermore Qt SVG contains third party + Furthermore, Qt SVG contains third party code under following permissive licenses: \generatelist{groupsbymodule attributions-qtsvg} - - \section1 Articles - \list - \li \l{Rendering SVG Files} contains information about how to - render SVG files - \endlist - - \section1 References - \list - \li \l{Qt SVG C++ Classes} - \li \l{Qt SVG Widgets C++ Classes} - \endlist - - Qt SVG comes with the following examples: - - \list - \li \l{SVG Generator Example} - \li \l{SVG Viewer Example} - \endlist */ |