summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
diff options
context:
space:
mode:
authorMiikka Heikkinen <miikka.heikkinen@digia.com>2013-10-03 10:41:45 +0300
committerMiikka Heikkinen <miikka.heikkinen@digia.com>2013-10-03 11:57:09 +0300
commiteca4f57c854874ec6e4f616e663b43675d76cff4 (patch)
tree247d319a8ef8b0107d744658384d91de300c496e /src/datavisualization/data/qheightmapsurfacedataproxy.cpp
parent838e5d59a1a1f83049fb5d226a7def1639298054 (diff)
Improve documentation
+QML types now in their own group +Overview improved, though some linked pages are still just stubs +Some missing documentation added +Some needed tags added to qml type documentations +Removed license page +Fixed lisence footer Change-Id: Ic5e3d922cd5caf9f23294aea6f0e5d2ac493ae63 Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>
Diffstat (limited to 'src/datavisualization/data/qheightmapsurfacedataproxy.cpp')
-rw-r--r--src/datavisualization/data/qheightmapsurfacedataproxy.cpp12
1 files changed, 10 insertions, 2 deletions
diff --git a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
index 7c8f9fce..518e69eb 100644
--- a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
@@ -27,7 +27,7 @@ const float defaultMaxValue = 10.0f;
/*!
* \class QHeightMapSurfaceDataProxy
* \inmodule QtDataVisualization
- * \brief Proxy class for Q3DSurface.
+ * \brief Base proxy class for Q3DSurface.
* \since 1.0.0
*
* QHeightMapSurfaceDataProxy takes care of surface related height map data handling. It provides a
@@ -38,16 +38,24 @@ const float defaultMaxValue = 10.0f;
* to image horizontal direction and Z-value to the vertical. Setting any of these
* properties triggers asynchronous re-resolving of any existing height map.
*
- * \sa QSurfaceDataProxy
+ * \sa QSurfaceDataProxy, {Qt Data Visualization Data Handling}
*/
/*!
* \qmltype HeightMapSurfaceDataProxy
+ * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \since com.digia.QtDataVisualization 1.0
+ * \ingroup datavisualization_qml
* \instantiates QHeightMapSurfaceDataProxy
* \inherits SurfaceDataProxy
+ * \brief Base proxy type for Surface3D.
*
* HeightMapSurfaceDataProxy takes care of surface related height map data handling. It provides a
* way for giving the surface plot a height map to be visualized.
+ *
+ * For more complete description, see QHeightMapSurfaceDataProxy.
+ *
+ * \sa {Qt Data Visualization Data Handling}
*/
/*!