From a0a7a59ea3e11bdb32e7e734cf6585d63e56b595 Mon Sep 17 00:00:00 2001 From: Volker Hilsheimer Date: Wed, 28 Oct 2020 18:27:14 +0100 Subject: Organize QtSvgWidgets documentation Give the widgets class a place to call home. QtSvgWidgets is just a library, not a separate module, but we need a module page that the classes can refer to for correct build instructions. Change-Id: Id7ab95d879991c4b7b375d3c4df9f97206efe181 Reviewed-by: Paul Wicking --- src/svg/doc/qtsvg.qdocconf | 6 ++++-- src/svg/doc/src/qtsvg-index.qdoc | 1 + src/svg/doc/src/qtsvg.qdoc | 15 +++++++++++++++ src/svgwidgets/qgraphicssvgitem.cpp | 2 +- src/svgwidgets/qsvgwidget.cpp | 2 +- 5 files changed, 22 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/svg/doc/qtsvg.qdocconf b/src/svg/doc/qtsvg.qdocconf index 1254d61..c68beab 100644 --- a/src/svg/doc/qtsvg.qdocconf +++ b/src/svg/doc/qtsvg.qdocconf @@ -33,11 +33,13 @@ tagfile = ../../../doc/qtsvg/qtsvg.tags headerdirs += .. \ ../../plugins/imageformats \ - ../../plugins/iconengines + ../../plugins/iconengines \ + ../../svgwidgets sourcedirs += .. \ ../../plugins/imageformats \ - ../../plugins/iconengines + ../../plugins/iconengines \ + ../../svgwidgets exampledirs += ../../../examples/svg \ snippets/ diff --git a/src/svg/doc/src/qtsvg-index.qdoc b/src/svg/doc/src/qtsvg-index.qdoc index adf5e34..4d58301 100644 --- a/src/svg/doc/src/qtsvg-index.qdoc +++ b/src/svg/doc/src/qtsvg-index.qdoc @@ -73,6 +73,7 @@ \section1 References \list \li \l{Qt SVG C++ Classes} + \li \l{Qt SVG Widgets C++ Classes} \endlist Qt SVG comes with the following examples: diff --git a/src/svg/doc/src/qtsvg.qdoc b/src/svg/doc/src/qtsvg.qdoc index a34bbf7..bee0a29 100644 --- a/src/svg/doc/src/qtsvg.qdoc +++ b/src/svg/doc/src/qtsvg.qdoc @@ -39,4 +39,19 @@ for rendering and displaying SVG drawings in widgets and on other paint devices. See the class descriptions for further details. + The \l{Qt SVG Widgets C++ Classes}{Qt SVG Widgets} library provides C++ + classes for rendering SVG drawings into widget UIs. + + \generatelist classesbymodule QtSvgWidgets +*/ + +/* + This "module" only exists so that classes in the separate library have + the correct build system documentation. +*/ +/*! + \module QtSvgWidgets + \title Qt SVG Widgets C++ Classes + \qtcmakepackage SvgWidgets + \qtvariable svgwidgets */ diff --git a/src/svgwidgets/qgraphicssvgitem.cpp b/src/svgwidgets/qgraphicssvgitem.cpp index 89fdabd..667f765 100644 --- a/src/svgwidgets/qgraphicssvgitem.cpp +++ b/src/svgwidgets/qgraphicssvgitem.cpp @@ -98,7 +98,7 @@ public: /*! \class QGraphicsSvgItem - \inmodule QtSvg + \inmodule QtSvgWidgets \ingroup graphicsview-api \brief The QGraphicsSvgItem class is a QGraphicsItem that can be used to render the contents of SVG files. diff --git a/src/svgwidgets/qsvgwidget.cpp b/src/svgwidgets/qsvgwidget.cpp index 8fd7f0d..c043d39 100644 --- a/src/svgwidgets/qsvgwidget.cpp +++ b/src/svgwidgets/qsvgwidget.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE /*! \class QSvgWidget - \inmodule QtSvg + \inmodule QtSvgWidgets \ingroup painting \brief The QSvgWidget class provides a widget that is used to display the contents of -- cgit v1.2.1