summaryrefslogtreecommitdiff
path: root/src/svg/doc/src/qtsvg-index.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/svg/doc/src/qtsvg-index.qdoc')
-rw-r--r--src/svg/doc/src/qtsvg-index.qdoc86
1 files changed, 32 insertions, 54 deletions
diff --git a/src/svg/doc/src/qtsvg-index.qdoc b/src/svg/doc/src/qtsvg-index.qdoc
index 4d58301..544a569 100644
--- a/src/svg/doc/src/qtsvg-index.qdoc
+++ b/src/svg/doc/src/qtsvg-index.qdoc
@@ -1,29 +1,5 @@
-/****************************************************************************
-**
-** Copyright (C) 2017 The Qt Company Ltd.
-** Contact: https://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt SVG module.
-**
-** $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$
-**
-****************************************************************************/
+// Copyright (C) 2022 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\title Qt SVG
@@ -35,20 +11,41 @@
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_qmake} {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{Porting to Qt 6 - Qt SVG} lists important changes in the module API
+ \l{Changes to Qt SVG} lists important changes in the module API
and functionality that were done for the Qt 6 series of Qt.
\section1 Licenses and Attributions
@@ -59,27 +56,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
*/