summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorMiikka Heikkinen <miikka.heikkinen@digia.com>2013-10-16 14:25:58 +0300
committerMiikka Heikkinen <miikka.heikkinen@digia.com>2013-10-16 14:32:02 +0300
commita2807db08e5774aac3979f5cc35993712b4ba73b (patch)
treed17d30f8c40048c6c84e2268645310c9c92058a2 /src
parent575666763aa224dd20d7680d6f9739bdec6cb9cc (diff)
Misc documentation fixes
Change-Id: Ifd7a7ceae128c6d63692459c4502a83971468a46 Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/datavisualization/axis/q3dabstractaxis.cpp4
-rw-r--r--src/datavisualization/axis/q3dcategoryaxis.cpp4
-rw-r--r--src/datavisualization/axis/q3dvalueaxis.cpp4
-rw-r--r--src/datavisualization/data/qabstractdatamapping.cpp2
-rw-r--r--src/datavisualization/data/qabstractdataproxy.cpp4
-rw-r--r--src/datavisualization/data/qbardataitem.cpp2
-rw-r--r--src/datavisualization/data/qbardataproxy.cpp4
-rw-r--r--src/datavisualization/data/qheightmapsurfacedataproxy.cpp4
-rw-r--r--src/datavisualization/data/qitemmodelbardatamapping.cpp4
-rw-r--r--src/datavisualization/data/qitemmodelbardataproxy.cpp4
-rw-r--r--src/datavisualization/data/qitemmodelscatterdatamapping.cpp4
-rw-r--r--src/datavisualization/data/qitemmodelscatterdataproxy.cpp4
-rw-r--r--src/datavisualization/data/qitemmodelsurfacedatamapping.cpp4
-rw-r--r--src/datavisualization/data/qitemmodelsurfacedataproxy.cpp4
-rw-r--r--src/datavisualization/data/qscatterdataitem.cpp2
-rw-r--r--src/datavisualization/data/qscatterdataproxy.cpp4
-rw-r--r--src/datavisualization/data/qsurfacedataitem.cpp2
-rw-r--r--src/datavisualization/data/qsurfacedataproxy.cpp4
-rw-r--r--src/datavisualization/doc/qtdatavisualization.qdocconf2
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc6
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc2
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc4
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc2
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc2
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization.qdoc3
-rw-r--r--src/datavisualization/engine/q3dbars.cpp2
-rw-r--r--src/datavisualization/engine/q3dbox.cpp2
-rw-r--r--src/datavisualization/engine/q3dcamera.cpp2
-rw-r--r--src/datavisualization/engine/q3dlight.cpp2
-rw-r--r--src/datavisualization/engine/q3dobject.cpp2
-rw-r--r--src/datavisualization/engine/q3dscatter.cpp2
-rw-r--r--src/datavisualization/engine/q3dscene.cpp2
-rw-r--r--src/datavisualization/engine/q3dsurface.cpp2
-rw-r--r--src/datavisualization/engine/q3dwindow.cpp2
-rw-r--r--src/datavisualization/global/qtdatavisualizationenums.qdoc9
-rw-r--r--src/datavisualization/input/q3dinputhandler.cpp17
-rw-r--r--src/datavisualization/input/qabstract3dinputhandler.cpp2
-rw-r--r--src/datavisualization/input/qtouch3dinputhandler.cpp15
38 files changed, 79 insertions, 67 deletions
diff --git a/src/datavisualization/axis/q3dabstractaxis.cpp b/src/datavisualization/axis/q3dabstractaxis.cpp
index 07761d0c..8b07cd39 100644
--- a/src/datavisualization/axis/q3dabstractaxis.cpp
+++ b/src/datavisualization/axis/q3dabstractaxis.cpp
@@ -25,7 +25,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class Q3DAbstractAxis
* \inmodule QtDataVisualization
* \brief Q3DAbstractAxis is base class for axes of a graph.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* You should not need to use this class directly, but one of its subclasses instead.
*
@@ -34,7 +34,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype AbstractAxis3D
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates Q3DAbstractAxis
diff --git a/src/datavisualization/axis/q3dcategoryaxis.cpp b/src/datavisualization/axis/q3dcategoryaxis.cpp
index 05f52cdc..43a3d911 100644
--- a/src/datavisualization/axis/q3dcategoryaxis.cpp
+++ b/src/datavisualization/axis/q3dcategoryaxis.cpp
@@ -27,7 +27,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class Q3DCategoryAxis
* \inmodule QtDataVisualization
* \brief The Q3DCategoryAxis class is used for manipulating an axis of a graph.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* Q3DCategoryAxis provides an axis that can be given labels. The axis is divided into equal-sized
* categories based on the data window size defined by setting the axis range.
@@ -38,7 +38,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype CategoryAxis3D
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates Q3DCategoryAxis
diff --git a/src/datavisualization/axis/q3dvalueaxis.cpp b/src/datavisualization/axis/q3dvalueaxis.cpp
index 5e38e4ca..1b18dadb 100644
--- a/src/datavisualization/axis/q3dvalueaxis.cpp
+++ b/src/datavisualization/axis/q3dvalueaxis.cpp
@@ -26,7 +26,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class Q3DValueAxis
* \inmodule QtDataVisualization
* \brief The Q3DValueAxis class is used for manipulating an axis of a graph.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* Q3DValueAxis provides an axis that can be given a range of values and segment and subsegment
* counts to divide the range into.
@@ -38,7 +38,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype ValueAxis3D
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates Q3DValueAxis
diff --git a/src/datavisualization/data/qabstractdatamapping.cpp b/src/datavisualization/data/qabstractdatamapping.cpp
index 892d2f94..a0698810 100644
--- a/src/datavisualization/data/qabstractdatamapping.cpp
+++ b/src/datavisualization/data/qabstractdatamapping.cpp
@@ -24,7 +24,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QAbstractDataMapping
* \inmodule QtDataVisualization
* \brief Abstract base class for QtDataVisualization data mapping classes.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* Data mapping classes provide a way to map data from an external data source to one of
* QtDataVisualization data proxies.
diff --git a/src/datavisualization/data/qabstractdataproxy.cpp b/src/datavisualization/data/qabstractdataproxy.cpp
index 8ccb0d7a..15cb02de 100644
--- a/src/datavisualization/data/qabstractdataproxy.cpp
+++ b/src/datavisualization/data/qabstractdataproxy.cpp
@@ -25,7 +25,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QAbstractDataProxy
* \inmodule QtDataVisualization
* \brief Base class for all QtDataVisualization data proxies.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* You use the visualization type specific inherited classes instead of the base class.
* \sa QBarDataProxy, QScatterDataProxy, QSurfaceDataProxy, {Qt Data Visualization Data Handling}
@@ -33,7 +33,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype AbstractDataProxy
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QAbstractDataProxy
diff --git a/src/datavisualization/data/qbardataitem.cpp b/src/datavisualization/data/qbardataitem.cpp
index 2803c01a..a474d785 100644
--- a/src/datavisualization/data/qbardataitem.cpp
+++ b/src/datavisualization/data/qbardataitem.cpp
@@ -24,7 +24,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QBarDataItem
* \inmodule QtDataVisualization
* \brief The QBarDataItem class provides a container for resolved data to be added to bar graphs.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* A QBarDataItem holds data for a single rendered bar in a graph.
* Bar data proxies parse data into QBarDataItem instances for visualizing.
diff --git a/src/datavisualization/data/qbardataproxy.cpp b/src/datavisualization/data/qbardataproxy.cpp
index 2ec38980..066351f1 100644
--- a/src/datavisualization/data/qbardataproxy.cpp
+++ b/src/datavisualization/data/qbardataproxy.cpp
@@ -25,7 +25,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QBarDataProxy
* \inmodule QtDataVisualization
* \brief Base proxy class for Q3DBars.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* QBarDataProxy handles adding, inserting, changing and removing rows of data.
*
@@ -74,7 +74,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype BarDataProxy
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QBarDataProxy
diff --git a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
index 518e69eb..2c9d4d5e 100644
--- a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
@@ -28,7 +28,7 @@ const float defaultMaxValue = 10.0f;
* \class QHeightMapSurfaceDataProxy
* \inmodule QtDataVisualization
* \brief Base proxy class for Q3DSurface.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* QHeightMapSurfaceDataProxy takes care of surface related height map data handling. It provides a
* way for giving the surface plot a height map to be visualized.
@@ -43,7 +43,7 @@ const float defaultMaxValue = 10.0f;
/*!
* \qmltype HeightMapSurfaceDataProxy
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QHeightMapSurfaceDataProxy
diff --git a/src/datavisualization/data/qitemmodelbardatamapping.cpp b/src/datavisualization/data/qitemmodelbardatamapping.cpp
index fc6f8f54..dd35173f 100644
--- a/src/datavisualization/data/qitemmodelbardatamapping.cpp
+++ b/src/datavisualization/data/qitemmodelbardatamapping.cpp
@@ -24,7 +24,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QItemModelBarDataMapping
* \inmodule QtDataVisualization
* \brief Item model mapping for Q3DBars.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* QItemModelBarDataMapping is used to map roles of QAbstractItemModel to rows, columns, and values
* of Q3DBars. There are three ways to use QItemModelBarDataMapping:
@@ -55,7 +55,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype BarDataMapping
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QItemModelBarDataMapping
diff --git a/src/datavisualization/data/qitemmodelbardataproxy.cpp b/src/datavisualization/data/qitemmodelbardataproxy.cpp
index b0fa74b6..c066f6ac 100644
--- a/src/datavisualization/data/qitemmodelbardataproxy.cpp
+++ b/src/datavisualization/data/qitemmodelbardataproxy.cpp
@@ -26,7 +26,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QItemModelBarDataProxy
* \inmodule QtDataVisualization
* \brief Proxy class for presenting data in item models with Q3DBars.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* QItemModelBarDataProxy allows you to use QAbstractItemModel derived models as a data source
* for Q3DBars. It uses QItemModelBarDataMapping instance to map data from the model to Q3DBars
@@ -40,7 +40,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype ItemModelBarDataProxy
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QItemModelBarDataProxy
diff --git a/src/datavisualization/data/qitemmodelscatterdatamapping.cpp b/src/datavisualization/data/qitemmodelscatterdatamapping.cpp
index f9ef6d04..c4eab20e 100644
--- a/src/datavisualization/data/qitemmodelscatterdatamapping.cpp
+++ b/src/datavisualization/data/qitemmodelscatterdatamapping.cpp
@@ -24,7 +24,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QItemModelScatterDataMapping
* \inmodule QtDataVisualization
* \brief Item model mapping for Q3DScatter.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* QItemModelScatterDataMapping is used to map roles of QAbstractItemModel to the XYZ-values
* of Q3DScatter points.
@@ -44,7 +44,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype ScatterDataMapping
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QItemModelScatterDataMapping
diff --git a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp
index b037d4d1..cf605593 100644
--- a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp
+++ b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp
@@ -26,7 +26,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QItemModelScatterDataProxy
* \inmodule QtDataVisualization
* \brief Proxy class for presenting data in item models with Q3DScatter.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* QItemModelScatterDataProxy allows you to use QAbstractItemModel derived models as a data source
* for Q3DScatter. It maps roles defined in QItemModelScatterDataMapping to roles in the model.
@@ -39,7 +39,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype ItemModelScatterDataProxy
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QItemModelScatterDataProxy
diff --git a/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp b/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp
index 5388ec18..928b8170 100644
--- a/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp
+++ b/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp
@@ -24,7 +24,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QItemModelSurfaceDataMapping
* \inmodule QtDataVisualization
* \brief Item model mapping for Q3DSurface.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* QItemModelSurfaceDataMapping is used to map roles of QAbstractItemModel to rows, columns, and values
* of Q3DSurface. There are three ways to use QItemModelSurfaceDataMapping:
@@ -56,7 +56,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype SurfaceDataMapping
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QItemModelSurfaceDataMapping
diff --git a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp
index f6403e9b..750de4e2 100644
--- a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp
@@ -28,7 +28,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QItemModelSurfaceDataProxy
* \inmodule QtDataVisualization
* \brief Proxy class for presenting data in item models with Q3DSurface.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* QItemModelSurfaceDataProxy allows you to use QAbstractItemModel derived models as a data source
* for Q3DSurface. It maps roles defined in QItemModelSurfaceDataMapping to roles in the model.
@@ -41,7 +41,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype ItemModelSurfaceDataProxy
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QItemModelSurfaceDataProxy
diff --git a/src/datavisualization/data/qscatterdataitem.cpp b/src/datavisualization/data/qscatterdataitem.cpp
index 055a9dad..5c6f1f66 100644
--- a/src/datavisualization/data/qscatterdataitem.cpp
+++ b/src/datavisualization/data/qscatterdataitem.cpp
@@ -25,7 +25,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \inmodule QtDataVisualization
* \brief The QScatterDataItem class provides a container for resolved data to be added to scatter
* graphs.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* A QScatterDataItem holds data for a single rendered item in a scatter graph.
* Scatter data proxies parse data into QScatterDataItem instances for visualizing.
diff --git a/src/datavisualization/data/qscatterdataproxy.cpp b/src/datavisualization/data/qscatterdataproxy.cpp
index 4d83da8d..af237799 100644
--- a/src/datavisualization/data/qscatterdataproxy.cpp
+++ b/src/datavisualization/data/qscatterdataproxy.cpp
@@ -25,7 +25,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QScatterDataProxy
* \inmodule QtDataVisualization
* \brief Base proxy class for Q3DScatter.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* QScatterDataProxy handles adding, inserting, changing and removing data items.
*
@@ -58,7 +58,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype ScatterDataProxy
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QScatterDataProxy
diff --git a/src/datavisualization/data/qsurfacedataitem.cpp b/src/datavisualization/data/qsurfacedataitem.cpp
index 19f8f347..f5f91464 100644
--- a/src/datavisualization/data/qsurfacedataitem.cpp
+++ b/src/datavisualization/data/qsurfacedataitem.cpp
@@ -25,7 +25,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \inmodule QtDataVisualization
* \brief The QSurfaceDataItem class provides a container for resolved data to be added to surface
* graphs.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* A QSurfaceDataItem holds data for a single vertex in surface graph.
* Surface data proxies parse data into QSurfaceDataItem instances for visualizing.
diff --git a/src/datavisualization/data/qsurfacedataproxy.cpp b/src/datavisualization/data/qsurfacedataproxy.cpp
index 72f33de7..c09213bd 100644
--- a/src/datavisualization/data/qsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qsurfacedataproxy.cpp
@@ -25,7 +25,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class QSurfaceDataProxy
* \inmodule QtDataVisualization
* \brief Base proxy class for Q3DSurface.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* QSurfaceDataProxy takes care of surface related data handling. The QSurfaceDataProxy handles the data
* in rows and for this it provides two auxiliary typedefs. QSurfaceDataArray is a QList for
@@ -66,7 +66,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \qmltype SurfaceDataProxy
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QSurfaceDataProxy
diff --git a/src/datavisualization/doc/qtdatavisualization.qdocconf b/src/datavisualization/doc/qtdatavisualization.qdocconf
index 14dcb3cd..fffcd3c4 100644
--- a/src/datavisualization/doc/qtdatavisualization.qdocconf
+++ b/src/datavisualization/doc/qtdatavisualization.qdocconf
@@ -41,7 +41,7 @@ qhp.qtdatavisualization.subprojects.classes.selectors = class
qhp.qtdatavisualization.subprojects.classes.sortPages = true
qhp.qtdatavisualization.subprojects.types.title = QML Types
qhp.qtdatavisualization.subprojects.types.indexTitle = Qt Data Visualization QML Types
-qhp.qtdatavisualization.subprojects.types.selectors = class
+qhp.qtdatavisualization.subprojects.types.selectors = fake:qmlclass
qhp.qtdatavisualization.subprojects.types.sortPages = true
HTML.footer = \
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
index 7a0d2c4a..6d85a1bd 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-abstractdeclarative.qdoc
@@ -18,17 +18,13 @@
/*!
\qmltype AbstractGraph3D
- \inqmlmodule com.digia.QtDataVisualization 1.0
+ \inqmlmodule com.digia.QtDataVisualization
\since com.digia.QtDataVisualization 1.0
\ingroup datavisualization_qml
\brief Base type for 3D visualizations.
This type is the base type for all 3D visualizations in QtDataVisualization.
- It resides in the data visualization module that can be imported like this:
-
- \snippet doc_src_qmldatavisualization.cpp 0
-
Note that this type is uncreatable, but contains properties that are shared between
the 3D visualizations.
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
index 213542b9..5e6ef522 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
@@ -19,7 +19,7 @@
/*!
* \qmltype Bars3D
* \inherits AbstractGraph3D
- * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \inqmlmodule com.digia.QtDataVisualization
* \since com.digia.QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \brief 3D bar graph.
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc
index f8edf492..5c823d25 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc
@@ -18,7 +18,7 @@
/*!
\qmltype ColorGradientStop
- \inqmlmodule com.digia.QtDataVisualization 1.0
+ \inqmlmodule com.digia.QtDataVisualization
\since com.digia.QtDataVisualization 1.0
\ingroup datavisualization_qml
\brief Defines the color at a position in ColorGradient.
@@ -50,7 +50,7 @@
/*!
\qmltype ColorGradient
- \inqmlmodule com.digia.QtDataVisualization 1.0
+ \inqmlmodule com.digia.QtDataVisualization
\since com.digia.QtDataVisualization 1.0
\ingroup datavisualization_qml
\brief Defines a color gradient.
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc
index 2839468e..e583a807 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-scatter3d.qdoc
@@ -19,7 +19,7 @@
/*!
\qmltype Scatter3D
\inherits AbstractGraph3D
- \inqmlmodule com.digia.QtDataVisualization 1.0
+ \inqmlmodule com.digia.QtDataVisualization
\since com.digia.QtDataVisualization 1.0
\ingroup datavisualization_qml
\brief 3D scatter graph.
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc
index 3669c1cd..ecc40cdf 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc
@@ -19,7 +19,7 @@
/*!
\qmltype Surface3D
\inherits AbstractGraph3D
- \inqmlmodule com.digia.QtDataVisualization 1.0
+ \inqmlmodule com.digia.QtDataVisualization
\since com.digia.QtDataVisualization 1.0
\ingroup datavisualization_qml
\brief 3D surface graph.
diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc
index 191c7ba8..c7f7d166 100644
--- a/src/datavisualization/doc/src/qtdatavisualization.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc
@@ -27,8 +27,9 @@
*/
/*!
- \group datavisualization_qml
+ \qmlmodule com.digia.QtDataVisualization 1.0
\title Qt Data Visualization QML Types
+ \ingroup qmlmodules
\brief QML types for the Qt Data Visualization API.
diff --git a/src/datavisualization/engine/q3dbars.cpp b/src/datavisualization/engine/q3dbars.cpp
index b40aeddd..883af264 100644
--- a/src/datavisualization/engine/q3dbars.cpp
+++ b/src/datavisualization/engine/q3dbars.cpp
@@ -34,7 +34,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class Q3DBars
* \inmodule QtDataVisualization
* \brief The Q3DBars class provides methods for rendering 3D bar graphs.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* This class enables developers to render bar graphs in 3D and to view them by rotating the scene
* freely. Rotation is done by holding down the right mouse button and moving the mouse. Zooming
diff --git a/src/datavisualization/engine/q3dbox.cpp b/src/datavisualization/engine/q3dbox.cpp
index 43f3e90e..cc1e0265 100644
--- a/src/datavisualization/engine/q3dbox.cpp
+++ b/src/datavisualization/engine/q3dbox.cpp
@@ -26,7 +26,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
\class Q3DBox
\inmodule QtDataVisualization
\brief The Q3DBox class represents an axis-aligned box in 3D space.
- \since 1.0.0
+ \since Qt Data Visualization 1.0
Q3DBox can be used to represent the bounding box of objects in a 3D
scene so that they can be easily culled if they are out of view.
diff --git a/src/datavisualization/engine/q3dcamera.cpp b/src/datavisualization/engine/q3dcamera.cpp
index 8b9bcaa7..26329eb7 100644
--- a/src/datavisualization/engine/q3dcamera.cpp
+++ b/src/datavisualization/engine/q3dcamera.cpp
@@ -32,7 +32,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
\class Q3DCamera
\inmodule QtDataVisualization
\brief Representation of a camera in 3D space.
- \since 1.0.0
+ \since Qt Data Visualization 1.0
Q3DCamera represents a basic orbit around centerpoint 3D camera that is used when rendering the data visualization.
The class offers simple methods for setting the orbit point in rotations, but allows also setting the 4x4 viewmatrix
diff --git a/src/datavisualization/engine/q3dlight.cpp b/src/datavisualization/engine/q3dlight.cpp
index c482e62a..f1b1b4e7 100644
--- a/src/datavisualization/engine/q3dlight.cpp
+++ b/src/datavisualization/engine/q3dlight.cpp
@@ -26,7 +26,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
\class Q3DLight
\inmodule QtDataVisualization
\brief Representation of a light source in 3D space.
- \since 1.0.0
+ \since Qt Data Visualization 1.0
Q3DLight represents a monochrome non variable light source in 3D space.
*/
diff --git a/src/datavisualization/engine/q3dobject.cpp b/src/datavisualization/engine/q3dobject.cpp
index ae13af7d..c4098fd0 100644
--- a/src/datavisualization/engine/q3dobject.cpp
+++ b/src/datavisualization/engine/q3dobject.cpp
@@ -26,7 +26,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
\class Q3DObject
\inmodule QtDataVisualization
\brief Simple baseclass for all the objects in the 3D scene.
- \since 1.0.0
+ \since Qt Data Visualization 1.0
Q3DObject is a baseclass that contains only position information for an object in 3D scene.
The object is considered to be a single point in the coordinate space without dimensions.
diff --git a/src/datavisualization/engine/q3dscatter.cpp b/src/datavisualization/engine/q3dscatter.cpp
index 3ad2cf2a..68470407 100644
--- a/src/datavisualization/engine/q3dscatter.cpp
+++ b/src/datavisualization/engine/q3dscatter.cpp
@@ -32,7 +32,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class Q3DScatter
* \inmodule QtDataVisualization
* \brief The Q3DScatter class provides methods for rendering 3D scatter graphs.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* This class enables developers to render scatter graphs in 3D and to view them by rotating the scene
* freely. Rotation is done by holding down the right mouse button and moving the mouse. Zooming
diff --git a/src/datavisualization/engine/q3dscene.cpp b/src/datavisualization/engine/q3dscene.cpp
index 4908bde4..3789ea9f 100644
--- a/src/datavisualization/engine/q3dscene.cpp
+++ b/src/datavisualization/engine/q3dscene.cpp
@@ -30,7 +30,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class Q3DScene
* \inmodule QtDataVisualization
* \brief Q3DScene class provides description of the 3D scene being visualized.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* The 3D scene contains a single active camera and a single active light source.
* Visualized data is assumed to be at a fixed location.
diff --git a/src/datavisualization/engine/q3dsurface.cpp b/src/datavisualization/engine/q3dsurface.cpp
index 2a6506e1..72fd50c0 100644
--- a/src/datavisualization/engine/q3dsurface.cpp
+++ b/src/datavisualization/engine/q3dsurface.cpp
@@ -30,7 +30,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class Q3DSurface
* \inmodule QtDataVisualization
* \brief The Q3DSurface class provides methods for rendering 3D surface plots.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* This class enables developers to render 3D surface plots and to view them by rotating the scene
* freely. The class provides configurable gradient texture to illustrate the height on the data. The
diff --git a/src/datavisualization/engine/q3dwindow.cpp b/src/datavisualization/engine/q3dwindow.cpp
index 9b607e1d..f7fb8abb 100644
--- a/src/datavisualization/engine/q3dwindow.cpp
+++ b/src/datavisualization/engine/q3dwindow.cpp
@@ -33,7 +33,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* \class Q3DWindow
* \inmodule QtDataVisualization
* \brief The Q3DWindow class provides a window and render loop.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* This class creates a QWindow and provides render loop for visualization types inheriting it.
* \warning This class is not intended to be used directly by developers.
diff --git a/src/datavisualization/global/qtdatavisualizationenums.qdoc b/src/datavisualization/global/qtdatavisualizationenums.qdoc
index 57e7d13d..d448953d 100644
--- a/src/datavisualization/global/qtdatavisualizationenums.qdoc
+++ b/src/datavisualization/global/qtdatavisualizationenums.qdoc
@@ -28,6 +28,15 @@
*/
/*!
+ * \class QtDataVisualization::QDataVis
+ * \inmodule QtDataVisualization
+ * \brief Container class for Qt Data Visualization enums.
+ * \since Qt Data Visualization 1.0
+ *
+ * QDataVis acts as a container for Qt Data Visualization enums. It has no other functionality.
+ */
+
+/*!
\enum QtDataVisualization::QDataVis::InputState
Predefined input states for mouse and touch based input handlers. All states are not valid with all input handlers.
diff --git a/src/datavisualization/input/q3dinputhandler.cpp b/src/datavisualization/input/q3dinputhandler.cpp
index 5267568c..357c97d3 100644
--- a/src/datavisualization/input/q3dinputhandler.cpp
+++ b/src/datavisualization/input/q3dinputhandler.cpp
@@ -38,23 +38,26 @@ const float rotationSpeed = 100.0f;
* \class Q3DInputHandler
* \inmodule QtDataVisualization
* \brief Basic wheel mouse based input handler.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* Q3DInputHandler is the basic input handler for wheel mouse type of input devices.
*
* Default input handler has the following functionalty:
* \table
* \header
- * \li Mouse action \li Action
+ * \li Mouse action \li Action
* \row
- * \li Right button pressed \li Rotate graph within limits set for Q3DCamera
+ * \li Drag with right button pressed \li Rotate graph within limits set for Q3DCamera.
* \row
- * \li Left click \li Select item under cursor or remove selection if none
+ * \li Left click \li Select item under cursor or remove selection if none.
+ * May open the secondary view depending on the
+ * selection mode.
* \row
- * \li Mouse wheel \li Zoom in/out within default range (10...500%)
+ * \li Mouse wheel \li Zoom in/out within default range (10...500%).
* \row
- * \li Left click on secodanry view \li Return to primary view when in slice mode
- * \note Slice mode is available in Q3DBars and Q3DSurface only
+ * \li Left click on the primary view when the secondary view is visible
+ * \li Closes the secondary view.
+ * \note Secondary view is available only for Q3DBars and Q3DSurface graphs.
* \endtable
*/
diff --git a/src/datavisualization/input/qabstract3dinputhandler.cpp b/src/datavisualization/input/qabstract3dinputhandler.cpp
index e111ff42..8cf6ae22 100644
--- a/src/datavisualization/input/qabstract3dinputhandler.cpp
+++ b/src/datavisualization/input/qabstract3dinputhandler.cpp
@@ -23,7 +23,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
\class QAbstract3DInputHandler
\inmodule QtDataVisualization
\brief Baseclass for implementations of input handlers.
- \since 1.0.0
+ \since Qt Data Visualization 1.0
QAbstract3DInputHandler is a baseclass that is subclassed by different input handling implementations
that take input events and translate those to camera and light movements. Input handlers also translate
diff --git a/src/datavisualization/input/qtouch3dinputhandler.cpp b/src/datavisualization/input/qtouch3dinputhandler.cpp
index fd079e88..1d8bd929 100644
--- a/src/datavisualization/input/qtouch3dinputhandler.cpp
+++ b/src/datavisualization/input/qtouch3dinputhandler.cpp
@@ -39,7 +39,7 @@ const int maxZoomLevel = 500;
* \class QTouch3DInputHandler
* \inmodule QtDataVisualization
* \brief Basic touch display based input handler.
- * \since 1.0.0
+ * \since Qt Data Visualization 1.0
*
* QTouch3DInputHandler is the basic input handler for touch screen devices.
*
@@ -50,14 +50,17 @@ const int maxZoomLevel = 500;
* \row
* \li Touch-And-Move \li Rotate graph within limits set for Q3DCamera
* \row
- * \li Tap \li Select item under pointer or remove selection if none
+ * \li Tap \li Select the item tapped or remove selection if none.
+ * May open the secondary view depending on the
+ * selection mode.
* \row
- * \li Tap-And-Hold \li Select item under pointer or remove selection if none
+ * \li Tap-And-Hold \li Same as tap.
* \row
- * \li Pinch \li Zoom in/out within default range (10...500%)
+ * \li Pinch \li Zoom in/out within default range (10...500%).
* \row
- * \li Tap on secondary view \li Return to primary view when in slice mode
- * \note Slice mode is available in Q3DBars and Q3DSurface only
+ * \li Tap on the primary view when the secondary view is visible
+ * \li Closes the secondary view.
+ * \note Secondary view is available only for Q3DBars and Q3DSurface graphs.
* \endtable
*/