Improve documentation on data handling

Change-Id: Ie1acb5b12eeb9b59815b7482042edc8adc0250d8
Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>

5 files changed, 26 insertions, 4 deletions

diff --git a/src/datavisualization/data/qitemmodelbardatamapping.cpp b/src/datavisualization/data/qitemmodelbardatamapping.cpp
index 54cb0708..fc6f8f54 100644
--- a/src/datavisualization/data/qitemmodelbardatamapping.cpp
+++ b/src/datavisualization/data/qitemmodelbardatamapping.cpp
@@ -88,12 +88,14 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
 
 /*!
  * \qmlproperty list BarDataMapping::rowCategories
- * The row categories of the mapping.
+ * The row categories of the mapping. Only items with row roles that are found in this list are
+ * included when data is resolved. The rows are ordered in the same order as they are in this list.
  */
 
 /*!
  * \qmlproperty list BarDataMapping::columnCategories
- * The column categories of the mapping.
+ * The column categories of the mapping. Only items with column roles that are found in this list are
+ * included when data is resolved. The columns are ordered in the same order as they are in this list.
  */
 
 /*!
diff --git a/src/datavisualization/data/qitemmodelbardataproxy.cpp b/src/datavisualization/data/qitemmodelbardataproxy.cpp
index 85fd8bf9..b0fa74b6 100644
--- a/src/datavisualization/data/qitemmodelbardataproxy.cpp
+++ b/src/datavisualization/data/qitemmodelbardataproxy.cpp
@@ -32,6 +32,9 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  * for Q3DBars. It uses QItemModelBarDataMapping instance to map data from the model to Q3DBars
  * graph.
  *
+ * Data is resolved asynchronously whenever the mapping or the model changes.
+ * QBarDataProxy::arrayReset() is emitted when the data has been resolved.
+ *
  * \sa QItemModelBarDataMapping, {Qt Data Visualization Data Handling}
  */
 
@@ -46,6 +49,9 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  *
  * This type allows you to use AbstractItemModel derived models as a data source for Bars3D.
  *
+ * Data is resolved asynchronously whenever the mapping or the model changes.
+ * QBarDataProxy::arrayReset() is emitted when the data has been resolved.
+ *
  * Usage example:
  *
  * \snippet doc_src_qmldatavisualization.cpp 7
diff --git a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp
index 7527f87e..b037d4d1 100644
--- a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp
+++ b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp
@@ -31,6 +31,9 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  * 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.
  *
+ * Data is resolved asynchronously whenever the mapping or the model changes.
+ * QScatterDataProxy::arrayReset() is emitted when the data has been resolved.
+ *
  * /sa {Qt Data Visualization Data Handling}
  */
 
@@ -45,6 +48,9 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  *
  * This type allows you to use AbstractItemModel derived models as a data source for Scatter3D.
  *
+ * Data is resolved asynchronously whenever the mapping or the model changes.
+ * QScatterDataProxy::arrayReset() is emitted when the data has been resolved.
+ *
  * Usage example:
  *
  * \snippet doc_src_qmldatavisualization.cpp 8
diff --git a/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp b/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp
index 0b7c74c9..5388ec18 100644
--- a/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp
+++ b/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp
@@ -89,12 +89,14 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
 
 /*!
  * \qmlproperty list SurfaceDataMapping::rowCategories
- * The row categories of the mapping.
+ * The row categories of the mapping. Only items with row roles that are found in this list are
+ * included when data is resolved. The rows are ordered in the same order as they are in this list.
  */
 
 /*!
  * \qmlproperty list SurfaceDataMapping::columnCategories
- * The column categories of the mapping.
+ * The column categories of the mapping. Only items with column roles that are found in this list are
+ * included when data is resolved. The columns are ordered in the same order as they are in this list.
  */
 
 /*!
diff --git a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp
index 22271c2e..f6403e9b 100644
--- a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp
@@ -33,6 +33,9 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  * 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.
  *
+ * Data is resolved asynchronously whenever the mapping or the model changes.
+ * QSurfaceDataProxy::arrayReset() is emitted when the data has been resolved.
+ *
  * /sa {Qt Data Visualization Data Handling}
  */
 
@@ -47,6 +50,9 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  *
  * This type allows you to use AbstractItemModel derived models as a data source for Surface3D.
  *
+ * Data is resolved asynchronously whenever the mapping or the model changes.
+ * QSurfaceDataProxy::arrayReset() is emitted when the data has been resolved.
+ *
  * Usage example:
  *
  * \snippet doc_src_qmldatavisualization.cpp 9