Doc update

Task-number: QTRD-2133

+ bug fixes to existing, skeletons to surface

Change-Id: Ic92294f141435972b2c10a147bab13897ed37f53
Change-Id: Ic92294f141435972b2c10a147bab13897ed37f53
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com>

13 files changed, 71 insertions, 7 deletions

diff --git a/src/datavisualization/data/qabstractdataproxy.cpp b/src/datavisualization/data/qabstractdataproxy.cpp
index 2ef4b614..19eac436 100644
--- a/src/datavisualization/data/qabstractdataproxy.cpp
+++ b/src/datavisualization/data/qabstractdataproxy.cpp
@@ -71,6 +71,8 @@ QAbstractDataProxy::DataType QAbstractDataProxy::type() const
 }
 
 /*!
+ * \property QAbstractDataProxy::itemLabelFormat
+ *
  * Sets label \a format for data items in this proxy. This format is used for single item labels,
  * e.g. when an item is selected. How the format is interpreted depends on proxy type. See
  * each proxy class documentation for more information.
diff --git a/src/datavisualization/data/qbardataitem.cpp b/src/datavisualization/data/qbardataitem.cpp
index e69a5a69..01bcfd1c 100644
--- a/src/datavisualization/data/qbardataitem.cpp
+++ b/src/datavisualization/data/qbardataitem.cpp
@@ -29,7 +29,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  * A QBarDataItem holds data for a single rendered bar in a graph.
  * Bar data proxies parse data into QBarDataItem instances for visualizing.
  *
- * \sa QBarDataProxy, {Qt Data Visualization 3D C++ Classes}
+ * \sa QBarDataProxy, {Qt Data Visualization C++ Classes}
  */
 
 /*!
diff --git a/src/datavisualization/data/qbardataproxy.cpp b/src/datavisualization/data/qbardataproxy.cpp
index 9c30e1b1..85400831 100644
--- a/src/datavisualization/data/qbardataproxy.cpp
+++ b/src/datavisualization/data/qbardataproxy.cpp
@@ -183,6 +183,8 @@ void QBarDataProxy::removeRows(int rowIndex, int removeCount)
 }
 
 /*!
+ * \property QBarDataProxy::rowCount
+ *
  * \return row count in the array.
  */
 int QBarDataProxy::rowCount() const
diff --git a/src/datavisualization/data/qbardataproxy.h b/src/datavisualization/data/qbardataproxy.h
index 8ebaf5ae..78f3d789 100644
--- a/src/datavisualization/data/qbardataproxy.h
+++ b/src/datavisualization/data/qbardataproxy.h
@@ -35,6 +35,7 @@ class QT_DATAVISUALIZATION_EXPORT QBarDataProxy : public QAbstractDataProxy
     Q_OBJECT
 
     Q_PROPERTY(int rowCount READ rowCount)
+
 public:
     explicit QBarDataProxy(QObject *parent = 0);
     virtual ~QBarDataProxy();
diff --git a/src/datavisualization/data/qscatterdataitem.cpp b/src/datavisualization/data/qscatterdataitem.cpp
index 63bb32ec..b331e03b 100644
--- a/src/datavisualization/data/qscatterdataitem.cpp
+++ b/src/datavisualization/data/qscatterdataitem.cpp
@@ -30,7 +30,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  * A QScatterDataItem holds data for a single rendered item in a scatter graph.
  * Scatter data proxies parse data into QScatterDataItem instances for visualizing.
  *
- * \sa QScatterDataProxy, {Qt Data Visualization 3D C++ Classes}
+ * \sa QScatterDataProxy, {Qt Data Visualization C++ Classes}
  */
 
 /*!
diff --git a/src/datavisualization/data/qscatterdataproxy.cpp b/src/datavisualization/data/qscatterdataproxy.cpp
index 134b8a64..27fa3aca 100644
--- a/src/datavisualization/data/qscatterdataproxy.cpp
+++ b/src/datavisualization/data/qscatterdataproxy.cpp
@@ -161,6 +161,8 @@ void QScatterDataProxy::removeItems(int index, int removeCount)
 }
 
 /*!
+ * \property QScatterDataProxy::itemCount
+ *
  * \return item count in the array.
  */
 int QScatterDataProxy::itemCount() const
diff --git a/src/datavisualization/data/qscatterdataproxy.h b/src/datavisualization/data/qscatterdataproxy.h
index a1191c16..178bc900 100644
--- a/src/datavisualization/data/qscatterdataproxy.h
+++ b/src/datavisualization/data/qscatterdataproxy.h
@@ -33,6 +33,7 @@ class QT_DATAVISUALIZATION_EXPORT QScatterDataProxy : public QAbstractDataProxy
     Q_OBJECT
 
     Q_PROPERTY(int itemCount READ itemCount)
+
 public:
     explicit QScatterDataProxy(QObject *parent = 0);
     virtual ~QScatterDataProxy();
diff --git a/src/datavisualization/data/qsurfacedataproxy.cpp b/src/datavisualization/data/qsurfacedataproxy.cpp
index 9fcc4bc8..2bf8af8b 100644
--- a/src/datavisualization/data/qsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qsurfacedataproxy.cpp
@@ -22,6 +22,16 @@
 QT_DATAVISUALIZATION_BEGIN_NAMESPACE
 
 /*!
+ * \class QSurfaceDataProxy
+ * \inmodule QtDataVisualization
+ * \brief Proxy class for Q3DSurface.
+ * \since 1.0.0
+ *
+ * DOCUMENTATION GOES HERE
+ *
+ */
+
+/*!
  * Constructs QSurfaceDataProxy with the given \a parent.
  */
 QSurfaceDataProxy::QSurfaceDataProxy(QObject *parent) :
