summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2017-03-24 16:54:38 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2017-03-27 07:48:25 +0000
commit1a4d36afc821d745fe304f222e73d6c2fa249afa (patch)
tree2c0e2fc2b8a94e96eee272d457505b38417ccdab
parent730683467deed28e6bd28d45d39bdf38cd57f29b (diff)
Doc: Edit the series docs for grammar and stylev5.9.0-beta1
Change-Id: I9b03e4e3cf600fa68a4d7f0372b0fba676affb65 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
-rw-r--r--src/datavisualization/data/qabstract3dseries.cpp82
-rw-r--r--src/datavisualization/data/qbar3dseries.cpp49
-rw-r--r--src/datavisualization/data/qscatter3dseries.cpp55
-rw-r--r--src/datavisualization/data/qsurface3dseries.cpp62
4 files changed, 133 insertions, 115 deletions
diff --git a/src/datavisualization/data/qabstract3dseries.cpp b/src/datavisualization/data/qabstract3dseries.cpp
index c24ece86..42579f62 100644
--- a/src/datavisualization/data/qabstract3dseries.cpp
+++ b/src/datavisualization/data/qabstract3dseries.cpp
@@ -36,11 +36,13 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \class QAbstract3DSeries
* \inmodule QtDataVisualization
- * \brief Base class for all QtDataVisualization series.
+ * \brief The QAbstract3DSeries class is a base class for all data series.
* \since QtDataVisualization 1.0
*
- * You use the visualization type specific inherited classes instead of the base class.
- * \sa QBar3DSeries, QScatter3DSeries, QSurface3DSeries, {Qt Data Visualization Data Handling}
+ * There are inherited classes for each supported series type: QBar3DSeries,
+ * QScatter3DSeries, and QSurface3DSeries.
+ *
+ * For more information, see \l{Qt Data Visualization Data Handling}.
*/
/*!
@@ -59,13 +61,12 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* \since QtDataVisualization 1.0
* \ingroup datavisualization_qml
* \instantiates QAbstract3DSeries
- * \brief Base type for all QtDataVisualization series.
- *
- * This type is uncreatable, but contains properties that are exposed via subtypes.
+ * \brief A base type for all data series.
*
- * For Abstract3DSeries enums, see \l QAbstract3DSeries::SeriesType and \l{QAbstract3DSeries::Mesh}.
+ * This type is uncreatable, but contains properties that are exposed via the
+ * following subtypes: Bar3DSeries, Scatter3DSeries, and Surface3DSeries.
*
- * \sa Bar3DSeries, Scatter3DSeries, Surface3DSeries, {Qt Data Visualization Data Handling}
+ * For more information, see \l{Qt Data Visualization Data Handling}.
*/
/*!
@@ -112,21 +113,22 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* Arrow pointing upwards.
* \value MeshPoint
* 2D point. Usable only with Q3DScatter.
- * \b Note: Shadows do not affect this style. Color style Q3DTheme::ColorStyleObjectGradient
+ * Shadows do not affect this style. Color style Q3DTheme::ColorStyleObjectGradient
* is not supported by this style.
*/
/*!
* \qmlproperty Abstract3DSeries.SeriesType Abstract3DSeries::type
- * The type of the series.
+ * The type of the series. One of the QAbstract3DSeries::SeriesType values.
+ *
*/
/*!
* \qmlproperty string Abstract3DSeries::itemLabelFormat
*
* The label format for data items in this series. This format is used for single item labels,
- * for example, when an item is selected. How the format is interpreted depends on series type. See
- * each series class documentation for more information.
+ * for example, when an item is selected. How the format is interpreted depends
+ * on series type: Bar3DSeries, Scatter3DSeries, Surface3DSeries.
*/
/*!
@@ -141,13 +143,15 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* Surface3DSeries. If the mesh is \l{QAbstract3DSeries::MeshUserDefined}{Abstract3DSeries.MeshUserDefined},
* then the userDefinedMesh property must also be set for items to render properly.
* The default value depends on the graph type.
+ *
+ * \sa QAbstract3DSeries::Mesh
*/
/*!
* \qmlproperty bool Abstract3DSeries::meshSmooth
*
* If \c true, smooth versions of predefined meshes set via the \l mesh property are used.
- * This property doesn't affect custom meshes used when mesh is
+ * This property does not affect custom meshes used when the mesh is set to
* \l{QAbstract3DSeries::MeshUserDefined}{Abstract3DSeries.MeshUserDefined}.
* Defaults to \c{false}.
*/
@@ -159,7 +163,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* The rotation should be a normalized quaternion.
* For those series types that support item specific rotation, the rotations are
* multiplied together.
- * Bar3DSeries ignores any rotation that is not around Y-axis.
+ * Bar3DSeries ignores any rotation that is not around the y-axis.
* Surface3DSeries applies the rotation only to the selection pointer.
* Defaults to no rotation.
*/
@@ -167,10 +171,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty string Abstract3DSeries::userDefinedMesh
*
- * Sets the filename for user defined custom mesh for objects that is used when \l mesh
+ * Sets the filename for a user defined custom mesh for objects that is used when \l mesh
* is \l{QAbstract3DSeries::MeshUserDefined}{Abstract3DSeries.MeshUserDefined}.
- * \note The file needs to be in Wavefront obj format and include
- * vertices, normals and UVs. It also needs to be in triangles.
+ * \note The file needs to be in the Wavefront OBJ format and include
+ * vertices, normals, and UVs. It also needs to be in triangles.
*/
/*!
@@ -182,7 +186,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
*/
/*!
- * \qmlproperty Color Abstract3DSeries::baseColor
+ * \qmlproperty color Abstract3DSeries::baseColor
*
* Sets the base color of the series.
*
@@ -198,7 +202,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
*/
/*!
- * \qmlproperty Color Abstract3DSeries::singleHighlightColor
+ * \qmlproperty color Abstract3DSeries::singleHighlightColor
*
* Sets the single item highlight color of the series.
*
@@ -214,7 +218,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
*/
/*!
- * \qmlproperty Color Abstract3DSeries::multiHighlightColor
+ * \qmlproperty color Abstract3DSeries::multiHighlightColor
*
* Sets the multiple item highlight color of the series.
*
@@ -233,7 +237,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* \qmlproperty string Abstract3DSeries::name
*
* The series name.
- * Series name can be used in item label format with tag \c{@seriesName}.
+ * It can be used in item label format with the tag \c{@seriesName}.
*
* \sa itemLabelFormat
*/
@@ -252,9 +256,9 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* \qmlproperty bool Abstract3DSeries::itemLabelVisible
* \since QtDataVisualization 1.1
*
- * If \c true, item labels are drawn as floating labels in the graph. Otherwise item labels are not
- * drawn. If you prefer to show the item label in an external control, set this property to
- * \c false. Defaults to \c true.
+ * If \c true, item labels are drawn as floating labels in the graph. Otherwise,
+ * item labels are not drawn. To show the item label in an external control,
+ * this property is set to \c false. Defaults to \c true.
*
* \sa itemLabelFormat, itemLabel
*/
@@ -262,7 +266,8 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlmethod void Abstract3DSeries::setMeshAxisAndAngle(vector3d axis, real angle)
*
- * A convenience function to construct mesh rotation quaternion from axis and angle.
+ * A convenience function to construct a mesh rotation quaternion from \a axis
+ * and \a angle.
*
* \sa meshRotation
*/
@@ -277,7 +282,7 @@ QAbstract3DSeries::QAbstract3DSeries(QAbstract3DSeriesPrivate *d, QObject *paren
}
/*!
- * Destroys QAbstract3DSeries.
+ * Deletes the abstract 3D series.
*/
QAbstract3DSeries::~QAbstract3DSeries()
{
@@ -299,10 +304,8 @@ QAbstract3DSeries::SeriesType QAbstract3DSeries::type() const
* \brief The label format for data items in this series.
*
* This format is used for single item labels,
- * for example, when an item is selected. How the format is interpreted depends on series type. See
- * each series class documentation for more information.
- *
- * \sa QBar3DSeries, QScatter3DSeries, QSurface3DSeries
+ * for example, when an item is selected. How the format is interpreted depends
+ * on series type: QBar3DSeries, QScatter3DSeries, QSurface3DSeries.
*/
void QAbstract3DSeries::setItemLabelFormat(const QString &format)
{
@@ -371,8 +374,8 @@ QAbstract3DSeries::Mesh QAbstract3DSeries::mesh() const
* \brief Whether smooth versions of predefined meshes are used.
*
* If \c true, smooth versions set via the \l mesh property are used.
- * This property doesn't affect custom meshes used when mesh is MeshUserDefined.
- * Defaults to \c{false}.
+ * This property does not affect custom meshes used when the mesh is set to
+ * MeshUserDefined. Defaults to \c{false}.
*/
void QAbstract3DSeries::setMeshSmooth(bool enable)
{
@@ -395,7 +398,7 @@ bool QAbstract3DSeries::isMeshSmooth() const
* The rotation should be a normalized QQuaternion.
* For those series types that support item specific rotation, the rotations are
* multiplied together.
- * QBar3DSeries ignores any rotation that is not around Y-axis.
+ * QBar3DSeries ignores any rotation that is not around the y-axis.
* QSurface3DSeries applies the rotation only to the selection pointer.
* Defaults to no rotation.
*/
@@ -413,7 +416,8 @@ QQuaternion QAbstract3DSeries::meshRotation() const
}
/*!
- * A convenience function to construct mesh rotation quaternion from \a axis and \a angle.
+ * A convenience function to construct a mesh rotation quaternion from
+ * \a axis and \a angle.
*
* \sa meshRotation
*/
@@ -428,8 +432,8 @@ void QAbstract3DSeries::setMeshAxisAndAngle(const QVector3D &axis, float angle)
* \brief The filename for a user defined custom mesh for objects.
*
* The custom mesh is used when \l mesh is MeshUserDefined.
- * \note The file needs to be in Wavefront obj format and include
- * vertices, normals and UVs. It also needs to be in triangles.
+ * \note The file needs to be in the Wavefront OBJ format and include
+ * vertices, normals, and UVs. It also needs to be in triangles.
*/
void QAbstract3DSeries::setUserDefinedMesh(const QString &fileName)
{
@@ -635,9 +639,9 @@ QString QAbstract3DSeries::itemLabel() const
*
* \brief The visibility of item labels in the graph.
*
- * If \c true, item labels are drawn as floating labels in the graph. Otherwise item labels are not
- * drawn. If you prefer to show the item label in an external control, set this property to
- * \c false. Defaults to \c true.
+ * If \c true, item labels are drawn as floating labels in the graph. Otherwise,
+ * item labels are not drawn. To show the item label in an external control,
+ * this property is set to \c false. Defaults to \c true.
*
* \sa itemLabelFormat, itemLabel
*/
diff --git a/src/datavisualization/data/qbar3dseries.cpp b/src/datavisualization/data/qbar3dseries.cpp
index 9d974695..c338b859 100644
--- a/src/datavisualization/data/qbar3dseries.cpp
+++ b/src/datavisualization/data/qbar3dseries.cpp
@@ -36,11 +36,11 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \class QBar3DSeries
* \inmodule QtDataVisualization
- * \brief Base series class for Q3DBars.
+ * \brief The QBar3DSeries class represents a data series in a 3D bar graph.
* \since QtDataVisualization 1.0
*
- * QBar3DSeries manages the series specific visual elements, as well as series data
- * (via data proxy).
+ * This class manages the series specific visual elements, as well as the series
+ * data (via a data proxy).
*
* If no data proxy is set explicitly for the series, the series creates a default
* proxy. Setting another proxy will destroy the existing proxy and all data added to it.
@@ -54,21 +54,22 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* \row
* \li @valueTitle \li Title from value axis
* \row
- * \li @rowIdx \li Visible row index. Localized using graph locale.
+ * \li @rowIdx \li Visible row index. Localized using the graph locale.
* \row
- * \li @colIdx \li Visible Column index. Localized using graph locale.
+ * \li @colIdx \li Visible column index. Localized using the graph locale.
* \row
* \li @rowLabel \li Label from row axis
* \row
* \li @colLabel \li Label from column axis
* \row
- * \li @valueLabel \li Item value formatted using the same format the value axis attached to
- * the graph uses. See \l{QValue3DAxis::labelFormat} for more information.
+ * \li @valueLabel \li Item value formatted using the format of the value
+ * axis attached to the graph. For more information,
+ * see \l{QValue3DAxis::labelFormat}.
* \row
* \li @seriesName \li Name of the series
* \row
- * \li %<format spec> \li Item value in specified format. Formatted using the same rules as
- * \l{QValue3DAxis::labelFormat}.
+ * \li %<format spec> \li Item value in the specified format. Formatted
+ * using the same rules as \l{QValue3DAxis::labelFormat}.
* \endtable
*
* For example:
@@ -84,12 +85,12 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* \ingroup datavisualization_qml
* \instantiates QBar3DSeries
* \inherits Abstract3DSeries
- * \brief Base series type for Bars3D.
+ * \brief Represents a data series in a 3D bar graph.
*
- * This type manages the series specific visual elements, as well as series data
- * (via data proxy).
+ * This type manages the series specific visual elements, as well as the series
+ * data (via a data proxy).
*
- * For more complete description, see QBar3DSeries.
+ * For a more complete description, see QBar3DSeries.
*
* \sa {Qt Data Visualization Data Handling}
*/
@@ -126,8 +127,9 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty point Bar3DSeries::invalidSelectionPosition
- * A constant property providing an invalid position for selection. Set this position to
- * the selectedBar property if you want to clear the selection from this series.
+ * A constant property providing an invalid position for selection. This
+ * position is set to the selectedBar property to clear the selection from this
+ * series.
*
* \sa {AbstractGraph3D::clearSelection()}{AbstractGraph3D.clearSelection()}
*/
@@ -145,7 +147,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
*/
/*!
- * Constructs QBar3DSeries with the given \a parent.
+ * Constructsa bar 3D series with the parent \a parent.
*/
QBar3DSeries::QBar3DSeries(QObject *parent) :
QAbstract3DSeries(new QBar3DSeriesPrivate(this), parent)
@@ -156,7 +158,8 @@ QBar3DSeries::QBar3DSeries(QObject *parent) :
}
/*!
- * Constructs QBar3DSeries with the given \a dataProxy and the \a parent.
+ * Constructs a bar 3D series with the data proxy \a dataProxy and the parent
+ * \a parent.
*/
QBar3DSeries::QBar3DSeries(QBarDataProxy *dataProxy, QObject *parent) :
QAbstract3DSeries(new QBar3DSeriesPrivate(this), parent)
@@ -166,7 +169,7 @@ QBar3DSeries::QBar3DSeries(QBarDataProxy *dataProxy, QObject *parent) :
}
/*!
- * Destroys QBar3DSeries.
+ * Deletes a bar 3D series.
*/
QBar3DSeries::~QBar3DSeries()
{
@@ -204,7 +207,8 @@ QBarDataProxy *QBar3DSeries::dataProxy() const
*
* Only one bar can be selected at a time.
*
- * To clear selection from this series, set invalidSelectionPosition() as \a position.
+ * To clear selection from this series, invalidSelectionPosition() is set as
+ * \a position.
*
* If this series is added to a graph, the graph can adjust the selection according to user
* interaction or if it becomes invalid. Selecting a bar on another added series will also
@@ -230,8 +234,8 @@ QPoint QBar3DSeries::selectedBar() const
}
/*!
- * \return an invalid position for selection. Set this position to selectedBar property if you
- * want to clear the selection from this series.
+ * Returns an invalid position for selection. This position is set to the
+ * selectedBar property to clear the selection from this series.
*
* \sa QAbstract3DGraph::clearSelection()
*/
@@ -253,7 +257,8 @@ static inline float quaternionAngle(const QQuaternion &rotation)
* Setting this property is equivalent to the following call:
* \code setMeshRotation(QQuaternion::fromAxisAndAngle(0.0f, 1.0f, 0.0f, angle)) \endcode
*
- * \note When reading this property, it is calculated from QAbstract3DSeries::meshRotation value
+ * \note When reading this property, it is calculated from the
+ * QAbstract3DSeries::meshRotation value
* using floating point precision and always returns a value from zero to 360 degrees.
*
* \sa QAbstract3DSeries::meshRotation
diff --git a/src/datavisualization/data/qscatter3dseries.cpp b/src/datavisualization/data/qscatter3dseries.cpp
index a5e84492..1557a6c3 100644
--- a/src/datavisualization/data/qscatter3dseries.cpp
+++ b/src/datavisualization/data/qscatter3dseries.cpp
@@ -35,11 +35,12 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \class QScatter3DSeries
* \inmodule QtDataVisualization
- * \brief Base series class for Q3DScatter.
+ * \brief The QScatter3DSeries class represents a data series in a 3D scatter
+ * graph.
* \since QtDataVisualization 1.0
*
- * QScatter3DSeries manages the series specific visual elements, as well as series data
- * (via data proxy).
+ * This class manages the series specific visual elements, as well as the series
+ * data (via a data proxy).
*
* If no data proxy is set explicitly for the series, the series creates a default
* proxy. Setting another proxy will destroy the existing proxy and all data added to it.
@@ -47,20 +48,23 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* QScatter3DSeries supports the following format tags for QAbstract3DSeries::setItemLabelFormat():
* \table
* \row
- * \li @xTitle \li Title from X axis
+ * \li @xTitle \li Title from x-axis
* \row
- * \li @yTitle \li Title from Y axis
+ * \li @yTitle \li Title from y-axis
* \row
- * \li @zTitle \li Title from Z axis
+ * \li @zTitle \li Title from z-axis
* \row
- * \li @xLabel \li Item value formatted using the same format the X axis attached to the graph uses,
- * see \l{QValue3DAxis::setLabelFormat()} for more information.
+ * \li @xLabel \li Item value formatted using the format of the x-axis.
+ * For more information, see
+ * \l{QValue3DAxis::setLabelFormat()}.
* \row
- * \li @yLabel \li Item value formatted using the same format the Y axis attached to the graph uses,
- * see \l{QValue3DAxis::setLabelFormat()} for more information.
+ * \li @yLabel \li Item value formatted using the format of the y-axis.
+ * For more information, see
+ * \l{QValue3DAxis::setLabelFormat()}.
* \row
- * \li @zLabel \li Item value formatted using the same format the Z axis attached to the graph uses,
- * see \l{QValue3DAxis::setLabelFormat()} for more information.
+ * \li @zLabel \li Item value formatted using the format of the z-axis.
+ * For more information, see
+ * \l{QValue3DAxis::setLabelFormat()}.
* \row
* \li @seriesName \li Name of the series
* \endtable
@@ -78,12 +82,12 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* \ingroup datavisualization_qml
* \instantiates QScatter3DSeries
* \inherits Abstract3DSeries
- * \brief Base series type for Scatter3D.
+ * \brief Represents a data series in a 3D scatter graph.
*
- * This type manages the series specific visual elements, as well as series data
- * (via data proxy).
+ * This type manages the series specific visual elements, as well as the series
+ * data (via a data proxy).
*
- * For more complete description, see QScatter3DSeries.
+ * For a more complete description, see QScatter3DSeries.
*
* \sa {Qt Data Visualization Data Handling}
*/
@@ -101,7 +105,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
*
* The item that is selected at the index in the data array of the series.
* Only one item can be selected at a time.
- * To clear selection from this series, set invalidSelectionIndex as the index.
+ * To clear selection from this series, invalidSelectionIndex is set as the index.
* If this series is added to a graph, the graph can adjust the selection according to user
* interaction or if it becomes invalid. Selecting an item on another added series will also
* clear the selection.
@@ -122,14 +126,14 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty int Scatter3DSeries::invalidSelectionIndex
- * A constant property providing an invalid index for selection. Set this index to
- * selectedItem property if you want to clear the selection from this series.
+ * A constant property providing an invalid index for selection. This index is
+ * set to the selectedItem property to clear the selection from this series.
*
* \sa AbstractGraph3D::clearSelection()
*/
/*!
- * Constructs QScatter3DSeries with the given \a parent.
+ * Constructs a scatter 3D series with the parent \a parent.
*/
QScatter3DSeries::QScatter3DSeries(QObject *parent) :
QAbstract3DSeries(new QScatter3DSeriesPrivate(this), parent)
@@ -139,7 +143,8 @@ QScatter3DSeries::QScatter3DSeries(QObject *parent) :
}
/*!
- * Constructs QScatter3DSeries with the given \a dataProxy and the \a parent.
+ * Constructs a scatter 3D series with the data proxy \a dataProxy and the
+ * parent \a parent.
*/
QScatter3DSeries::QScatter3DSeries(QScatterDataProxy *dataProxy, QObject *parent) :
QAbstract3DSeries(new QScatter3DSeriesPrivate(this), parent)
@@ -156,7 +161,7 @@ QScatter3DSeries::QScatter3DSeries(QScatter3DSeriesPrivate *d, QObject *parent)
}
/*!
- * Destroys QScatter3DSeries.
+ * Deletes the scatter 3D series.
*/
QScatter3DSeries::~QScatter3DSeries()
{
@@ -194,7 +199,7 @@ QScatterDataProxy *QScatter3DSeries::dataProxy() const
* Selects the item at the index \a index in the data array of the series.
* Only one item can be selected at a time.
*
- * To clear selection from this series, set invalidSelectionIndex() as \a index.
+ * To clear selection from this series, invalidSelectionIndex() is set as \a index.
* If this series is added to a graph, the graph can adjust the selection according to user
* interaction or if it becomes invalid. Selecting an item on another added series will also
* clear the selection.
@@ -245,8 +250,8 @@ float QScatter3DSeries::itemSize() const
}
/*!
- * \return an invalid index for selection. Set this index to selectedItem property if you
- * want to clear the selection from this series.
+ * Returns an invalid index for selection. This index is set to the selectedItem
+ * property to clear the selection from this series.
*
* \sa QAbstract3DGraph::clearSelection()
*/
diff --git a/src/datavisualization/data/qsurface3dseries.cpp b/src/datavisualization/data/qsurface3dseries.cpp
index ec414aca..83d766bd 100644
--- a/src/datavisualization/data/qsurface3dseries.cpp
+++ b/src/datavisualization/data/qsurface3dseries.cpp
@@ -35,35 +35,39 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \class QSurface3DSeries
* \inmodule QtDataVisualization
- * \brief Base series class for Q3DSurface.
+ * \brief The QSurface3DSeries class represents a data series in a 3D surface
+ * graph.
* \since QtDataVisualization 1.0
*
- * QSurface3DSeries manages the series specific visual elements, as well as series data
- * (via data proxy).
+ * This class manages the series specific visual elements, as well as the series
+ * data (via a data proxy).
*
* If no data proxy is set explicitly for the series, the series creates a default
* proxy. Setting another proxy will destroy the existing proxy and all data added to it.
*
- * The object mesh set via QAbstract3DSeries::mesh property defines the selection
- * pointer shape in surface series.
+ * The object mesh set via the QAbstract3DSeries::mesh property defines the selection
+ * pointer shape in a surface series.
*
* QSurface3DSeries supports the following format tags for QAbstract3DSeries::setItemLabelFormat():
* \table
* \row
- * \li @xTitle \li Title from X axis
+ * \li @xTitle \li Title from x-axis
* \row
- * \li @yTitle \li Title from Y axis
+ * \li @yTitle \li Title from y-axis
* \row
- * \li @zTitle \li Title from Z axis
+ * \li @zTitle \li Title from z-axis
* \row
- * \li @xLabel \li Item value formatted using the same format as the X axis attached to the graph uses,
- * see \l{QValue3DAxis::setLabelFormat()} for more information.
+ * \li @xLabel \li Item value formatted using the format of the x-axis.
+ * For more information, see
+ * \l{QValue3DAxis::setLabelFormat()}.
* \row
- * \li @yLabel \li Item value formatted using the same format as the Y axis attached to the graph uses,
- * see \l{QValue3DAxis::setLabelFormat()} for more information.
+ * \li @yLabel \li Item value formatted using the format of the y-axis.
+ * For more information, see
+ * \l{QValue3DAxis::setLabelFormat()}.
* \row
- * \li @zLabel \li Item value formatted using the same format as the Z axis attached to the graph uses,
- * see \l{QValue3DAxis::setLabelFormat()} for more information.
+ * \li @zLabel \li Item value formatted using the format of the z-axis.
+ * For more information, see
+ * \l{QValue3DAxis::setLabelFormat()}.
* \row
* \li @seriesName \li Name of the series
* \endtable
@@ -81,14 +85,12 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* \ingroup datavisualization_qml
* \instantiates QSurface3DSeries
* \inherits Abstract3DSeries
- * \brief Base series type for Surfaces3D.
+ * \brief Represents a data series in a 3D surface graph.
*
- * This type manages the series specific visual elements, as well as series data
- * (via data proxy).
+ * This type manages the series specific visual elements, as well as the series
+ * data (via a data proxy).
*
- * For Surface3DSeries enums, see \l{QSurface3DSeries::DrawFlag}.
- *
- * For more complete description, see QSurface3DSeries.
+ * For a more complete description, see QSurface3DSeries.
*
* \sa {Qt Data Visualization Data Handling}
*/
@@ -108,7 +110,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* in the data array of the series as selected.
* Only one point can be selected at a time.
*
- * To clear selection from this series, set invalidSelectionPosition as the position.
+ * To clear selection from this series, invalidSelectionPosition is set as the position.
* If this series is added to a graph, the graph can adjust the selection according to user
* interaction or if it becomes invalid.
*
@@ -121,7 +123,8 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty point Surface3DSeries::invalidSelectionPosition
* A constant property providing an invalid selection position.
- * Set this to the selectedPoint property to clear the selection from this series.
+ * This position is set to the selectedPoint property to clear the selection
+ * from this series.
*
* \sa AbstractGraph3D::clearSelection()
*/
@@ -158,8 +161,8 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty string Surface3DSeries::textureFile
*
- * The texture file name for the surface texture. To clear the texture, set an empty
- * file name.
+ * The texture file name for the surface texture. To clear the texture, an empty
+ * file name is set.
*/
@@ -178,7 +181,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
*/
/*!
- * Constructs QSurface3DSeries with the given \a parent.
+ * Constructs a surface 3D series with the parent \a parent.
*/
QSurface3DSeries::QSurface3DSeries(QObject *parent) :
QAbstract3DSeries(new QSurface3DSeriesPrivate(this), parent)
@@ -188,7 +191,8 @@ QSurface3DSeries::QSurface3DSeries(QObject *parent) :
}
/*!
- * Constructs QSurface3DSeries with the given \a dataProxy and the \a parent.
+ * Constructs a surface 3D series with the data proxy \a dataProxy and the
+ * parent \a parent.
*/
QSurface3DSeries::QSurface3DSeries(QSurfaceDataProxy *dataProxy, QObject *parent) :
QAbstract3DSeries(new QSurface3DSeriesPrivate(this), parent)
@@ -205,7 +209,7 @@ QSurface3DSeries::QSurface3DSeries(QSurface3DSeriesPrivate *d, QObject *parent)
}
/*!
- * Destroys QSurface3DSeries.
+ * Deletes the surface 3D series.
*/
QSurface3DSeries::~QSurface3DSeries()
{
@@ -242,7 +246,7 @@ QSurfaceDataProxy *QSurface3DSeries::dataProxy() const
*
* Only one point can be selected at a time.
*
- * To clear selection from this series, set invalidSelectionPosition() as \a position.
+ * To clear selection from this series, invalidSelectionPosition() is set as \a position.
* If this series is added to a graph, the graph can adjust the selection according to user
* interaction or if it becomes invalid.
*
@@ -266,7 +270,7 @@ QPoint QSurface3DSeries::selectedPoint() const
}
/*!
- * Returns the a QPoint signifying an invalid selection position. Set this to
+ * Returns the QPoint signifying an invalid selection position. This is set to
* the selectedPoint property to clear the selection from this series.
*
* \sa QAbstract3DGraph::clearSelection()