diff options
author | Miikka Heikkinen <miikka.heikkinen@digia.com> | 2013-10-03 10:41:45 +0300 |
---|---|---|
committer | Miikka Heikkinen <miikka.heikkinen@digia.com> | 2013-10-03 11:57:09 +0300 |
commit | eca4f57c854874ec6e4f616e663b43675d76cff4 (patch) | |
tree | 247d319a8ef8b0107d744658384d91de300c496e /src/datavisualization/data | |
parent | 838e5d59a1a1f83049fb5d226a7def1639298054 (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')
14 files changed, 162 insertions, 25 deletions
diff --git a/src/datavisualization/data/qabstractdataproxy.cpp b/src/datavisualization/data/qabstractdataproxy.cpp index 9267e93e..8ccb0d7a 100644 --- a/src/datavisualization/data/qabstractdataproxy.cpp +++ b/src/datavisualization/data/qabstractdataproxy.cpp @@ -28,12 +28,19 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \since 1.0.0 * * You use the visualization type specific inherited classes instead of the base class. - * \sa QBarDataProxy, QScatterDataProxy, QSurfaceDataProxy + * \sa QBarDataProxy, QScatterDataProxy, QSurfaceDataProxy, {Qt Data Visualization Data Handling} */ /*! * \qmltype AbstractDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QAbstractDataProxy + * \brief Base type for all QtDataVisualization data proxies. + * + * This type is uncreatable, but contains properties that are exposed via subtypes. + * \sa BarDataProxy, ScatterDataProxy, SurfaceDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qbardataproxy.cpp b/src/datavisualization/data/qbardataproxy.cpp index f1f36638..2ec38980 100644 --- a/src/datavisualization/data/qbardataproxy.cpp +++ b/src/datavisualization/data/qbardataproxy.cpp @@ -24,7 +24,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QBarDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DBars. + * \brief Base proxy class for Q3DBars. * \since 1.0.0 * * QBarDataProxy handles adding, inserting, changing and removing rows of data. @@ -68,14 +68,26 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * For example: * \snippet doc_src_qtdatavisualization.cpp 1 + * + * \sa {Qt Data Visualization Data Handling} */ /*! * \qmltype BarDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QBarDataProxy * \inherits AbstractDataProxy + * \brief Base proxy type for Bars3D. * * This type handles adding, inserting, changing and removing rows of data with Qt Quick 2. + * + * This type is uncreatable, but contains properties that are exposed via subtypes. + * + * For more complete description, see QBarDataProxy. + * + * \sa ItemModelBarDataProxy, {Qt Data Visualization Data Handling} */ /*! 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} */ /*! diff --git a/src/datavisualization/data/qitemmodelbardatamapping.cpp b/src/datavisualization/data/qitemmodelbardatamapping.cpp index 6a60ff1e..83d6c784 100644 --- a/src/datavisualization/data/qitemmodelbardatamapping.cpp +++ b/src/datavisualization/data/qitemmodelbardatamapping.cpp @@ -23,7 +23,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelBarDataMapping * \inmodule QtDataVisualization - * \brief Data model mapping for Q3DBars. + * \brief Item model mapping for Q3DBars. * \since 1.0.0 * * QItemModelBarDataMapping is used to map roles of QAbstractItemModel to rows, columns, and values @@ -50,12 +50,16 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qtdatavisualization.cpp 3 * - * \sa QItemModelBarDataProxy + * \sa QItemModelBarDataProxy, {Qt Data Visualization Data Handling} */ /*! * \qmltype BarDataMapping + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelBarDataMapping + * \brief Item model mapping for Bars3D. * * This type is used to map roles of AbstractItemModel to rows, columns, and values of Bars3D. For * more complete description, see QItemModelBarDataMapping. @@ -64,7 +68,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 4 * - * \sa ItemModelBarDataProxy + * \sa ItemModelBarDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qitemmodelbardataproxy.cpp b/src/datavisualization/data/qitemmodelbardataproxy.cpp index 7c989aef..85fd8bf9 100644 --- a/src/datavisualization/data/qitemmodelbardataproxy.cpp +++ b/src/datavisualization/data/qitemmodelbardataproxy.cpp @@ -25,20 +25,24 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelBarDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DBars data model mapping. + * \brief Proxy class for presenting data in item models with Q3DBars. * \since 1.0.0 * * QItemModelBarDataProxy allows you to use QAbstractItemModel derived models as a data source * for Q3DBars. It uses QItemModelBarDataMapping instance to map data from the model to Q3DBars * graph. * - * \sa QItemModelBarDataMapping + * \sa QItemModelBarDataMapping, {Qt Data Visualization Data Handling} */ /*! * \qmltype ItemModelBarDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelBarDataProxy * \inherits BarDataProxy + * \brief Proxy class for presenting data in item models with Bars3D. * * This type allows you to use AbstractItemModel derived models as a data source for Bars3D. * @@ -46,7 +50,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 7 * - * \sa BarDataProxy, BarDataMapping + * \sa BarDataProxy, BarDataMapping, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qitemmodelscatterdatamapping.cpp b/src/datavisualization/data/qitemmodelscatterdatamapping.cpp index 4b2be700..7ffd44f9 100644 --- a/src/datavisualization/data/qitemmodelscatterdatamapping.cpp +++ b/src/datavisualization/data/qitemmodelscatterdatamapping.cpp @@ -23,7 +23,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelScatterDataMapping * \inmodule QtDataVisualization - * \brief Data model mapping for Q3DScatter. + * \brief Item model mapping for Q3DScatter. * \since 1.0.0 * * QItemModelScatterDataMapping is used to map roles of QAbstractItemModel to the XYZ-values @@ -39,12 +39,16 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qtdatavisualization.cpp 4 * - * \sa QItemModelScatterDataProxy + * \sa QItemModelScatterDataProxy, {Qt Data Visualization Data Handling} */ /*! * \qmltype ScatterDataMapping + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelScatterDataMapping + * \brief Item model mapping for Scatter3D. * * This type is used to map roles of AbstractItemModel to the XYZ-values of Scatter3D points. For * more complete description, see QItemModelScatterDataMapping. @@ -53,7 +57,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 5 * - * \sa ItemModelScatterDataProxy + * \sa ItemModelScatterDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp index df94483a..7527f87e 100644 --- a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp +++ b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp @@ -25,17 +25,23 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelScatterDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DScatter data model mapping. + * \brief Proxy class for presenting data in item models with Q3DScatter. * \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. + * + * /sa {Qt Data Visualization Data Handling} */ /*! * \qmltype ItemModelScatterDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelScatterDataProxy * \inherits ScatterDataProxy + * \brief Proxy class for presenting data in item models with Scatter3D. * * This type allows you to use AbstractItemModel derived models as a data source for Scatter3D. * @@ -43,7 +49,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 8 * - * \sa ScatterDataProxy, ScatterDataMapping + * \sa ScatterDataProxy, ScatterDataMapping, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp b/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp index 27df0309..0b7c74c9 100644 --- a/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp +++ b/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp @@ -23,7 +23,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelSurfaceDataMapping * \inmodule QtDataVisualization - * \brief Data model mapping for Q3DSurface. + * \brief Item model mapping for Q3DSurface. * \since 1.0.0 * * QItemModelSurfaceDataMapping is used to map roles of QAbstractItemModel to rows, columns, and values @@ -51,12 +51,16 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qtdatavisualization.cpp 5 * - * \sa QItemModelSurfaceDataProxy + * \sa QItemModelSurfaceDataProxy, {Qt Data Visualization Data Handling} */ /*! * \qmltype SurfaceDataMapping + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelSurfaceDataMapping + * \brief Item model mapping for Surface3D. * * This type is used to map roles of AbstractItemModel to rows, columns, and values of Surface3D. * For more complete description, see QItemModelSurfaceDataMapping. @@ -65,7 +69,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 6 * - * \sa ItemModelSurfaceDataProxy + * \sa ItemModelSurfaceDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp index 77eb571a..22271c2e 100644 --- a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp +++ b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp @@ -27,17 +27,23 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QItemModelSurfaceDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DSurface data model mapping. + * \brief Proxy class for presenting data in item models with Q3DSurface. * \since 1.0.0 * * 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. + * + * /sa {Qt Data Visualization Data Handling} */ /*! * \qmltype ItemModelSurfaceDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QItemModelSurfaceDataProxy * \inherits SurfaceDataProxy + * \brief Proxy class for presenting data in item models with Surface3D. * * This type allows you to use AbstractItemModel derived models as a data source for Surface3D. * @@ -45,7 +51,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * \snippet doc_src_qmldatavisualization.cpp 9 * - * \sa SurfaceDataProxy, SurfaceDataMapping + * \sa SurfaceDataProxy, SurfaceDataMapping, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qscatterdataitem.cpp b/src/datavisualization/data/qscatterdataitem.cpp index 3de5bbd7..055a9dad 100644 --- a/src/datavisualization/data/qscatterdataitem.cpp +++ b/src/datavisualization/data/qscatterdataitem.cpp @@ -93,6 +93,36 @@ QScatterDataItem &QScatterDataItem::operator=(const QScatterDataItem &other) * \return position of this data item. */ +/*! + * \fn void QScatterDataItem::setX(float value) + * Sets the X component of the item position to the \a value. + */ + +/*! + * \fn void QScatterDataItem::setY(float value) + * Sets the Y component of the item position to the \a value. + */ + +/*! + * \fn void QScatterDataItem::setZ(float value) + * Sets the Z component of the item position to the \a value. + */ + +/*! + * \fn float QScatterDataItem::x() const + * \return the X component of the position of this data item. + */ + +/*! + * \fn float QScatterDataItem::y() const + * \return the Y component of the position of this data item. + */ + +/*! + * \fn float QScatterDataItem::z() const + * \return the Z component of the position of this data item. + */ + //void QScatterDataItem::setSize(qreal size) //{ // m_size = size; diff --git a/src/datavisualization/data/qscatterdataproxy.cpp b/src/datavisualization/data/qscatterdataproxy.cpp index 50328d1a..4d83da8d 100644 --- a/src/datavisualization/data/qscatterdataproxy.cpp +++ b/src/datavisualization/data/qscatterdataproxy.cpp @@ -24,7 +24,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \class QScatterDataProxy * \inmodule QtDataVisualization - * \brief Proxy class for Q3DScatter. + * \brief Base proxy class for Q3DScatter. * \since 1.0.0 * * QScatterDataProxy handles adding, inserting, changing and removing data items. @@ -52,14 +52,26 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * For example: * \snippet doc_src_qtdatavisualization.cpp 2 + * + * /sa {Qt Data Visualization Data Handling} */ /*! * \qmltype ScatterDataProxy + * \inqmlmodule com.digia.QtDataVisualization 1.0 + * \since com.digia.QtDataVisualization 1.0 + * \ingroup datavisualization_qml * \instantiates QScatterDataProxy * \inherits AbstractDataProxy + * \brief Base proxy class for Scatter3D. * * This type handles adding, inserting, changing and removing data items. + * + * This type is uncreatable, but contains properties that are exposed via subtypes. + * + * For more complete description, see QScatterDataProxy. + * + * \sa ItemModelScatterDataProxy, {Qt Data Visualization Data Handling} */ /*! diff --git a/src/datavisualization/data/qsurfacedataitem.cpp b/src/datavisualization/data/qsurfacedataitem.cpp index 3fb21c95..19f8f347 100644 --- a/src/datavisualization/data/qsurfacedataitem.cpp +++ b/src/datavisualization/data/qsurfacedataitem.cpp @@ -94,6 +94,36 @@ QSurfaceDataItem &QSurfaceDataItem::operator=(const QSurfaceDataItem &other) */ /*! + * \fn void QSurfaceDataItem::setX(float value) + * Sets the X component of the item position to the \a value. + */ + +/*! + * \fn void QSurfaceDataItem::setY(float value) + * Sets the Y component of the item position to the \a value. + */ + +/*! + * \fn void QSurfaceDataItem::setZ(float value) + * Sets the Z component of the item position to the \a value. + */ + +/*! + * \fn float QSurfaceDataItem::x() const + * \return the X component of the position of this data item. + */ + +/*! + * \fn float QSurfaceDataItem::y() const + * \return the Y component of the position of this data item. + */ + +/*! + * \fn float QSurfaceDataItem::z() const + * \return the Z component of the position of this data item. + */ + +/*! * \internal */ void QSurfaceDataItem::createExtraData() 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} */ /*! diff --git a/src/datavisualization/data/qsurfacedataproxy.h b/src/datavisualization/data/qsurfacedataproxy.h index 2aeda80e..460fa437 100644 --- a/src/datavisualization/data/qsurfacedataproxy.h +++ b/src/datavisualization/data/qsurfacedataproxy.h @@ -49,8 +49,6 @@ public: signals: void arrayReset(); - void valueRangeRowsChanged(int min, int max); - void valueRangeColumnsChanged(int min, int max); protected: explicit QSurfaceDataProxy(QSurfaceDataProxyPrivate *d, QObject *parent = 0); |