Doc update: model data proxies + index

Task-number: QTRD-2133

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

7 files changed, 112 insertions, 13 deletions

diff --git a/src/datavis3d/data/qitemmodelbardataproxy.cpp b/src/datavis3d/data/qitemmodelbardataproxy.cpp
index 17e4d0cc..28f9e84a 100644
--- a/src/datavis3d/data/qitemmodelbardataproxy.cpp
+++ b/src/datavis3d/data/qitemmodelbardataproxy.cpp
@@ -21,11 +21,28 @@
 
 QT_DATAVIS3D_BEGIN_NAMESPACE
 
+/*!
+ * \class QItemModelBarDataProxy
+ * \inmodule QtDataVis3D
+ * \brief Proxy class for Q3DBars data model mapping.
+ * \since 1.0.0
+ *
+ * QItemModelBarDataProxy allows you to use QAbstractItemModel derived models as a data source
+ * for Q3DBars. It maps roles defined in QItemModelBarDataMapping to roles in the model.
+ */
+
+/*!
+ * Constructs QItemModelBarDataProxy.
+ */
 QItemModelBarDataProxy::QItemModelBarDataProxy() :
     QBarDataProxy(new QItemModelBarDataProxyPrivate(this))
 {
 }
 
+/*!
+ * Constructs QItemModelBarDataProxy with \a itemModel and \a mapping. Does not take ownership of
+ * the model or the mapping, but does connect to them to listen for changes.
+ */
 QItemModelBarDataProxy::QItemModelBarDataProxy(QAbstractItemModel *itemModel,
                                                QItemModelBarDataMapping *mapping) :
     QBarDataProxy(new QItemModelBarDataProxyPrivate(this))
@@ -34,10 +51,19 @@ QItemModelBarDataProxy::QItemModelBarDataProxy(QAbstractItemModel *itemModel,
     dptr()->setMapping(mapping);
 }
 
+/*!
+ * Destroys QItemModelBarDataProxy.
+ */
 QItemModelBarDataProxy::~QItemModelBarDataProxy()
 {
 }
 
+/*!
+ * \property QItemModelBarDataProxy::itemModel
+ *
+ * Defines item model. Does not take ownership of the model, but does connect to it to listen for
+ * changes.
+ */
 void QItemModelBarDataProxy::setItemModel(QAbstractItemModel *itemModel)
 {
     dptr()->setItemModel(itemModel);
@@ -48,6 +74,12 @@ QAbstractItemModel *QItemModelBarDataProxy::itemModel()
     return dptr()->m_itemModel.data();
 }
 
+/*!
+ * \property QItemModelBarDataProxy::mapping
+ *
+ * Defines data mapping. Does not take ownership of the mapping, but does connect to it to listen
+ * for changes. Modifying a mapping that is set to the proxy will trigger data set re-resolving.
+ */
 void QItemModelBarDataProxy::setMapping(QItemModelBarDataMapping *mapping)
 {
     dptr()->setMapping(mapping);
@@ -58,6 +90,9 @@ QItemModelBarDataMapping *QItemModelBarDataProxy::mapping()
     return dptr()->m_mapping.data();
 }
 
