diff options
Diffstat (limited to 'src/datavisualization/doc')
14 files changed, 26 insertions, 24 deletions
diff --git a/src/datavisualization/doc/qtdatavis3d.qdocconf b/src/datavisualization/doc/qtdatavis3d.qdocconf index 3e0309a0..952cac3e 100644 --- a/src/datavisualization/doc/qtdatavis3d.qdocconf +++ b/src/datavisualization/doc/qtdatavis3d.qdocconf @@ -47,5 +47,3 @@ qhp.QtDataVis3D.subprojects.types.sortPages = true navigation.landingpage = Qt Data Visualization navigation.cppclassespage = Qt Data Visualization C++ Classes navigation.qmltypespage = Qt Data Visualization QML Types - -manifestmeta.highlighted.names = "QtDataVis3D/Textured Surface Example" diff --git a/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp b/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp index 5cae4483..2f10a988 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dbars_construction.cpp @@ -1,5 +1,5 @@ // Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [3] #include <QtDataVisualization> diff --git a/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp b/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp index b8369526..5bf508f3 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dscatter_construction.cpp @@ -1,5 +1,5 @@ // Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [3] #include <QtDataVisualization> diff --git a/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp b/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp index c2baaf15..3946ede6 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dsurface_construction.cpp @@ -1,5 +1,5 @@ // Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [5] #include <QtDataVisualization> diff --git a/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp b/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp index f0802549..a192976d 100644 --- a/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp +++ b/src/datavisualization/doc/snippets/doc_src_q3dtheme.cpp @@ -1,5 +1,5 @@ // Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause #include <QtDataVisualization/Q3DBars> #include <QtDataVisualization/Q3DTheme> diff --git a/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp b/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp index a6e45d48..488d3a6f 100644 --- a/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp +++ b/src/datavisualization/doc/snippets/doc_src_qmldatavisualization.cpp @@ -1,5 +1,5 @@ // Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] import QtDataVisualization 1.2 diff --git a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp index 89a34cfe..fa4e5178 100644 --- a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp +++ b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.cpp @@ -1,5 +1,5 @@ // Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] #include <QtDataVisualization> diff --git a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro index 195567b3..00652a42 100644 --- a/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro +++ b/src/datavisualization/doc/snippets/doc_src_qtdatavisualization.pro @@ -1,5 +1,5 @@ // Copyright (C) 2018 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause #! [0] QT += datavisualization diff --git a/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc b/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc index 3db3a8f7..0bf83ec4 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-overview.qdoc @@ -5,6 +5,7 @@ \title Qt Data Visualization Overview \page qtdatavisualization-overview.html \brief An overview of the Qt Data Visualization module. + \ingroup explanation The Qt Data Visualization module provides a way to develop rapidly responding, complex, and dynamic 3D visualization for analytical demanding @@ -55,8 +56,8 @@ \image q3dbars-minimal.png - For more information, see \l{How to construct a minimal Q3DBars graph}, - \l {Bar Graph}, and \l {Simple Bar Graph} examples. + For more information, see \l{How to construct a minimal Q3DBars graph}, and + \l {Simple Bar Graph} examples. \section2 3D Scatter Graphs @@ -68,8 +69,8 @@ \image q3dscatter-minimal.png - For more information, see \l{How to construct a minimal Q3DScatter graph}, - \l{Scatter Graph}, and \l{Simple Scatter Graph} examples. + For more information, see \l{How to construct a minimal Q3DScatter graph}, and + \l{Simple Scatter Graph} examples. \section2 3D Surface Graphs @@ -81,8 +82,8 @@ \image q3dsurface-minimal.png - For more information, see \l{How to construct a minimal Q3DSurface graph}, - \l{Surface Graph}, \l{Textured Surface Graph}, and \l{Surface Graph from Height Data} examples. + For more information, see \l{How to construct a minimal Q3DSurface graph}, \l{Graph Gallery}, + and \l{Surface Graph Gallery} examples. \section1 Using OpenGL for Rendering Data @@ -186,7 +187,7 @@ If a graph displays the data from several data series, some settings can be specified separately for each series. For example, different gradients can be specified for different layers of the graph to make it look more - realistic. For an example, see \l{Custom Items in Graph}. + realistic. For an example, see \l{Surface Graph Gallery}. \section1 Customizing 3D Scenes diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc index 922a9c03..c2bb0cc5 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc @@ -284,7 +284,7 @@ * \c selectedElementChanged signal is emitted. * * The signal can be used for example for implementing customized input - * handling, as demonstrated by the \l {Axis Dragging} example. + * handling, as demonstrated by the \l {Axis Handling} example. * * \sa selectedLabelIndex(), selectedAxis(), selectedCustomItemIndex(), selectedCustomItem(), * Bars3D::selectedSeries, Scatter3D::selectedSeries, Scene3D::selectionQueryPosition, diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-color.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-color.qdoc index 12fb6650..cb8b70d2 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-color.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-color.qdoc @@ -17,4 +17,6 @@ The color property describes the color of this ThemeColor. The default color is black. + + \note Transparency is not supported and will result in undefined behavior. */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc index d3375a90..36277944 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc @@ -30,6 +30,8 @@ The default color is black. + \note Transparency in a gradient is not supported and will result in undefined behavior. + \sa ColorGradient */ diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc index 438d6163..b8f47fd3 100644 --- a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc @@ -19,7 +19,7 @@ \snippet doc_src_qmldatavisualization.cpp 3 - See \l{Surface Graph from Height Data} for more thorough usage example. + See \l{Surface Graph Gallery} for more thorough usage example. \sa Surface3DSeries, ItemModelSurfaceDataProxy, Bars3D, Scatter3D, {Qt Data Visualization C++ Classes} */ diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc index ea5b2047..5b91c2da 100644 --- a/src/datavisualization/doc/src/qtdatavisualization.qdoc +++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc @@ -27,7 +27,6 @@ /*! \group datavisualization_examples - \ingroup all-examples \title Qt Data Visualization Examples \brief Examples for the Qt Data Visualization. @@ -113,9 +112,9 @@ QHeightMapSurfaceDataProxy is a specialized proxy for generating a surface graph from a heightmap image. See the QHeightMapSurfaceDataProxy documentation for more information. - The \l{Data from Custom Proxy}{Custom Proxy} example shows how a custom proxy can be created. It - defines a custom data set based on variant lists and an extension of the basic proxy to resolve - that data with an associated mapper. + The \l{Graph Gallery} example shows how a custom proxy can be created, under the + \uicontrol {Bar Graph} tab. It defines a custom data set based on variant lists and an + extension of the basic proxy to resolve that data with an associated mapper. \section1 Dealing with Real-time Data @@ -163,8 +162,8 @@ the default touch controls, see QTouch3DInputHandler. The default handlers must be disabled when using customized input handlers. - The \l{Input Handling for Axes} illustrates how to use a custom input handler - to drag an axis label to move the visible part of the data. + The \l{Graph Gallery} example, under \uicontrol {Scatter Graph} tab, illustrates how to use + a custom input handler to drag an axis label to move the visible part of the data. In addition to perspective projection, orthographic projection can be used to create 2D graphs by replacing the default input handler with one that |