diff options
| author | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2020-10-28 18:27:14 +0100 |
|---|---|---|
| committer | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2020-10-29 06:35:10 +0100 |
| commit | a0a7a59ea3e11bdb32e7e734cf6585d63e56b595 (patch) | |
| tree | 3155fb80fc63ff639e974f1a2755b521fb347aa7 | |
| parent | 3d61f7e676a054a69db486ca89d17ff8ed0f3b0c (diff) | |
| download | qtsvg-a0a7a59ea3e11bdb32e7e734cf6585d63e56b595.tar.gz | |
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 <paul.wicking@qt.io>
| -rw-r--r-- | src/svg/doc/qtsvg.qdocconf | 6 | ||||
| -rw-r--r-- | src/svg/doc/src/qtsvg-index.qdoc | 1 | ||||
| -rw-r--r-- | src/svg/doc/src/qtsvg.qdoc | 15 | ||||
| -rw-r--r-- | src/svgwidgets/qgraphicssvgitem.cpp | 2 | ||||
| -rw-r--r-- | src/svgwidgets/qsvgwidget.cpp | 2 |
5 files changed, 22 insertions, 4 deletions
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 |