summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/data/qsurfacedataproxy.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/qsurfacedataproxy.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/qsurfacedataproxy.cpp')
-rw-r--r--src/datavisualization/data/qsurfacedataproxy.cpp16
1 files changed, 14 insertions, 2 deletions
diff --git a/src/datavisualization/data/qsurfacedataproxy.cpp b/src/datavisualization/data/qsurfacedataproxy.cpp
index f1351521..72f33de7 100644
--- a/src/datavisualization/data/qsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qsurfacedataproxy.cpp
@@ -24,7 +24,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
/*!
* \class QSurfaceDataProxy
* \inmodule QtDataVisualization
- * \brief Proxy class for Q3DSurface.
+ * \brief Base proxy class for Q3DSurface.
* \since 1.0.0
*
* QSurfaceDataProxy takes care of surface related data handling. The QSurfaceDataProxy handles the data
@@ -61,14 +61,26 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* see \l{Q3DValueAxis::setLabelFormat()} for more information.
* \endtable
*
+ * \sa {Qt Data Visualization Data Handling}
*/
/*!
* \qmltype SurfaceDataProxy
+ * \inqmlmodule com.digia.QtDataVisualization 1.0
+ * \since com.digia.QtDataVisualization 1.0
+ * \ingroup datavisualization_qml
* \instantiates QSurfaceDataProxy
* \inherits AbstractDataProxy
+ * \brief Base proxy class for Surface3D.
*
- * DOCUMENTATION GOES HERE TOO
+ * This type handles surface data items. The data is arranged into rows and columns, and all rows must have
+ * the same number of columns.
+ *
+ * This type is uncreatable, but contains properties that are exposed via subtypes.
+ *
+ * For more complete description, see QSurfaceDataProxy.
+ *
+ * \sa ItemModelSurfaceDataProxy, {Qt Data Visualization Data Handling}
*/
/*!