@@ -44,32 +54,67 @@ QSurfaceDataProxy::~QSurfaceDataProxy()
 {
 }
 
+/*!
+ * Clears the existing array and takes ownership of the \a newArray. Do not use \a newArray pointer
+ * to further modify data after QSurfaceDataProxy assumes ownership of it, as such modifications will
+ * not trigger proper signals.
+ * Passing null array clears all data.
+ */
 void QSurfaceDataProxy::resetArray(QSurfaceDataArray *newArray)
 {
     if (dptr()->resetArray(newArray))
         emit arrayReset();
 }
 
+/*!
+ * \return pointer to the data array.
+ */
 const QSurfaceDataArray *QSurfaceDataProxy::array() const
 {
     return dptrc()->m_dataArray;
 }
 
+/*!
+ * \property QSurfaceDataProxy::itemCount
+ *
+ * \return item count in the array.
+ */
+int QSurfaceDataProxy::itemCount() const
+{
+    return dptrc()->m_dataArray->size();
+}
+
+/*!
+ * \return pointer to the item at \a index. It is guaranteed to be valid only until next call that
+ * modifies data.
+ */
 const QSurfaceDataItem *QSurfaceDataProxy::itemAt(int index) const
 {
     return &dptrc()->m_dataArray->at(index)->at(2);
 }
 
+/*!
+ * \internal
+ */
 QSurfaceDataProxyPrivate *QSurfaceDataProxy::dptr()
 {
     return static_cast<QSurfaceDataProxyPrivate *>(d_ptr.data());
 }
 
+/*!
+ * \internal
+ */
 const QSurfaceDataProxyPrivate *QSurfaceDataProxy::dptrc() const
 {
     return static_cast<const QSurfaceDataProxyPrivate *>(d_ptr.data());
 }
 
+/*!
+ * \fn void QSurfaceDataProxy::arrayReset()
+ *
+ * Emitted when data array is reset.
+ */
+
 //
 //  QSurfaceDataProxyPrivate
 //
diff --git a/src/datavisualization/data/qsurfacedataproxy.h b/src/datavisualization/data/qsurfacedataproxy.h
index 8932574c..7f104c43 100644
--- a/src/datavisualization/data/qsurfacedataproxy.h
+++ b/src/datavisualization/data/qsurfacedataproxy.h
@@ -34,6 +34,8 @@ class QT_DATAVISUALIZATION_EXPORT QSurfaceDataProxy : public QAbstractDataProxy
 {
     Q_OBJECT
 
+    Q_PROPERTY(int itemCount READ itemCount)
+
 public:
     explicit QSurfaceDataProxy(QObject *parent = 0);
     virtual ~QSurfaceDataProxy();
diff --git a/src/datavisualization/engine/q3dbars.cpp b/src/datavisualization/engine/q3dbars.cpp
index e6832d87..ee741aed 100644
--- a/src/datavisualization/engine/q3dbars.cpp
+++ b/src/datavisualization/engine/q3dbars.cpp
@@ -85,7 +85,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  * proxy. If any other proxy is set as active data proxy later, the default proxy and all data
  * added to it is destroyed.
  *
- * \sa Q3DScatter, Q3DSurface, {Qt Data Visualization 3D C++ Classes}
+ * \sa Q3DScatter, Q3DSurface, {Qt Data Visualization C++ Classes}
  */
 
 /*!
diff --git a/src/datavisualization/engine/q3dscatter.cpp b/src/datavisualization/engine/q3dscatter.cpp
index b9e74a22..e9f467f6 100644
--- a/src/datavisualization/engine/q3dscatter.cpp
+++ b/src/datavisualization/engine/q3dscatter.cpp
@@ -77,7 +77,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  * proxy. If any other proxy is set as active data proxy later, the default proxy and all data
  * added to it is destroyed.
  *
- * \sa Q3DBars, Q3DSurface, {Qt Data Visualization 3D C++ Classes}
+ * \sa Q3DBars, Q3DSurface, {Qt Data Visualization C++ Classes}
  */
 
 /*!
diff --git a/src/datavisualization/engine/q3dsurface.cpp b/src/datavisualization/engine/q3dsurface.cpp
index 0dfc4c93..647d761a 100644
--- a/src/datavisualization/engine/q3dsurface.cpp
+++ b/src/datavisualization/engine/q3dsurface.cpp
@@ -23,10 +23,19 @@
 
 #include <QMouseEvent>
 
-#include <QDebug>
-
 QT_DATAVISUALIZATION_BEGIN_NAMESPACE
 
+/*!
+ * \class Q3DSurface
+ * \inmodule QtDataVisualization
+ * \brief The Q3DSurface class provides methods for rendering 3D surface plots.
+ * \since 1.0.0
+ *
+ * DOCUMENTATION GOES HERE
+ *
+ * \sa Q3DBars, Q3DScatter, {Qt Data Visualization C++ Classes}
+ */
+
 Q3DSurface::Q3DSurface()
     : d_ptr(new Q3DSurfacePrivate(this, geometry()))
 {
diff --git a/src/datavisualization/engine/q3dwindow.cpp b/src/datavisualization/engine/q3dwindow.cpp
index 4bd40b04..34bbdf05 100644
--- a/src/datavisualization/engine/q3dwindow.cpp
+++ b/src/datavisualization/engine/q3dwindow.cpp
@@ -38,7 +38,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
  * 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.
  *
- * \sa Q3DBars, Q3DScatter, Q3DSurface, {Qt Data Visualization 3D C++ Classes}
+ * \sa Q3DBars, Q3DScatter, Q3DSurface, {Qt Data Visualization C++ Classes}
  */
 
 /*!