+/*!
+ * \internal
+ */
 QItemModelBarDataProxyPrivate *QItemModelBarDataProxy::dptr()
 {
     return static_cast<QItemModelBarDataProxyPrivate *>(d_ptr.data());
diff --git a/src/datavis3d/data/qitemmodelbardataproxy.h b/src/datavis3d/data/qitemmodelbardataproxy.h
index 1d60bed6..660ed37d 100644
--- a/src/datavis3d/data/qitemmodelbardataproxy.h
+++ b/src/datavis3d/data/qitemmodelbardataproxy.h
@@ -31,19 +31,17 @@ class QItemModelBarDataProxyPrivate;
 class QT_DATAVIS3D_EXPORT QItemModelBarDataProxy : public QBarDataProxy
 {
     Q_OBJECT
+    Q_PROPERTY(QAbstractItemModel* itemModel READ itemModel WRITE setItemModel)
+    Q_PROPERTY(QItemModelBarDataMapping* mapping READ mapping WRITE setMapping)
 
 public:
     explicit QItemModelBarDataProxy();
     explicit QItemModelBarDataProxy(QAbstractItemModel *itemModel, QItemModelBarDataMapping *mapping);
     virtual ~QItemModelBarDataProxy();
 
-    // Doesn't gain ownership of the model, but does connect to it to listen for data changes.
     void setItemModel(QAbstractItemModel *itemModel);
     QAbstractItemModel *itemModel();
 
-    // Map bars role (row, column, value) to role in model.
-    // Doesn't gain ownership of mapping, but does connect to it to listen for mapping changes.
-    // Modifying mapping that is set to proxy will trigger dataset re-resolving.
     void setMapping(QItemModelBarDataMapping *mapping);
     QItemModelBarDataMapping *mapping();
 
diff --git a/src/datavis3d/data/qitemmodelmapdataproxy.cpp b/src/datavis3d/data/qitemmodelmapdataproxy.cpp
index a222a68f..5a4e5a05 100644
--- a/src/datavis3d/data/qitemmodelmapdataproxy.cpp
+++ b/src/datavis3d/data/qitemmodelmapdataproxy.cpp
@@ -21,11 +21,28 @@
 
 QT_DATAVIS3D_BEGIN_NAMESPACE
 
+/*!
+ * \class QItemModelMapDataProxy
+ * \inmodule QtDataVis3D
+ * \brief Proxy class for Q3DMaps data model mapping.
+ * \since 1.0.0
+ *
+ * QItemModelMapDataProxy allows you to use QAbstractItemModel derived models as a data source
+ * for Q3DMaps. It maps roles defined in QItemModelMapDataMapping to roles in the model.
+ */
+
+/*!
+ * Constructs QItemModelMapDataProxy.
+ */
 QItemModelMapDataProxy::QItemModelMapDataProxy() :
     QMapDataProxy(new QItemModelMapDataProxyPrivate(this))
 {
 }
 
+/*!
+ * Constructs QItemModelMapDataProxy with \a itemModel and \a mapping. Does not take ownership of
+ * the model or the mapping, but does connect to them to listen for changes.
+ */
 QItemModelMapDataProxy::QItemModelMapDataProxy(QAbstractItemModel *itemModel,
                                                QItemModelMapDataMapping *mapping) :
     QMapDataProxy(new QItemModelMapDataProxyPrivate(this))
@@ -34,10 +51,19 @@ QItemModelMapDataProxy::QItemModelMapDataProxy(QAbstractItemModel *itemModel,
     dptr()->setMapping(mapping);
 }
 
+/*!
+ * Destroys QItemModelMapDataProxy.
+ */
 QItemModelMapDataProxy::~QItemModelMapDataProxy()
 {
 }
 
+/*!
+ * \property QItemModelMapDataProxy::itemModel
+ *
+ * Defines item model. Does not take ownership of the model, but does connect to it to listen for
+ * changes.
+ */
 void QItemModelMapDataProxy::setItemModel(QAbstractItemModel *itemModel)
 {
     dptr()->setItemModel(itemModel);
@@ -48,6 +74,12 @@ QAbstractItemModel *QItemModelMapDataProxy::itemModel()
     return dptr()->m_itemModel.data();
 }
 
+/*!
+ * \property QItemModelMapDataProxy::mapping
+ *
+ * Defines data mapping. Does not take ownership of the mapping, but does connect to it to listen
+ * for changes. Modifying a mapping that is set to the proxy will trigger data set re-resolving.
+ */
 void QItemModelMapDataProxy::setMapping(QItemModelMapDataMapping *mapping)
 {
     dptr()->setMapping(mapping);
@@ -58,6 +90,9 @@ QItemModelMapDataMapping *QItemModelMapDataProxy::mapping()
     return dptr()->m_mapping.data();
 }
 
+/*!
+ * \internal
+ */
 QItemModelMapDataProxyPrivate *QItemModelMapDataProxy::dptr()
 {
     return static_cast<QItemModelMapDataProxyPrivate *>(d_ptr.data());
diff --git a/src/datavis3d/data/qitemmodelmapdataproxy.h b/src/datavis3d/data/qitemmodelmapdataproxy.h
index 784ee162..d5b3cb59 100644
--- a/src/datavis3d/data/qitemmodelmapdataproxy.h
+++ b/src/datavis3d/data/qitemmodelmapdataproxy.h
@@ -31,19 +31,17 @@ class QItemModelMapDataProxyPrivate;
 class QT_DATAVIS3D_EXPORT QItemModelMapDataProxy : public QMapDataProxy
 {
     Q_OBJECT
+    Q_PROPERTY(QAbstractItemModel* itemModel READ itemModel WRITE setItemModel)
+    Q_PROPERTY(QItemModelMapDataMapping* mapping READ mapping WRITE setMapping)
 
 public:
     explicit QItemModelMapDataProxy();
     explicit QItemModelMapDataProxy(QAbstractItemModel *itemModel, QItemModelMapDataMapping *mapping);
     virtual ~QItemModelMapDataProxy();
 
-    // Doesn't gain ownership of the model, but does connect to it to listen for data changes.
     void setItemModel(QAbstractItemModel *itemModel);
     QAbstractItemModel *itemModel();
 
-    // Map maps role (label, xPos, yPos, value) to role in model
-    // Doesn't gain ownership of mapping, but does connect to it to listen for mapping changes.
-    // Modifying mapping that is set to proxy will trigger dataset re-resolving.
     void setMapping(QItemModelMapDataMapping *mapping);
     QItemModelMapDataMapping *mapping();
 
diff --git a/src/datavis3d/data/qitemmodelscatterdataproxy.cpp b/src/datavis3d/data/qitemmodelscatterdataproxy.cpp
index 2bc67d39..b883f75b 100644
--- a/src/datavis3d/data/qitemmodelscatterdataproxy.cpp
+++ b/src/datavis3d/data/qitemmodelscatterdataproxy.cpp
@@ -21,11 +21,28 @@
 
 QT_DATAVIS3D_BEGIN_NAMESPACE
 
+/*!
+ * \class QItemModelScatterDataProxy
+ * \inmodule QtDataVis3D
+ * \brief Proxy class for Q3DScatter data model mapping.
+ * \since 1.0.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.
+ */
+
+/*!
+ * Constructs QItemModelScatterDataProxy.
+ */
 QItemModelScatterDataProxy::QItemModelScatterDataProxy() :
     QScatterDataProxy(new QItemModelScatterDataProxyPrivate(this))
 {
 }
 
+/*!
+ * Constructs QItemModelScatterDataProxy with \a itemModel and \a mapping. Does not take ownership
+ * of the model or the mapping, but does connect to them to listen for changes.
+ */
 QItemModelScatterDataProxy::QItemModelScatterDataProxy(QAbstractItemModel *itemModel,
                                                        QItemModelScatterDataMapping *mapping) :
     QScatterDataProxy(new QItemModelScatterDataProxyPrivate(this))
@@ -34,10 +51,19 @@ QItemModelScatterDataProxy::QItemModelScatterDataProxy(QAbstractItemModel *itemM
     dptr()->setMapping(mapping);
 }
 
+/*!
+ * Destroys QItemModelScatterDataProxy.
+ */
 QItemModelScatterDataProxy::~QItemModelScatterDataProxy()
 {
 }
 
+/*!
+ * \property QItemModelScatterDataProxy::itemModel
+ *
+ * Defines item model. Does not take ownership of the model, but does connect to it to listen for
+ * changes.
+ */
 void QItemModelScatterDataProxy::setItemModel(QAbstractItemModel *itemModel)
 {
     dptr()->setItemModel(itemModel);
@@ -48,6 +74,12 @@ QAbstractItemModel *QItemModelScatterDataProxy::itemModel()
     return dptr()->m_itemModel.data();
 }
 
+/*!
+ * \property QItemModelScatterDataProxy::mapping
+ *
+ * Defines data mapping. Does not take ownership of the mapping, but does connect to it to listen
+ * for changes. Modifying a mapping that is set to the proxy will trigger data set re-resolving.
+ */
 void QItemModelScatterDataProxy::setMapping(QItemModelScatterDataMapping *mapping)
 {
     dptr()->setMapping(mapping);
@@ -58,6 +90,9 @@ QItemModelScatterDataMapping *QItemModelScatterDataProxy::mapping()
     return dptr()->m_mapping.data();
 }
 
+/*!
+ * \internal
+ */
 QItemModelScatterDataProxyPrivate *QItemModelScatterDataProxy::dptr()
 {
     return static_cast<QItemModelScatterDataProxyPrivate *>(d_ptr.data());
diff --git a/src/datavis3d/data/qitemmodelscatterdataproxy.h b/src/datavis3d/data/qitemmodelscatterdataproxy.h
index f609e84b..3389c874 100644
--- a/src/datavis3d/data/qitemmodelscatterdataproxy.h
+++ b/src/datavis3d/data/qitemmodelscatterdataproxy.h
@@ -31,6 +31,8 @@ class QItemModelScatterDataProxyPrivate;
 class QT_DATAVIS3D_EXPORT QItemModelScatterDataProxy : public QScatterDataProxy
 {
     Q_OBJECT
+    Q_PROPERTY(QAbstractItemModel* itemModel READ itemModel WRITE setItemModel)
+    Q_PROPERTY(QItemModelScatterDataMapping* mapping READ mapping WRITE setMapping)
 
 public:
     explicit QItemModelScatterDataProxy();
@@ -38,13 +40,9 @@ public:
                                         QItemModelScatterDataMapping *mapping);
     virtual ~QItemModelScatterDataProxy();
 
-    // Doesn't gain ownership of the model, but does connect to it to listen for data changes.
     void setItemModel(QAbstractItemModel *itemModel);
     QAbstractItemModel *itemModel();
 
-    // Map scatter role (xPos, yPos, zPos) to role in model
-    // Doesn't gain ownership of mapping, but does connect to it to listen for mapping changes.
-    // Modifying mapping that is set to proxy will trigger dataset re-resolving.
     void setMapping(QItemModelScatterDataMapping *mapping);
     QItemModelScatterDataMapping *mapping();
 
diff --git a/src/datavis3d/doc/src/qtdatavis3d-index.qdoc b/src/datavis3d/doc/src/qtdatavis3d-index.qdoc
index dae2a14d..a199bbe5 100644
--- a/src/datavis3d/doc/src/qtdatavis3d-index.qdoc
+++ b/src/datavis3d/doc/src/qtdatavis3d-index.qdoc
@@ -31,7 +31,7 @@
 
     \snippet doc_src_qtdatavis3d.cpp 0
 
-    To link against the module, add this line to your \l qmake \c
+    To link against the module, add this line to your qmake \c
     .pro file:
 
     \snippet doc_src_qtdatavis3d.pro 0