summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@qt.io>2017-02-28 13:04:10 +0100
committerLiang Qi <liang.qi@qt.io>2017-02-28 13:04:10 +0100
commit5adf257bebf2df7f54b92fb724cd547dc58a1163 (patch)
tree5fcf162817cc87b712b935947debf964c3943cf6
parent01347e7ee885166177990f2314f0e9edc94fd961 (diff)
parent743f32ee776220b52e0c37cbbbff5b4c52c475b6 (diff)
Merge remote-tracking branch 'origin/5.9' into dev
-rw-r--r--src/datavisualization/axis/qabstract3daxis.cpp55
-rw-r--r--src/datavisualization/axis/qcategory3daxis.cpp8
-rw-r--r--src/datavisualization/axis/qlogvalue3daxisformatter.cpp18
-rw-r--r--src/datavisualization/axis/qvalue3daxis.cpp26
-rw-r--r--src/datavisualization/data/qabstract3dseries.cpp143
-rw-r--r--src/datavisualization/data/qabstractdataproxy.cpp2
-rw-r--r--src/datavisualization/data/qbar3dseries.cpp53
-rw-r--r--src/datavisualization/data/qbardataproxy.cpp23
-rw-r--r--src/datavisualization/data/qcustom3ditem.cpp74
-rw-r--r--src/datavisualization/data/qcustom3dlabel.cpp42
-rw-r--r--src/datavisualization/data/qcustom3dvolume.cpp99
-rw-r--r--src/datavisualization/data/qheightmapsurfacedataproxy.cpp43
-rw-r--r--src/datavisualization/data/qitemmodelsurfacedataproxy.cpp284
13 files changed, 540 insertions, 330 deletions
diff --git a/src/datavisualization/axis/qabstract3daxis.cpp b/src/datavisualization/axis/qabstract3daxis.cpp
index 320e0fee..90f93eb9 100644
--- a/src/datavisualization/axis/qabstract3daxis.cpp
+++ b/src/datavisualization/axis/qabstract3daxis.cpp
@@ -58,31 +58,31 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty string AbstractAxis3D::title
- * Defines the title for the axis.
+ * The title for the axis.
*
* \sa titleVisible, titleFixed
*/
/*!
* \qmlproperty list AbstractAxis3D::labels
- * Defines the labels for the axis.
+ * The labels for the axis.
* \note Setting this property for ValueAxis3D does nothing, as it generates labels automatically.
*/
/*!
* \qmlproperty AbstractAxis3D.AxisOrientation AbstractAxis3D::orientation
- * Defines the orientation of the axis.
+ * The orientation of the axis.
*/
/*!
* \qmlproperty AbstractAxis3D.AxisType AbstractAxis3D::type
- * Defines the type of the axis.
+ * The type of the axis.
*/
/*!
* \qmlproperty real AbstractAxis3D::min
*
- * Defines the minimum value on the axis.
+ * The minimum value on the axis.
* When setting this property the max is adjusted if necessary, to ensure that the range remains
* valid.
*/
@@ -90,7 +90,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty real AbstractAxis3D::max
*
- * Defines the maximum value on the axis.
+ * The maximum value on the axis.
* When setting this property the min is adjusted if necessary, to ensure that the range remains
* valid.
*/
@@ -98,14 +98,14 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty bool AbstractAxis3D::autoAdjustRange
*
- * If set, the axis will automatically adjust the range so that all data fits in it.
+ * Defines whether the axis will automatically adjust the range so that all data fits in it.
*/
/*!
* \qmlproperty real AbstractAxis3D::labelAutoRotation
*
- * Defines the maximum \a angle the labels can autorotate when the camera angle changes.
- * The \a angle can be between 0 and 90, inclusive. The default value is 0.
+ * The maximum angle the labels can autorotate when the camera angle changes.
+ * The angle can be between 0 and 90, inclusive. The default value is 0.
* If the value is 0, axis labels do not automatically rotate.
* If the value is greater than zero, labels attempt to orient themselves toward the camera, up to
* the specified angle.
@@ -114,7 +114,9 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty bool AbstractAxis3D::titleVisible
*
- * Defines if the axis title is visible in the primary graph view. The default value is \c{false}.
+ * Defines whether the axis title is visible in the primary graph view.
+ *
+ * The default value is \c{false}.
*
* \sa title, titleFixed
*/
@@ -122,6 +124,8 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty bool AbstractAxis3D::titleFixed
*
+ * The rotation of axis titles.
+ *
* If \c{true}, axis titles in the primary graph view will be rotated towards the camera similarly
* to the axis labels.
* If \c{false}, axis titles are only rotated around their axis but are not otherwise oriented
@@ -172,7 +176,9 @@ QAbstract3DAxis::~QAbstract3DAxis()
/*!
* \property QAbstract3DAxis::orientation
*
- * Defines the orientation of the axis, one of AxisOrientation.
+ * \brief The orientation of the axis.
+ *
+ * The value is one of AxisOrientation values.
*/
QAbstract3DAxis::AxisOrientation QAbstract3DAxis::orientation() const
{
@@ -182,7 +188,9 @@ QAbstract3DAxis::AxisOrientation QAbstract3DAxis::orientation() const
/*!
* \property QAbstract3DAxis::type
*
- * Defines the type of the axis, one of AxisType.
+ * \brief The type of the axis.
+ *
+ * The value is one of AxisType values.
*/
QAbstract3DAxis::AxisType QAbstract3DAxis::type() const
{
@@ -192,7 +200,7 @@ QAbstract3DAxis::AxisType QAbstract3DAxis::type() const
/*!
* \property QAbstract3DAxis::title
*
- * Defines the title for the axis.
+ * \brief The title for the axis.
*
* \sa titleVisible, titleFixed
*/
@@ -212,7 +220,7 @@ QString QAbstract3DAxis::title() const
/*!
* \property QAbstract3DAxis::labels
*
- * Defines the labels for the axis.
+ * \brief The labels for the axis.
* \note Setting this property for QValue3DAxis does nothing, as it generates labels automatically.
*/
void QAbstract3DAxis::setLabels(const QStringList &labels)
@@ -240,8 +248,9 @@ void QAbstract3DAxis::setRange(float min, float max)
/*!
* \property QAbstract3DAxis::labelAutoRotation
*
- * Defines the maximum \a angle the labels can autorotate when the camera angle changes.
- * The \a angle can be between 0 and 90, inclusive. The default value is 0.
+ * \brief The maximum angle the labels can autorotate when the camera angle changes.
+ *
+ * The angle can be between 0 and 90, inclusive. The default value is 0.
* If the value is 0, axis labels do not automatically rotate.
* If the value is greater than zero, labels attempt to orient themselves toward the camera, up to
* the specified angle.
@@ -266,7 +275,9 @@ float QAbstract3DAxis::labelAutoRotation() const
/*!
* \property QAbstract3DAxis::titleVisible
*
- * Defines if the axis title is visible in the primary graph view. The default value is \c{false}.
+ * \brief Whether the axis title is visible in the primary graph view.
+ *
+ * The default value is \c{false}.
*
* \sa title, titleFixed
*/
@@ -286,6 +297,8 @@ bool QAbstract3DAxis::isTitleVisible() const
/*!
* \property QAbstract3DAxis::titleFixed
*
+ * \brief The rotation of the axis titles.
+ *
* If \c{true}, axis titles in the primary graph view will be rotated towards the camera similarly
* to the axis labels.
* If \c{false}, axis titles are only rotated around their axis but are not otherwise oriented
@@ -311,7 +324,8 @@ bool QAbstract3DAxis::isTitleFixed() const
/*!
* \property QAbstract3DAxis::min
*
- * Defines the minimum value on the axis.
+ * \brief The minimum value on the axis.
+ *
* When setting this property the max is adjusted if necessary, to ensure that the range remains
* valid.
* \note For QCategory3DAxis this specifies the index of the first row or column to show.
@@ -325,7 +339,8 @@ void QAbstract3DAxis::setMin(float min)
/*!
* \property QAbstract3DAxis::max
*
- * Defines the maximum value on the axis.
+ * \brief The maximum value on the axis.
+ *
* When setting this property the min is adjusted if necessary, to ensure that the range remains
* valid.
* \note For QCategory3DAxis this specifies the index of the last row or column to show.
@@ -349,7 +364,7 @@ float QAbstract3DAxis::max() const
/*!
* \property QAbstract3DAxis::autoAdjustRange
*
- * If set, the axis will automatically adjust the range so that all data fits in it.
+ * \brief Whether the axis will automatically adjust the range so that all data fits in it.
*
* \sa setRange(), setMin(), setMax()
*/
diff --git a/src/datavisualization/axis/qcategory3daxis.cpp b/src/datavisualization/axis/qcategory3daxis.cpp
index d81fffa7..faf286ab 100644
--- a/src/datavisualization/axis/qcategory3daxis.cpp
+++ b/src/datavisualization/axis/qcategory3daxis.cpp
@@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty list CategoryAxis3D::labels
*
- * Defines labels for axis applied to categories. If there are fewer labels than categories, the
+ * The labels for the axis applied to categories. If there are fewer labels than categories, the
* remaining ones do not have a label. If category labels are not defined explicitly, labels are
* generated from the data row (or column) labels of the primary series of the graph.
*/
@@ -84,8 +84,10 @@ QCategory3DAxis::~QCategory3DAxis()
/*!
* \property QCategory3DAxis::labels
*
- * Defines \a labels for axis applied to categories. If there are fewer labels than categories, the
- * remaining ones do not have a label. If category \a labels are not defined explicitly, labels are
+ * \brief The labels for the axis applied to categories.
+ *
+ * If there are fewer labels than categories, the
+ * remaining ones do not have a label. If category labels are not defined explicitly, labels are
* generated from the data row (or column) labels of the primary series of the graph.
*/
QStringList QCategory3DAxis::labels() const
diff --git a/src/datavisualization/axis/qlogvalue3daxisformatter.cpp b/src/datavisualization/axis/qlogvalue3daxisformatter.cpp
index abe88cb9..fb1e7447 100644
--- a/src/datavisualization/axis/qlogvalue3daxisformatter.cpp
+++ b/src/datavisualization/axis/qlogvalue3daxisformatter.cpp
@@ -64,12 +64,12 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty real LogValueAxis3DFormatter::base
*
- * The \a base of the logarithm used to map axis values. If the base is non-zero, the parent axis
+ * The base of the logarithm used to map axis values. If the base is non-zero, the parent axis
* segment count will be ignored when the grid line and label positions are calculated.
* If you want the range to be divided into equal segments like normal value axis, set this
* property value to zero.
*
- * The \a base has to be zero or positive value and not equal to one.
+ * The base has to be zero or positive value and not equal to one.
* Defaults to ten.
*
* \sa ValueAxis3D::segmentCount
@@ -78,6 +78,8 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty bool LogValueAxis3DFormatter::autoSubGrid
*
+ * Defines whether sub-grid positions are generated automatically.
+ *
* If this property value is set to \c true, the parent axis sub-segment count is ignored
* when calculating sub-grid line positions. The sub-grid positions are generated automatically
* according to the base property value.
@@ -91,6 +93,8 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty bool LogValueAxis3DFormatter::showEdgeLabels
*
+ * Defines whether the first and last label on the axis are visible.
+ *
* When the base property value is non-zero, the whole axis range is often not equally divided into
* segments. The first and last segments are often smaller than the other segments.
* In extreme cases this can lead to overlapping labels on the first and last two grid lines.
@@ -132,12 +136,14 @@ QLogValue3DAxisFormatter::~QLogValue3DAxisFormatter()
/*!
* \property QLogValue3DAxisFormatter::base
*
- * The \a base of the logarithm used to map axis values. If the base is non-zero, the parent axis
+ * \brief The base of the logarithm used to map axis values.
+ *
+ * If the base is non-zero, the parent axis
* segment count will be ignored when the grid line and label positions are calculated.
* If you want the range to be divided into equal segments like normal value axis, set this
* property value to zero.
*
- * The \a base has to be zero or positive value and not equal to one.
+ * The base has to be zero or positive value and not equal to one.
* Defaults to ten.
*
* \sa QValue3DAxis::segmentCount
@@ -164,6 +170,8 @@ qreal QLogValue3DAxisFormatter::base() const
/*!
* \property QLogValue3DAxisFormatter::autoSubGrid
*
+ * \brief Whether sub-grid positions are generated automatically.
+ *
* If this property value is set to \c true, the parent axis sub-segment count is ignored
* when calculating sub-grid line positions. The sub-grid positions are generated automatically
* according to the base property value.
@@ -190,6 +198,8 @@ bool QLogValue3DAxisFormatter::autoSubGrid() const
/*!
* \property QLogValue3DAxisFormatter::showEdgeLabels
*
+ * \brief Whether the first and last label on the axis are visible.
+ *
* When the base property value is non-zero, the whole axis range is often not equally divided into
* segments. The first and last segments are often smaller than the other segments.
* In extreme cases this can lead to overlapping labels on the first and last two grid lines.
diff --git a/src/datavisualization/axis/qvalue3daxis.cpp b/src/datavisualization/axis/qvalue3daxis.cpp
index 8aff36e5..efdf7143 100644
--- a/src/datavisualization/axis/qvalue3daxis.cpp
+++ b/src/datavisualization/axis/qvalue3daxis.cpp
@@ -64,7 +64,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty int ValueAxis3D::segmentCount
*
- * Defines the number of segments on the axis. This indicates how many labels are drawn. The number
+ * The number of segments on the axis. This indicates how many labels are drawn. The number
* of grid lines to be drawn is calculated with formula: \c {segments * subsegments + 1}.
* The preset default is \c 5, and it can not be below \c 1.
*/
@@ -72,7 +72,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty int ValueAxis3D::subSegmentCount
*
- * Defines the number of subsegments inside each segment on the axis. Grid lines are drawn between
+ * The number of subsegments inside each segment on the axis. Grid lines are drawn between
* each subsegment, in addition to each segment.
* The preset default is \c 1, and it can not be below \c 1.
*/
@@ -80,7 +80,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty string ValueAxis3D::labelFormat
*
- * Defines the label format to be used for the labels on this axis. How the format is interpreted
+ * The label format to be used for the labels on this axis. How the format is interpreted
* depends on the axis formatter and the locale in use. Using the default formatter and default
* locale (\c{"C"}), the formatting uses QString::sprintf(). Supported specifiers are:
* \c {d, i, o, x, X, f, F, e, E, g, G, c}. See QString::sprintf() for additional details.
@@ -96,7 +96,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* \qmlproperty ValueAxis3DFormatter ValueAxis3D::formatter
* \since QtDataVisualization 1.1
*
- * Defines the axis \a formatter to be used. Any existing formatter is deleted when a new formatter
+ * The axis formatter to be used. Any existing formatter is deleted when a new formatter
* is set.
*
*/
@@ -129,7 +129,9 @@ QValue3DAxis::~QValue3DAxis()
/*!
* \property QValue3DAxis::segmentCount
*
- * Defines the number of segments on the axis. This indicates how many labels are drawn. The number
+ * \brief The number of segments on the axis.
+ *
+ * This indicates how many labels are drawn. The number
* of grid lines to be drawn is calculated with formula: \c {segments * subsegments + 1}.
* The preset default is \c 5, and it can not be below \c 1.
*
@@ -157,7 +159,9 @@ int QValue3DAxis::segmentCount() const
/*!
* \property QValue3DAxis::subSegmentCount
*
- * Defines the number of subsegments inside each segment on the axis. Grid lines are drawn between
+ * \brief The number of subsegments inside each segment on the axis.
+ *
+ * Grid lines are drawn between
* each subsegment, in addition to each segment.
* The preset default is \c 1, and it can not be below \c 1.
*
@@ -184,7 +188,9 @@ int QValue3DAxis::subSegmentCount() const
/*!
* \property QValue3DAxis::labelFormat
*
- * Defines the label format to be used for the labels on this axis. How the format is interpreted
+ * \brief The label format to be used for the labels on this axis.
+ *
+ * How the format is interpreted
* depends on the axis formatter and the locale in use. Using the default formatter and default
* locale (\c{"C"}), the formatting uses QString::sprintf(). Supported specifiers are:
* \c {d, i, o, x, X, f, F, e, E, g, G, c}. See QString::sprintf() for additional details.
@@ -217,7 +223,9 @@ QString QValue3DAxis::labelFormat() const
* \property QValue3DAxis::formatter
* \since QtDataVisualization 1.1
*
- * Defines the axis \a formatter to be used. Any existing formatter is deleted when a new formatter
+ * \brief The axis formatter to be used.
+ *
+ * Any existing formatter is deleted when a new formatter
* is set.
*/
void QValue3DAxis::setFormatter(QValue3DAxisFormatter *formatter)
@@ -246,6 +254,8 @@ QValue3DAxisFormatter *QValue3DAxis::formatter() const
* \property QValue3DAxis::reversed
* \since QtDataVisualization 1.1
*
+ * \brief Whether the axis is rendered in reverse.
+ *
* If \c{true}, the axis will be rendered in reverse, i.e. the positions of minimum and maximum
* values are swapped when the graph is rendered. This property doesn't affect the actual
* minimum and maximum values of the axis.
diff --git a/src/datavisualization/data/qabstract3dseries.cpp b/src/datavisualization/data/qabstract3dseries.cpp
index 70e725fb..c24ece86 100644
--- a/src/datavisualization/data/qabstract3dseries.cpp
+++ b/src/datavisualization/data/qabstract3dseries.cpp
@@ -124,21 +124,21 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty string Abstract3DSeries::itemLabelFormat
*
- * Label format for data items in this series. This format is used for single item labels,
+ * 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.
*/
/*!
* \qmlproperty bool Abstract3DSeries::visible
- * Sets the visibility of the series. If false, the series is not rendered.
+ * Sets the visibility of the series. If \c false, the series is not rendered.
*/
/*!
* \qmlproperty Abstract3DSeries.Mesh Abstract3DSeries::mesh
*
- * Sets the \a mesh of the items in the series, or the selection pointer in case of
- * Surface3DSeries. If the \a mesh is \l{QAbstract3DSeries::MeshUserDefined}{Abstract3DSeries.MeshUserDefined},
+ * Sets the mesh of the items in the series, or the selection pointer in case of
+ * 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.
*/
@@ -146,7 +146,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty bool Abstract3DSeries::meshSmooth
*
- * If \a enable is \c true, smooth versions of predefined meshes set via mesh property are used.
+ * 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
* \l{QAbstract3DSeries::MeshUserDefined}{Abstract3DSeries.MeshUserDefined}.
* Defaults to \c{false}.
@@ -155,8 +155,8 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty quaternion Abstract3DSeries::meshRotation
*
- * Sets the mesh \a rotation that is applied to all items of the series.
- * The \a rotation should be a normalized quaternion.
+ * Sets the mesh rotation that is applied to all items of the series.
+ * 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.
@@ -167,84 +167,72 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty string Abstract3DSeries::userDefinedMesh
*
- * Sets the \a fileName for user defined custom mesh for objects that is used when mesh
+ * Sets the filename for user defined custom mesh for objects that is used when \l mesh
* is \l{QAbstract3DSeries::MeshUserDefined}{Abstract3DSeries.MeshUserDefined}.
- * \note The file specified by \a fileName needs to be in Wavefront obj format and include
+ * \note The file needs to be in Wavefront obj format and include
* vertices, normals and UVs. It also needs to be in triangles.
*/
/*!
* \qmlproperty Theme3D.ColorStyle Abstract3DSeries::colorStyle
*
- * Sets the color \a style for the series.
- * See \l{Theme3D::colorStyle}{Theme3D.colorStyle}
- * documentation for more information.
+ * Sets the color style for the series.
+ *
+ * \sa {Theme3D::colorStyle}{Theme3D.colorStyle}
*/
/*!
* \qmlproperty Color Abstract3DSeries::baseColor
*
- * Sets the base \a color of the series.
- * See \l{Theme3D::baseColors}{Theme3D.baseColors}
- * documentation for more information.
+ * Sets the base color of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, {Theme3D::baseColors}{Theme3D.baseColors}
*/
/*!
* \qmlproperty ColorGradient Abstract3DSeries::baseGradient
*
- * Sets the base \a gradient of the series.
- * See \l{Theme3D::baseGradients}{Theme3D.baseGradients}
- * documentation for more information.
+ * Sets the base gradient of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, {Theme3D::baseGradients}{Theme3D.baseGradients}
*/
/*!
* \qmlproperty Color Abstract3DSeries::singleHighlightColor
*
- * Sets the single item highlight \a color of the series.
- * See \l{Theme3D::singleHighlightColor}{Theme3D.singleHighlightColor}
- * documentation for more information.
+ * Sets the single item highlight color of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, {Theme3D::singleHighlightColor}{Theme3D.singleHighlightColor}
*/
/*!
* \qmlproperty ColorGradient Abstract3DSeries::singleHighlightGradient
*
- * Sets the single item highlight \a gradient of the series.
- * See \l{Theme3D::singleHighlightGradient}{Theme3D.singleHighlightGradient}
- * documentation for more information.
+ * Sets the single item highlight gradient of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, {Theme3D::singleHighlightGradient}{Theme3D.singleHighlightGradient}
*/
/*!
* \qmlproperty Color Abstract3DSeries::multiHighlightColor
*
- * Sets the multiple item highlight \a color of the series.
- * See \l{Theme3D::multiHighlightColor}{Theme3D.multiHighlightColor}
- * documentation for more information.
+ * Sets the multiple item highlight color of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, {Theme3D::multiHighlightColor}{Theme3D.multiHighlightColor}
*/
/*!
* \qmlproperty ColorGradient Abstract3DSeries::multiHighlightGradient
*
- * Sets the multiple item highlight \a gradient of the series.
- * See \l{Theme3D::multiHighlightGradient}{Theme3D.multiHighlightGradient}
- * documentation for more information.
+ * Sets the multiple item highlight gradient of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, {Theme3D::multiHighlightGradient}{Theme3D.multiHighlightGradient}
*/
/*!
* \qmlproperty string Abstract3DSeries::name
*
- * Sets the series name.
+ * The series name.
* Series name can be used in item label format with tag \c{@seriesName}.
*
* \sa itemLabelFormat
@@ -254,7 +242,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* \qmlproperty string Abstract3DSeries::itemLabel
* \since QtDataVisualization 1.1
*
- * Contains the formatted item label. If there is no selected item or the selected item is not
+ * The formatted item label. If there is no selected item or the selected item is not
* visible, returns an empty string.
*
* \sa itemLabelFormat
@@ -298,7 +286,7 @@ QAbstract3DSeries::~QAbstract3DSeries()
/*!
* \property QAbstract3DSeries::type
*
- * The type of the series.
+ * \brief The type of the series.
*/
QAbstract3DSeries::SeriesType QAbstract3DSeries::type() const
{
@@ -308,7 +296,9 @@ QAbstract3DSeries::SeriesType QAbstract3DSeries::type() const
/*!
* \property QAbstract3DSeries::itemLabelFormat
*
- * Sets label \a format for data items in this series. This format is used for single item labels,
+ * \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.
*
@@ -330,7 +320,9 @@ QString QAbstract3DSeries::itemLabelFormat() const
/*!
* \property QAbstract3DSeries::visible
*
- * Sets the visibility of the series. If \a visible is false, the series is not rendered.
+ * \brief The visibility of the series.
+ *
+ * If this property is \c false, the series is not rendered.
* Defaults to \c{true}.
*/
void QAbstract3DSeries::setVisible(bool visible)
@@ -349,8 +341,11 @@ bool QAbstract3DSeries::isVisible() const
/*!
* \property QAbstract3DSeries::mesh
*
- * Sets the \a mesh of the items in the series, or the selection pointer in case of
- * QSurface3DSeries. If the \a mesh is MeshUserDefined, then the userDefinedMesh property
+ * \brief The mesh of the items in the series.
+ *
+ * For QSurface3DSeries, this property holds the selection pointer.
+ *
+ * If the mesh is MeshUserDefined, then the userDefinedMesh property
* must also be set for items to render properly. The default value depends on the graph type.
*/
void QAbstract3DSeries::setMesh(QAbstract3DSeries::Mesh mesh)
@@ -373,7 +368,9 @@ QAbstract3DSeries::Mesh QAbstract3DSeries::mesh() const
/*!
* \property QAbstract3DSeries::meshSmooth
*
- * If \a enable is \c true, smooth versions of predefined meshes set via mesh property are used.
+ * \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}.
*/
@@ -393,8 +390,9 @@ bool QAbstract3DSeries::isMeshSmooth() const
/*!
* \property QAbstract3DSeries::meshRotation
*
- * Sets the mesh \a rotation that is applied to all items of the series.
- * The \a rotation should be a normalized QQuaternion.
+ * \brief The mesh rotation that is applied to all items of the series.
+ *
+ * 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.
@@ -427,9 +425,10 @@ void QAbstract3DSeries::setMeshAxisAndAngle(const QVector3D &axis, float angle)
/*!
* \property QAbstract3DSeries::userDefinedMesh
*
- * Sets the \a fileName for user defined custom mesh for objects that is used when mesh
- * is MeshUserDefined.
- * \note The file specified by \a fileName needs to be in Wavefront obj format and include
+ * \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.
*/
void QAbstract3DSeries::setUserDefinedMesh(const QString &fileName)
@@ -448,8 +447,9 @@ QString QAbstract3DSeries::userDefinedMesh() const
/*!
* \property QAbstract3DSeries::colorStyle
*
- * Sets the color \a style for the series.
- * See Q3DTheme::ColorStyle documentation for more information.
+ * \brief The color style for the series.
+ *
+ * \sa Q3DTheme::ColorStyle
*/
void QAbstract3DSeries::setColorStyle(Q3DTheme::ColorStyle style)
{
@@ -468,10 +468,9 @@ Q3DTheme::ColorStyle QAbstract3DSeries::colorStyle() const
/*!
* \property QAbstract3DSeries::baseColor
*
- * Sets the base \a color of the series.
- * See Q3DTheme::baseColors documentation for more information.
+ * \brief The base color of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, Q3DTheme::baseColors
*/
void QAbstract3DSeries::setBaseColor(const QColor &color)
{
@@ -490,10 +489,9 @@ QColor QAbstract3DSeries::baseColor() const
/*!
* \property QAbstract3DSeries::baseGradient
*
- * Sets the base \a gradient of the series.
- * See Q3DTheme::baseGradients documentation for more information.
+ * \brief The base gradient of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, Q3DTheme::baseGradients
*/
void QAbstract3DSeries::setBaseGradient(const QLinearGradient &gradient)
{
@@ -512,10 +510,9 @@ QLinearGradient QAbstract3DSeries::baseGradient() const
/*!
* \property QAbstract3DSeries::singleHighlightColor
*
- * Sets the single item highlight \a color of the series.
- * See Q3DTheme::singleHighlightColor documentation for more information.
+ * \brief The single item highlight color of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, Q3DTheme::singleHighlightColor
*/
void QAbstract3DSeries::setSingleHighlightColor(const QColor &color)
{
@@ -534,10 +531,9 @@ QColor QAbstract3DSeries::singleHighlightColor() const
/*!
* \property QAbstract3DSeries::singleHighlightGradient
*
- * Sets the single item highlight \a gradient of the series.
- * See Q3DTheme::singleHighlightGradient documentation for more information.
+ * \brief The single item highlight gradient of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, Q3DTheme::singleHighlightGradient
*/
void QAbstract3DSeries::setSingleHighlightGradient(const QLinearGradient &gradient)
{
@@ -556,10 +552,9 @@ QLinearGradient QAbstract3DSeries::singleHighlightGradient() const
/*!
* \property QAbstract3DSeries::multiHighlightColor
*
- * Sets the multiple item highlight \a color of the series.
- * See Q3DTheme::multiHighlightColor documentation for more information.
+ * \brief The multiple item highlight color of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, Q3DTheme::multiHighlightColor
*/
void QAbstract3DSeries::setMultiHighlightColor(const QColor &color)
{
@@ -578,10 +573,9 @@ QColor QAbstract3DSeries::multiHighlightColor() const
/*!
* \property QAbstract3DSeries::multiHighlightGradient
*
- * Sets the multiple item highlight \a gradient of the series.
- * See Q3DTheme::multiHighlightGradient documentation for more information.
+ * \brief The multiple item highlight gradient of the series.
*
- * \sa colorStyle
+ * \sa colorStyle, Q3DTheme::multiHighlightGradient
*/
void QAbstract3DSeries::setMultiHighlightGradient(const QLinearGradient &gradient)
{
@@ -600,8 +594,9 @@ QLinearGradient QAbstract3DSeries::multiHighlightGradient() const
/*!
* \property QAbstract3DSeries::name
*
- * Sets the series \a name.
- * Series \a name can be used in item label format with tag \c{@seriesName}.
+ * \brief The series name.
+ *
+ * The series name can be used in item label format with the tag \c{@seriesName}.
*
* \sa itemLabelFormat
*/
@@ -622,7 +617,9 @@ QString QAbstract3DSeries::name() const
* \property QAbstract3DSeries::itemLabel
* \since QtDataVisualization 1.1
*
- * Contains the formatted item label. If there is no selected item or the selected item is not
+ * \brief The formatted item label.
+ *
+ * If there is no selected item or the selected item is not
* visible, returns an empty string.
*
* \sa itemLabelFormat
@@ -636,6 +633,8 @@ QString QAbstract3DSeries::itemLabel() const
* \property QAbstract3DSeries::itemLabelVisible
* \since QtDataVisualization 1.1
*
+ * \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.
diff --git a/src/datavisualization/data/qabstractdataproxy.cpp b/src/datavisualization/data/qabstractdataproxy.cpp
index 547205ab..fa25bc93 100644
--- a/src/datavisualization/data/qabstractdataproxy.cpp
+++ b/src/datavisualization/data/qabstractdataproxy.cpp
@@ -96,7 +96,7 @@ QAbstractDataProxy::~QAbstractDataProxy()
/*!
* \property QAbstractDataProxy::type
*
- * The type of the proxy.
+ * \brief The type of the proxy.
*/
QAbstractDataProxy::DataType QAbstractDataProxy::type() const
{
diff --git a/src/datavisualization/data/qbar3dseries.cpp b/src/datavisualization/data/qbar3dseries.cpp
index a89b1f3f..9d974695 100644
--- a/src/datavisualization/data/qbar3dseries.cpp
+++ b/src/datavisualization/data/qbar3dseries.cpp
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2016 The Qt Company Ltd.
+** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Data Visualization module of the Qt Toolkit.
@@ -97,44 +97,51 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty BarDataProxy Bar3DSeries::dataProxy
*
- * This property holds the active data \a proxy. The series assumes ownership of any proxy set to
- * it and deletes any previously set proxy when a new one is added. The \a proxy cannot be null or
+ * The active data proxy. The series assumes ownership of any proxy set to
+ * it and deletes any previously set proxy when a new one is added. The proxy cannot be null or
* set to another series.
*/
/*!
* \qmlproperty point Bar3DSeries::selectedBar
*
- * Selects a bar at the \a position. The \a position is the (row, column) position in
- * the data array of the series.
+ * The bar in the series that is selected.
+ *
+ * The position of the selected bar is specified as a row and column in the
+ * data array of the series.
+ *
* Only one bar can be selected at a time.
- * To clear selection from this series, set invalidSelectionPosition as the \a position.
+ *
+ * To clear selection from this series, set invalidSelectionPosition 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. Selecting a bar on another added series will also
* clear the selection.
+ *
* Removing rows from or inserting rows to the series before the row of the selected bar
* will adjust the selection so that the same bar will stay selected.
*
- * \sa AbstractGraph3D::clearSelection()
+ * \sa {AbstractGraph3D::clearSelection()}{AbstractGraph3D.clearSelection()}
*/
/*!
* \qmlproperty point Bar3DSeries::invalidSelectionPosition
* A constant property providing an invalid position for selection. Set this position to
- * selectedBar property if you want to clear the selection from this series.
+ * the selectedBar property if you want to clear the selection from this series.
*
- * \sa AbstractGraph3D::clearSelection()
+ * \sa {AbstractGraph3D::clearSelection()}{AbstractGraph3D.clearSelection()}
*/
/*!
* \qmlproperty real Bar3DSeries::meshAngle
*
- * A convenience property for defining the series rotation \a angle in degrees.
+ * A convenience property for defining the series rotation angle in degrees.
*
- * \note When reading this property, it is calculated from Abstract3DSeries::meshRotation value
+ * \note When reading this property, it is calculated from the
+ * \l{Abstract3DSeries::meshRotation}{Abstract3DSeries.meshRotation} value
* using floating point precision and always returns a value from zero to 360 degrees.
*
- * \sa Abstract3DSeries::meshRotation
+ * \sa {Abstract3DSeries::meshRotation}{Abstract3DSeries.meshRotation}
*/
/*!
@@ -168,8 +175,10 @@ QBar3DSeries::~QBar3DSeries()
/*!
* \property QBar3DSeries::dataProxy
*
- * This property holds the active data \a proxy. The series assumes ownership of any proxy set to
- * it and deletes any previously set proxy when a new one is added. The \a proxy cannot be null or
+ * \brief The active data proxy.
+ *
+ * The series assumes ownership of any proxy set to it and deletes any
+ * previously set proxy when a new one is added. The proxy cannot be null or
* set to another series.
*/
void QBar3DSeries::setDataProxy(QBarDataProxy *proxy)
@@ -185,13 +194,22 @@ QBarDataProxy *QBar3DSeries::dataProxy() const
/*!
* \property QBar3DSeries::selectedBar
*
- * Selects a bar at the \a position. The \a position is the (row, column) position in
+ * \brief The bar in the series that is selected.
+ *
+ */
+
+/*!
+ * Selects the bar at the \a position position, specified as a row and column in
* the data array of the series.
+ *
* Only one bar can be selected at a time.
- * To clear selection from this series, set invalidSelectionPosition() as the \a position.
+ *
+ * To clear selection from this series, set invalidSelectionPosition() 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
* clear the selection.
+ *
* Removing rows from or inserting rows to the series before the row of the selected bar
* will adjust the selection so that the same bar will stay selected.
*
@@ -230,7 +248,8 @@ static inline float quaternionAngle(const QQuaternion &rotation)
/*!
* \property QBar3DSeries::meshAngle
*
- * A convenience property for defining the series rotation \a angle in degrees.
+ * \brief The series rotation angle in degrees.
+ *
* Setting this property is equivalent to the following call:
* \code setMeshRotation(QQuaternion::fromAxisAndAngle(0.0f, 1.0f, 0.0f, angle)) \endcode
*
diff --git a/src/datavisualization/data/qbardataproxy.cpp b/src/datavisualization/data/qbardataproxy.cpp
index e435417b..c5dfe71a 100644
--- a/src/datavisualization/data/qbardataproxy.cpp
+++ b/src/datavisualization/data/qbardataproxy.cpp
@@ -91,20 +91,21 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty int BarDataProxy::rowCount
- * Row count in the array.
+ * The number of rows in the array.
*/
/*!
* \qmlproperty list BarDataProxy::rowLabels
*
- * Optional row labels for the array. Indexes in this array match row indexes in data array.
- * If the list is shorter than row count, all rows will not get labels.
+ * The optional row labels for the array. Indexes in this array match the row
+ * indexes in the data array.
+ * If the list is shorter than number of rows, all rows will not get labels.
*/
/*!
* \qmlproperty list BarDataProxy::columnLabels
*
- * Optional column labels for the array. Indexes in this array match column indexes in rows.
+ * The optional column labels for the array. Indexes in this array match column indexes in rows.
* If the list is shorter than the longest row, all columns will not get labels.
*/
@@ -140,7 +141,7 @@ QBarDataProxy::~QBarDataProxy()
/*!
* \property QBarDataProxy::series
*
- * The series this proxy is attached to.
+ * \brief The series this proxy is attached to.
*/
QBar3DSeries *QBarDataProxy::series() const
{
@@ -370,7 +371,7 @@ void QBarDataProxy::removeRows(int rowIndex, int removeCount, bool removeLabels)
/*!
* \property QBarDataProxy::rowCount
*
- * Row \a count in the array.
+ * \brief The number of rows in the array.
*/
int QBarDataProxy::rowCount() const
{
@@ -380,8 +381,10 @@ int QBarDataProxy::rowCount() const
/*!
* \property QBarDataProxy::rowLabels
*
- * Optional row \a labels for the array. Indexes in this array match row indexes in data array.
- * If the list is shorter than row count, all rows will not get labels.
+ * \brief The optional row labels for the array.
+ *
+ * Indexes in this array match the row indexes in the data array.
+ * If the list is shorter than the number of rows, all rows will not get labels.
*/
QStringList QBarDataProxy::rowLabels() const
{
@@ -399,7 +402,9 @@ void QBarDataProxy::setRowLabels(const QStringList &labels)
/*!
* \property QBarDataProxy::columnLabels
*
- * Optional column \a labels for the array. Indexes in this array match column indexes in rows.
+ * \brief The optional column labels for the array.
+ *
+ * Indexes in this array match column indexes in rows.
* If the list is shorter than the longest row, all columns will not get labels.
*/
QStringList QBarDataProxy::columnLabels() const
diff --git a/src/datavisualization/data/qcustom3ditem.cpp b/src/datavisualization/data/qcustom3ditem.cpp
index db05f006..740d79e7 100644
--- a/src/datavisualization/data/qcustom3ditem.cpp
+++ b/src/datavisualization/data/qcustom3ditem.cpp
@@ -57,13 +57,13 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*! \qmlproperty string Custom3DItem::meshFile
*
- * Holds item mesh file name. Item in the file must be in Wavefront obj format and include
+ * The item mesh file name. The item in the file must be in Wavefront obj format and include
* vertices, normals, and UVs. It also needs to be in triangles.
*/
/*! \qmlproperty string Custom3DItem::textureFile
*
- * Holds the texture file name for the item. If left unset, a solid gray texture will be
+ * The texture file name for the item. If left unset, a solid gray texture will be
* used.
*
* \note To conserve memory the QImage loaded from the file is cleared after a texture is created.
@@ -71,7 +71,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*! \qmlproperty vector3d Custom3DItem::position
*
- * Holds the item \a position as a vector3d. Defaults to \c {vector3d(0.0, 0.0, 0.0)}.
+ * The item position as a vector3d. Defaults to \c {vector3d(0.0, 0.0, 0.0)}.
*
* Item position is either in data coordinates or in absolute coordinates, depending on the
* positionAbsolute property. When using absolute coordinates, values between \c{-1.0...1.0} are
@@ -86,7 +86,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*! \qmlproperty bool Custom3DItem::positionAbsolute
*
- * This property dictates if item position is to be handled in data coordinates or in absolute
+ * Defines whether item position is to be handled in data coordinates or in absolute
* coordinates. Defaults to \c{false}. Items with absolute coordinates will always be rendered,
* whereas items with data coordinates are only rendered if they are within axis ranges.
*
@@ -95,7 +95,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*! \qmlproperty vector3d Custom3DItem::scaling
*
- * Holds the item \a scaling as a vector3d. Defaults to \c {vector3d(0.1, 0.1, 0.1)}.
+ * The item scaling as a vector3d. Defaults to \c {vector3d(0.1, 0.1, 0.1)}.
*
* Item scaling is either in data values or in absolute values, depending on the
* scalingAbsolute property. The default vector interpreted as absolute values sets the item to
@@ -108,7 +108,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*! \qmlproperty bool Custom3DItem::scalingAbsolute
* \since QtDataVisualization 1.2
*
- * This property dictates if item scaling is to be handled in data values or in absolute
+ * Defines whether item scaling is to be handled in data values or in absolute
* values. Defaults to \c{true}. Items with absolute scaling will be rendered at the same
* size, regardless of axis ranges. Items with data scaling will change their apparent size
* according to the axis ranges. If positionAbsolute value is \c{true}, this property is ignored
@@ -116,10 +116,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* is calculated on the unrotated item. Similarly, for Custom3DVolume items, the range clipping
* is calculated on the unrotated item.
*
- * \note: Only absolute scaling is supported for Custom3DLabel items or for custom items used in
+ * \note Only absolute scaling is supported for Custom3DLabel items or for custom items used in
* \l{AbstractGraph3D::polar}{polar} graphs.
*
- * \note: The custom item's mesh must be normalized to range \c{[-1 ,1]}, or the data
+ * \note The custom item's mesh must be normalized to range \c{[-1 ,1]}, or the data
* scaling will not be accurate.
*
* \sa scaling, positionAbsolute
@@ -127,18 +127,18 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*! \qmlproperty quaternion Custom3DItem::rotation
*
- * Holds the item \a rotation as a quaternion. Defaults to \c {quaternion(0.0, 0.0, 0.0, 0.0)}.
+ * The item rotation as a quaternion. Defaults to \c {quaternion(0.0, 0.0, 0.0, 0.0)}.
*/
/*! \qmlproperty bool Custom3DItem::visible
*
- * Sets the item \a visible. Defaults to \c{true}.
+ * The visibility of the item. Defaults to \c{true}.
*/
/*! \qmlproperty bool Custom3DItem::shadowCasting
*
- * Sets shadow casting for the item to \a enabled. Defaults to \c{true}.
- * If set \c{false}, the item does not cast shadows regardless of
+ * Defines whether shadow casting for the item is enabled. Defaults to \c{true}.
+ * If \c{false}, the item does not cast shadows regardless of
* \l{QAbstract3DGraph::ShadowQuality}{ShadowQuality}.
*/
@@ -192,7 +192,9 @@ QCustom3DItem::~QCustom3DItem()
/*! \property QCustom3DItem::meshFile
*
- * Holds item mesh file name. Item in the file must be in Wavefront obj format and include
+ * \brief The item mesh file name.
+ *
+ * The item in the file must be in Wavefront obj format and include
* vertices, normals, and UVs. It also needs to be in triangles.
*/
void QCustom3DItem::setMeshFile(const QString &meshFile)
@@ -212,7 +214,9 @@ QString QCustom3DItem::meshFile() const
/*! \property QCustom3DItem::position
*
- * Holds the item \a position as a QVector3D. Defaults to \c {QVector3D(0.0, 0.0, 0.0)}.
+ * \brief The item position as a QVector3D.
+ *
+ * Defaults to \c {QVector3D(0.0, 0.0, 0.0)}.
*
* Item position is either in data coordinates or in absolute coordinates, depending on
* positionAbsolute property. When using absolute coordinates, values between \c{-1.0...1.0} are
@@ -241,8 +245,10 @@ QVector3D QCustom3DItem::position() const
/*! \property QCustom3DItem::positionAbsolute
*
- * This property dictates if item position is to be handled in data coordinates or in absolute
- * coordinates. Defaults to \c{false}. Items with absolute coordinates will always be rendered,
+ * \brief Whether item position is to be handled in data coordinates or in absolute
+ * coordinates.
+ *
+ * Defaults to \c{false}. Items with absolute coordinates will always be rendered,
* whereas items with data coordinates are only rendered if they are within axis ranges.
*
* \sa position
@@ -264,7 +270,9 @@ bool QCustom3DItem::isPositionAbsolute() const
/*! \property QCustom3DItem::scaling
*
- * Holds the item \a scaling as a QVector3D. Defaults to \c {QVector3D(0.1, 0.1, 0.1)}.
+ * \brief The item scaling as a QVector3D.
+ *
+ * Defaults to \c {QVector3D(0.1, 0.1, 0.1)}.
*
* Item scaling is either in data values or in absolute values, depending on the
* scalingAbsolute property. The default vector interpreted as absolute values sets the item to
@@ -291,18 +299,22 @@ QVector3D QCustom3DItem::scaling() const
/*! \property QCustom3DItem::scalingAbsolute
* \since QtDataVisualization 1.2
*
- * This property dictates if item scaling is to be handled in data values or in absolute
- * values. Defaults to \c{true}. Items with absolute scaling will be rendered at the same
+ * \brief Whether item scaling is to be handled in data values or in absolute
+ * values.
+ *
+ * Defaults to \c{true}.
+ *
+ * Items with absolute scaling will be rendered at the same
* size, regardless of axis ranges. Items with data scaling will change their apparent size
* according to the axis ranges. If positionAbsolute value is \c{true}, this property is ignored
* and scaling is interpreted as an absolute value. If the item has rotation, the data scaling
* is calculated on the unrotated item. Similarly, for QCustom3DVolume items, the range clipping
* is calculated on the unrotated item.
*
- * \note: Only absolute scaling is supported for QCustom3DLabel items or for custom items used in
+ * \note Only absolute scaling is supported for QCustom3DLabel items or for custom items used in
* \l{QAbstract3DGraph::polar}{polar} graphs.
*
- * \note: The custom item's mesh must be normalized to range \c{[-1 ,1]}, or the data
+ * \note The custom item's mesh must be normalized to range \c{[-1 ,1]}, or the data
* scaling will not be accurate.
*
* \sa scaling, positionAbsolute
@@ -326,7 +338,9 @@ bool QCustom3DItem::isScalingAbsolute() const
/*! \property QCustom3DItem::rotation
*
- * Holds the item \a rotation as a QQuaternion. Defaults to \c {QQuaternion(0.0, 0.0, 0.0, 0.0)}.
+ * \brief The item rotation as a QQuaternion.
+ *
+ * Defaults to \c {QQuaternion(0.0, 0.0, 0.0, 0.0)}.
*/
void QCustom3DItem::setRotation(const QQuaternion &rotation)
{
@@ -345,7 +359,9 @@ QQuaternion QCustom3DItem::rotation()
/*! \property QCustom3DItem::visible
*
- * Sets the item \a visible. Defaults to \c{true}.
+ * \brief The visibility of the item.
+ *
+ * Defaults to \c{true}.
*/
void QCustom3DItem::setVisible(bool visible)
{
@@ -365,8 +381,10 @@ bool QCustom3DItem::isVisible() const
/*! \property QCustom3DItem::shadowCasting
*
- * Sets shadow casting for the item to \a enabled. Defaults to \c{true}.
- * If set \c{false}, the item does not cast shadows regardless of QAbstract3DGraph::ShadowQuality.
+ * \brief Whether shadow casting for the item is enabled.
+ *
+ * Defaults to \c{true}.
+ * If \c{false}, the item does not cast shadows regardless of QAbstract3DGraph::ShadowQuality.
*/
void QCustom3DItem::setShadowCasting(bool enabled)
{
@@ -394,7 +412,7 @@ void QCustom3DItem::setRotationAxisAndAngle(const QVector3D &axis, float angle)
}
/*!
- * Set the \a textureImage as a QImage for the item. Texture defaults to solid gray.
+ * Sets the \a textureImage as a QImage for the item. Texture defaults to solid gray.
*
* \note To conserve memory the given QImage is cleared after a texture is created.
*/
@@ -420,7 +438,9 @@ void QCustom3DItem::setTextureImage(const QImage &textureImage)
/*! \property QCustom3DItem::textureFile
*
- * Holds the texture file name for the item. If both this and texture image are unset, a solid
+ * \brief The texture file name for the item.
+ *
+ * If both this property and the texture image are unset, a solid
* gray texture will be used.
*
* \note To conserve memory the QImage loaded from the file is cleared after a texture is created.
diff --git a/src/datavisualization/data/qcustom3dlabel.cpp b/src/datavisualization/data/qcustom3dlabel.cpp
index daea2615..27d02993 100644
--- a/src/datavisualization/data/qcustom3dlabel.cpp
+++ b/src/datavisualization/data/qcustom3dlabel.cpp
@@ -80,33 +80,33 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*! \qmlproperty color Custom3DLabel::textColor
*
- * Color for the label text. Also affects label border, if enabled. Defaults to \c{"white"}.
+ * The color for the label text. Also affects label border, if enabled. Defaults to \c{"white"}.
*
* \sa borderEnabled
*/
/*! \qmlproperty color Custom3DLabel::backgroundColor
*
- * Color for the label background, if enabled. Defaults to \c{"gray"}.
+ * The color for the label background, if enabled. Defaults to \c{"gray"}.
*
* \sa backgroundEnabled
*/
/*! \qmlproperty bool Custom3DLabel::backgroundEnabled
*
- * Enable label background. If set to \c{false}, backgroundColor has no effect. Defaults
- * to \c{true}.
+ * Defines whether the label background is enabled. If set to \c{false},
+ * backgroundColor has no effect. Defaults to \c{true}.
*/
/*! \qmlproperty bool Custom3DLabel::borderEnabled
*
- * Enable label borders. Defaults to \c{true}.
+ * Defines whether label borders are enabled. Defaults to \c{true}.
*/
/*! \qmlproperty bool Custom3DLabel::facingCamera
*
- * Forces the label to face camera always. Defaults to \c{false}. If set to \c{true}, rotation()
- * has no effect.
+ * Defines whether the label will always face the camera. Defaults to \c{false}.
+ * If set to \c{true}, rotation() has no effect.
*/
/*!
@@ -140,7 +140,9 @@ QCustom3DLabel::~QCustom3DLabel()
/*! \property QCustom3DLabel::text
*
- * The text for the label. Rich text is not supported.
+ * \brief The text for the label.
+ *
+ * Rich text is not supported.
*/
void QCustom3DLabel::setText(const QString &text)
{
@@ -159,7 +161,9 @@ QString QCustom3DLabel::text() const
/*! \property QCustom3DLabel::font
*
- * The font to be used for the label. Defaults to \c{QFont("Arial", 20)}. Special formatting
+ * \brief The font to be used for the label.
+ *
+ * Defaults to \c{QFont("Arial", 20)}. Special formatting
* (for example outlined) is not supported.
*/
void QCustom3DLabel::setFont(const QFont &font)
@@ -179,7 +183,9 @@ QFont QCustom3DLabel::font() const
/*! \property QCustom3DLabel::textColor
*
- * Color for the label text. Also affects label border, if enabled. Defaults to \c{Qt::white}.
+ * \brief Color for the label text.
+ *
+ * Also affects label border, if enabled. Defaults to \c{Qt::white}.
*
* \sa borderEnabled
*/
@@ -201,7 +207,9 @@ QColor QCustom3DLabel::textColor() const
/*! \property QCustom3DLabel::backgroundColor
*
- * Color for the label background, if enabled. Defaults to \c{Qt::gray}.
+ * \brief The color for the label background, if enabled.
+ *
+ * Defaults to \c{Qt::gray}.
*
* \sa backgroundEnabled
*/
@@ -223,7 +231,9 @@ QColor QCustom3DLabel::backgroundColor() const
/*! \property QCustom3DLabel::borderEnabled
*
- * Enable label borders. Defaults to \c{true}.
+ * \brief Whether label borders are enabled.
+ *
+ * Defaults to \c{true}.
*/
void QCustom3DLabel::setBorderEnabled(bool enabled)
{
@@ -243,7 +253,9 @@ bool QCustom3DLabel::isBorderEnabled() const
/*! \property QCustom3DLabel::backgroundEnabled
*
- * Enable label background. If set to \c{false}, backgroundColor() has no effect. Defaults
+ * \brief Whether the label background is enabled.
+ *
+ * If set to \c{false}, backgroundColor() has no effect. Defaults
* to \c{true}.
*/
void QCustom3DLabel::setBackgroundEnabled(bool enabled)
@@ -264,7 +276,9 @@ bool QCustom3DLabel::isBackgroundEnabled() const
/*! \property QCustom3DLabel::facingCamera
*
- * Forces the label to face camera always. Defaults to \c{false}. If set to \c{true}, rotation()
+ * \brief Whether the label will always face the camera.
+ *
+ * Defaults to \c{false}. If set to \c{true}, rotation()
* has no effect.
*/
void QCustom3DLabel::setFacingCamera(bool enabled)
diff --git a/src/datavisualization/data/qcustom3dvolume.cpp b/src/datavisualization/data/qcustom3dvolume.cpp
index 6d55f839..1e7bdb82 100644
--- a/src/datavisualization/data/qcustom3dvolume.cpp
+++ b/src/datavisualization/data/qcustom3dvolume.cpp
@@ -78,7 +78,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* If the frame rate is more important than pixel-perfect rendering of the volume contents, consider
* turning the high definition shader off by setting useHighDefShader property to \c{false}.
*
- * \note: Filling in the volume data would not typically be efficient or practical from pure QML,
+ * \note Filling in the volume data would not typically be efficient or practical from pure QML,
* so properties directly related to that are not fully supported from QML.
* Make a hybrid QML/C++ application if you want to use volume objects with a QML UI.
*
@@ -93,7 +93,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
*
* The width of the 3D texture defining the volume content in pixels. Defaults to \c{0}.
*
- * \note: Changing this property from QML is not supported, as the texture data cannot be resized
+ * \note Changing this property from QML is not supported, as the texture data cannot be resized
* to match.
*/
@@ -101,7 +101,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
*
* The height of the 3D texture defining the volume content in pixels. Defaults to \c{0}.
*
- * \note: Changing this property from QML is not supported, as the texture data cannot be resized
+ * \note Changing this property from QML is not supported, as the texture data cannot be resized
* to match.
*/
@@ -109,7 +109,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
*
* The depth of the 3D texture defining the volume content in pixels. Defaults to \c{0}.
*
- * \note: Changing this property from QML is not supported, as the texture data cannot be resized
+ * \note Changing this property from QML is not supported, as the texture data cannot be resized
* to match.
*/
@@ -218,7 +218,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty color Custom3DVolume::sliceFrameColor
*
- * Indicates the color of the slice frame. Transparent slice frame color is not supported.
+ * The color of the slice frame. Transparent slice frame color is not supported.
*
* Defaults to black.
*
@@ -228,7 +228,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty vector3d Custom3DVolume::sliceFrameWidths
*
- * Indicates the widths of the slice frame. The width can be different on different dimensions,
+ * The widths of the slice frame. The width can be different on different dimensions,
* so you can for example omit drawing the frames on certain sides of the volume by setting the
* value for that dimension to zero. The values are fractions of the volume thickness in the same
* dimension. The values cannot be negative.
@@ -241,7 +241,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty vector3d Custom3DVolume::sliceFrameGaps
*
- * Indicates the amount of air gap left between the volume itself and the frame in each dimension.
+ * The size of the air gap left between the volume itself and the frame in each dimension.
* The gap can be different on different dimensions. The values are fractions of the volume
* thickness in the same dimension. The values cannot be negative.
*
@@ -253,7 +253,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty vector3d Custom3DVolume::sliceFrameThicknesses
*
- * Indicates the thickness of the slice frames for each dimension. The values are fractions of
+ * The thickness of the slice frames for each dimension. The values are fractions of
* the volume thickness in the same dimension. The values cannot be negative.
*
* Defaults to \c{vector3d(0.01, 0.01, 0.01)}.
@@ -297,7 +297,9 @@ QCustom3DVolume::~QCustom3DVolume()
/*! \property QCustom3DVolume::textureWidth
*
- * The width of the 3D texture defining the volume content in pixels. Defaults to \c{0}.
+ * \brief The width of the 3D texture defining the volume content in pixels.
+ *
+ * Defaults to \c{0}.
*
* \note The textureData may need to be resized or recreated if this value is changed.
* Defaults to \c{0}.
@@ -325,7 +327,9 @@ int QCustom3DVolume::textureWidth() const
/*! \property QCustom3DVolume::textureHeight
*
- * The height of the 3D texture defining the volume content in pixels. Defaults to \c{0}.
+ * \brief The height of the 3D texture defining the volume content in pixels.
+ *
+ * Defaults to \c{0}.
*
* \note The textureData may need to be resized or recreated if this value is changed.
* Defaults to \c{0}.
@@ -354,7 +358,9 @@ int QCustom3DVolume::textureHeight() const
/*! \property QCustom3DVolume::textureDepth
*
- * The depth of the 3D texture defining the volume content in pixels. Defaults to \c{0}.
+ * \brief The depth of the 3D texture defining the volume content in pixels.
+ *
+ * Defaults to \c{0}.
*
* \note The textureData may need to be resized or recreated if this value is changed.
* Defaults to \c{0}.
@@ -394,7 +400,7 @@ void QCustom3DVolume::setTextureDimensions(int width, int height, int depth)
}
/*!
- * \return the actual texture data width. When the texture format is QImage::Format_Indexed8,
+ * Returns the actual texture data width. When the texture format is QImage::Format_Indexed8,
* this is textureWidth aligned to 32bit boundary. Otherwise this is four times textureWidth.
*/
int QCustom3DVolume::textureDataWidth() const
@@ -411,10 +417,12 @@ int QCustom3DVolume::textureDataWidth() const
/*! \property QCustom3DVolume::sliceIndexX
*
- * The X dimension index into the texture data indicating which vertical slice to show.
+ * \brief The X dimension index into the texture data indicating which vertical slice to show.
+ *
* Setting any dimension to negative indicates no slice or slice frame for that dimension is drawn.
* If all dimensions are negative, no slices or slice frames are drawn and the volume is drawn
* normally.
+ *
* Defaults to \c{-1}.
*
* \sa textureData, drawSlices, drawSliceFrames
@@ -436,10 +444,12 @@ int QCustom3DVolume::sliceIndexX() const
/*! \property QCustom3DVolume::sliceIndexY
*
- * The Y dimension index into the texture data indicating which horizontal slice to show.
+ * \brief The Y dimension index into the texture data indicating which horizontal slice to show.
+ *
* Setting any dimension to negative indicates no slice or slice frame for that dimension is drawn.
* If all dimensions are negative, no slices or slice frames are drawn and the volume is drawn
* normally.
+ *
* Defaults to \c{-1}.
*
* \sa textureData, drawSlices, drawSliceFrames
@@ -461,10 +471,12 @@ int QCustom3DVolume::sliceIndexY() const
/*! \property QCustom3DVolume::sliceIndexZ
*
- * The Z dimension index into the texture data indicating which vertical slice to show.
+ * \brief The Z dimension index into the texture data indicating which vertical slice to show.
+ *
* Setting any dimension to negative indicates no slice or slice frame for that dimension is drawn.
* If all dimensions are negative, no slices or slice frames are drawn and the volume is drawn
* normally.
+ *
* Defaults to \c{-1}.
*
* \sa textureData, drawSlices, drawSliceFrames
@@ -498,8 +510,9 @@ void QCustom3DVolume::setSliceIndices(int x, int y, int z)
/*! \property QCustom3DVolume::colorTable
*
- * The array containing the colors for indexed texture formats. If the texture format is not
- * indexed, this array is not used and can be empty.
+ * \brief The array containing the colors for indexed texture formats.
+ *
+ * If the texture format is not indexed, this array is not used and can be empty.
*
* Defaults to \c{0}.
*
@@ -522,7 +535,8 @@ QVector<QRgb> QCustom3DVolume::colorTable() const
/*! \property QCustom3DVolume::textureData
*
- * The array containing the texture data in the format specified by textureFormat.
+ * \brief The array containing the texture data in the format specified by textureFormat.
+ *
* The size of this array must be at least
* (\c{textureDataWidth * textureHeight * textureDepth * texture format color depth in bytes}).
*
@@ -538,7 +552,7 @@ QVector<QRgb> QCustom3DVolume::colorTable() const
*
* \note Each X-line of the data needs to be 32bit aligned. If the textureFormat is
* QImage::Format_Indexed8 and textureWidth is not divisible by four, padding bytes need
- * to be added to each X-line of the \a data. You can get the padded byte count with
+ * to be added to each X-line of the data. You can get the padded byte count with
* textureDataWidth() function. The padding bytes should indicate an fully transparent color
* to avoid rendering artifacts.
*
@@ -560,14 +574,14 @@ void QCustom3DVolume::setTextureData(QVector<uchar> *data)
}
/*!
- * This function creates a new texture data array from an array of \a images and sets it as
+ * Creates a new texture data array from an array of \a images and sets it as
* textureData for this volume object. The texture dimensions are also set according to image
* and array dimensions. All of the images in the array must be the same size. If the images are not
* all in QImage::Format_Indexed8 format, all texture data will be converted into
* QImage::Format_ARGB32 format. If the images are in QImage::Format_Indexed8 format, the colorTable
* for the entire volume will be taken from the first image.
*
- * \return pointer to the newly created array.
+ * Returns a pointer to the newly created array.
*
* \sa textureData, textureWidth, textureHeight, textureDepth, setTextureFormat()
*/
@@ -643,7 +657,7 @@ QVector<uchar> *QCustom3DVolume::textureData() const
}
/*!
- * This function allows setting a single 2D subtexture of the 3D texture along the specified
+ * Sets a single 2D subtexture of the 3D texture along the specified
* \a axis of the volume.
* The \a index parameter specifies the subtexture to set.
* The texture \a data must be in the format specified by textureFormat property and have size of
@@ -723,7 +737,7 @@ void QCustom3DVolume::setSubTextureData(Qt::Axis axis, int index, const uchar *d
}
/*!
- * This function allows setting a single 2D subtexture of the 3D texture along the specified
+ * Sets a single 2D subtexture of the 3D texture along the specified
* \a axis of the volume.
* The \a index parameter specifies the subtexture to set.
* The source \a image must be in the format specified by the textureFormat property if the
@@ -800,7 +814,7 @@ void QCustom3DVolume::setTextureFormat(QImage::Format format)
}
/*!
- * \return the format of the textureData.
+ * Returns the format of the textureData.
*
* \sa setTextureFormat()
*/
@@ -820,8 +834,10 @@ QImage::Format QCustom3DVolume::textureFormat() const
/*!
* \property QCustom3DVolume::alphaMultiplier
*
- * The alpha value of every texel of the volume texture is multiplied with this value at
- * the render time. This can be used to introduce uniform transparency to the volume.
+ * \brief The value that the alpha value of every texel of the volume texture is multiplied with at
+ * the render time.
+ *
+ * This property can be used to introduce uniform transparency to the volume.
* If preserveOpacity is \c{true}, only texels with at least some transparency to begin with are
* affected, and fully opaque texels are not affected.
* The value must not be negative.
@@ -851,6 +867,8 @@ float QCustom3DVolume::alphaMultiplier() const
/*!
* \property QCustom3DVolume::preserveOpacity
*
+ * \brief Whether the alpha multiplier is applied to all texels.
+ *
* If this property value is \c{true}, alphaMultiplier is only applied to texels that already have
* some transparency. If it is \c{false}, the multiplier is applied to the alpha value of all
* texels.
@@ -876,7 +894,9 @@ bool QCustom3DVolume::preserveOpacity() const
/*!
* \property QCustom3DVolume::useHighDefShader
*
- * If this property value is \c{true}, a high definition shader is used to render the volume.
+ * \brief Whether a high or low definition shader is used to render the volume.
+ *
+ * If this property value is \c{true}, a high definition shader is used.
* If it is \c{false}, a low definition shader is used.
*
* The high definition shader guarantees that every visible texel of the volume texture is sampled
@@ -910,6 +930,8 @@ bool QCustom3DVolume::useHighDefShader() const
/*!
* \property QCustom3DVolume::drawSlices
*
+ * \brief Whether the specified slices are drawn instead of the full volume.
+ *
* If this property value is \c{true}, the slices indicated by slice index properties
* will be drawn instead of the full volume.
* If it is \c{false}, the full volume will always be drawn.
@@ -938,12 +960,16 @@ bool QCustom3DVolume::drawSlices() const
/*!
* \property QCustom3DVolume::drawSliceFrames
*
+ * \brief Whether slice frames are drawn around the volume.
+ *
* If this property value is \c{true}, the frames of slices indicated by slice index properties
* will be drawn around the volume.
* If it is \c{false}, no slice frames will be drawn.
+ *
* Drawing slice frames is independent of drawing slices, so you can show the full volume and
* still draw the slice frames around it. This is useful when using renderSlice() to display the
* slices outside the graph itself.
+ *
* Defaults to \c{false}.
*
* \sa sliceIndexX, sliceIndexY, sliceIndexZ, drawSlices, renderSlice()
@@ -966,7 +992,9 @@ bool QCustom3DVolume::drawSliceFrames() const
/*!
* \property QCustom3DVolume::sliceFrameColor
*
- * Indicates the color of the slice frame. Transparent slice frame color is not supported.
+ * \brief The color of the slice frame.
+ *
+ * Transparent slice frame color is not supported.
*
* Defaults to black.
*
@@ -990,7 +1018,9 @@ QColor QCustom3DVolume::sliceFrameColor() const
/*!
* \property QCustom3DVolume::sliceFrameWidths
*
- * Indicates the widths of the slice frame. The width can be different on different dimensions,
+ * \brief The width of the slice frame.
+ *
+ * The width can be different on different dimensions,
* so you can for example omit drawing the frames on certain sides of the volume by setting the
* value for that dimension to zero. The values are fractions of the volume thickness in the same
* dimension. The values cannot be negative.
@@ -1019,7 +1049,9 @@ QVector3D QCustom3DVolume::sliceFrameWidths() const
/*!
* \property QCustom3DVolume::sliceFrameGaps
*
- * Indicates the amount of air gap left between the volume itself and the frame in each dimension.
+ * \brief The size of the air gap left between the volume itself and the frame
+ * in each dimension.
+ *
* The gap can be different on different dimensions. The values are fractions of the volume
* thickness in the same dimension. The values cannot be negative.
*
@@ -1047,7 +1079,9 @@ QVector3D QCustom3DVolume::sliceFrameGaps() const
/*!
* \property QCustom3DVolume::sliceFrameThicknesses
*
- * Indicates the thickness of the slice frames for each dimension. The values are fractions of
+ * \brief The thickness of the slice frames for each dimension.
+ *
+ * The values are fractions of
* the volume thickness in the same dimension. The values cannot be negative.
*
* Defaults to \c{QVector3D(0.01, 0.01, 0.01)}.
@@ -1075,7 +1109,8 @@ QVector3D QCustom3DVolume::sliceFrameThicknesses() const
* Renders the slice specified by \a index along \a axis into an image.
* The texture format of this object is used.
*
- * \return the rendered image of the slice, or a null image if invalid index is specified.
+ * Returns the rendered image of the slice, or a null image if invalid index is
+ * specified.
*
* \sa setTextureFormat()
*/
diff --git a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
index 8d8142aa..1d762f88 100644
--- a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
@@ -76,7 +76,9 @@ const float defaultMaxValue = 10.0f;
* with height map data.
*
* There are several formats the image file can be given in, but if it is not in a directly usable
- * format, a conversion is made. \note If the result seems wrong, the automatic conversion failed
+ * format, a conversion is made.
+ *
+ * \note If the result seems wrong, the automatic conversion failed
* and you should try converting the image yourself before setting it. Preferred format is
* QImage::Format_RGB32 in grayscale.
*
@@ -175,11 +177,16 @@ QHeightMapSurfaceDataProxy::~QHeightMapSurfaceDataProxy()
/*!
* \property QHeightMapSurfaceDataProxy::heightMap
*
- * A height map \a image to be visualized. Setting this property replaces current data with height
- * map data.
+ * \brief The height map image to be visualized.
+ */
+
+/*!
+ * Replaces current data with the height map data specified by \a image.
*
* There are several formats the \a image can be given in, but if it is not in a directly usable
- * format, a conversion is made. \note If the result seems wrong, the automatic conversion failed
+ * format, a conversion is made.
+ *
+ * \note If the result seems wrong, the automatic conversion failed
* and you should try converting the \a image yourself before setting it. Preferred format is
* QImage::Format_RGB32 in grayscale.
*
@@ -209,8 +216,12 @@ QImage QHeightMapSurfaceDataProxy::heightMap() const
/*!
* \property QHeightMapSurfaceDataProxy::heightMapFile
*
- * A file with a height map image to be visualized. Setting this property replaces current data
- * with height map data.
+ * \brief The name of the file with a height map image to be visualized.
+ */
+
+/*!
+ * Replaces current data with height map data from the file specified by
+ * \a filename.
*
* \sa heightMap
*/
@@ -239,7 +250,10 @@ void QHeightMapSurfaceDataProxy::setValueRanges(float minX, float maxX, float mi
/*!
* \property QHeightMapSurfaceDataProxy::minXValue
*
- * The minimum X value for the generated surface points. Defaults to \c{0.0}.
+ * \brief The minimum X value for the generated surface points.
+ *
+ * Defaults to \c{0.0}.
+ *
* When setting this property the corresponding maximum value is adjusted if necessary,
* to ensure that the range remains valid.
*/
@@ -256,7 +270,10 @@ float QHeightMapSurfaceDataProxy::minXValue() const
/*!
* \property QHeightMapSurfaceDataProxy::maxXValue
*
- * The maximum X value for the generated surface points. Defaults to \c{10.0}.
+ * \brief The maximum X value for the generated surface points.
+ *
+ * Defaults to \c{10.0}.
+ *
* When setting this property the corresponding minimum value is adjusted if necessary,
* to ensure that the range remains valid.
*/
@@ -273,7 +290,10 @@ float QHeightMapSurfaceDataProxy::maxXValue() const
/*!
* \property QHeightMapSurfaceDataProxy::minZValue
*
- * The minimum Z value for the generated surface points. Defaults to \c{0.0}.
+ * \brief The minimum Z value for the generated surface points.
+ *
+ * Defaults to \c{0.0}.
+ *
* When setting this property the corresponding maximum value is adjusted if necessary,
* to ensure that the range remains valid.
*/
@@ -290,7 +310,10 @@ float QHeightMapSurfaceDataProxy::minZValue() const
/*!
* \property QHeightMapSurfaceDataProxy::maxZValue
*
- * The maximum Z value for the generated surface points. Defaults to \c{10.0}.
+ * \brief The maximum Z value for the generated surface points.
+ *
+ * Defaults to \c{10.0}.
+ *
* When setting this property the corresponding minimum value is adjusted if necessary,
* to ensure that the range remains valid.
*/
diff --git a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp
index 0d2c8997..d2f63a94 100644
--- a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2016 The Qt Company Ltd.
+** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Data Visualization module of the Qt Toolkit.
@@ -44,13 +44,14 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
*
* Data is resolved asynchronously whenever the mapping or the model changes.
* QSurfaceDataProxy::arrayReset() is emitted when the data has been resolved.
- * However, when useModelCategories property is set to true, single item changes are resolved
+ * However, when useModelCategories property is set to \c true, single item changes are resolved
* synchronously, unless the same frame also contains a change that causes the whole model to be
* resolved.
*
- * There are three ways to use mappings:
+ * Mappings can be used in the following ways:
*
- * 1) If useModelCategories property is set to true, this proxy will map rows and
+ * \list
+ * \li If useModelCategories property is set to \c true, this proxy will map rows and
* columns of QAbstractItemModel to rows and columns of Q3DSurface, and uses the value returned for
* Qt::DisplayRole as Y-position by default. Row and column headers are used for Z-position and
* X-position by default, if they can be converted to floats. Otherwise row and column indices
@@ -59,14 +60,15 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* The Z-position and X-position roles to be used can be redefined if the headers or indices
* are not suitable.
*
- * 2) For models that do not have data already neatly sorted into rows and columns, such as
+ * \li For models that do not have data already neatly sorted into rows and columns, such as
* QAbstractListModel based models, you can define a role from the model to map for each of row,
* column and Y-position.
*
- * 3) If you do not want to include all data contained in the model, or the autogenerated rows and
+ * \li If you do not want to include all data contained in the model, or the autogenerated rows and
* columns are not ordered as you wish, you can specify which rows and columns should be included
* and in which order by defining an explicit list of categories for either or both of rows and
* columns.
+ * \endlist
*
* For example, assume that you have a custom QAbstractItemModel storing surface topography data.
* Each item in the model has the roles "longitude", "latitude", and "height".
@@ -117,40 +119,42 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty model ItemModelSurfaceDataProxy::itemModel
- * The item model.
+ * The item model used as a data source for Surface3D.
*/
/*!
* \qmlproperty string ItemModelSurfaceDataProxy::rowRole
- * Defines the item model role to map into row category.
- * In addition to defining which row the data belongs to, the value indicated by row role
- * is also set as the Z-coordinate value of the QSurfaceDataItem when model data is resolved,
- * unless a separate zPos role is also defined.
+ * The item model role to map to the row category.
+ * In addition to defining which row the data belongs to, the value indicated by the row role
+ * is also set as the Z-coordinate value of QSurfaceDataItem when model data is resolved,
+ * unless a separate z position role is also defined.
*/
/*!
* \qmlproperty string ItemModelSurfaceDataProxy::columnRole
- * Defines the item model role to map into column category.
- * In addition to defining which column the data belongs to, the value indicated by column role
- * is also set as the X-coordinate value of the QSurfaceDataItem when model data is resolved,
- * unless a separate xPos role is also defined.
+ * The item model role to map to the column category.
+ * In addition to defining which column the data belongs to, the value indicated by the column role
+ * is also set as the X-coordinate value of QSurfaceDataItem when model data is resolved,
+ * unless a separate x position role is also defined.
*/
/*!
* \qmlproperty string ItemModelSurfaceDataProxy::xPosRole
- * Defines the item model role to map into X position. If this role is not defined, columnRole is
- * used to determine the X-coordinate value of resolved \l{QSurfaceDataItem}s.
+ * The item model role to map to the X position. If this role is not defined, columnRole is
+ * used to determine the X-coordinate value of the resolved \l{QSurfaceDataItem}
+ * items.
*/
/*!
* \qmlproperty string ItemModelSurfaceDataProxy::yPosRole
- * Defines the item model role to map into Y position.
+ * The item model role to map to the Y position.
*/
/*!
* \qmlproperty string ItemModelSurfaceDataProxy::zPosRole
- * Defines the item model role to map into Z position. If this role is not defined, rowRole is
- * used to determine the Z-coordinate value of resolved \l{QSurfaceDataItem}s.
+ * The item model role to map to the Z position. If this role is not defined, rowRole is
+ * used to determine the Z-coordinate value of resolved \l{QSurfaceDataItem}
+ * items.
*/
/*!
@@ -168,32 +172,32 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty bool ItemModelSurfaceDataProxy::useModelCategories
- * When set to true, the mapping ignores row and column roles and categories, and uses
+ * When set to \c true, the mapping ignores row and column roles and categories, and uses
* the rows and columns from the model instead. Defaults to \c{false}.
*/
/*!
* \qmlproperty bool ItemModelSurfaceDataProxy::autoRowCategories
- * When set to true, the mapping ignores any explicitly set row categories
+ * When set to \c true, the mapping ignores any explicitly set row categories
* and overwrites them with automatically generated ones whenever the
- * data from model is resolved. Proxy minimum and maximum row values are also
- * autogenerated from data when this is set to true. Defaults to \c{true}.
+ * data from the model is resolved. Proxy minimum and maximum row values are also
+ * autogenerated from the data when this is set to \c true. Defaults to \c{true}.
*/
/*!
* \qmlproperty bool ItemModelSurfaceDataProxy::autoColumnCategories
- * When set to true, the mapping ignores any explicitly set column categories
+ * When set to \c true, the mapping ignores any explicitly set column categories
* and overwrites them with automatically generated ones whenever the
- * data from model is resolved. Proxy minimum and maximum column values are also
- * autogenerated from data when this is set to true. Defaults to \c{true}.
+ * data from the model is resolved. Proxy minimum and maximum column values are also
+ * autogenerated from the data when this is set to \c true. Defaults to \c{true}.
*/
/*!
* \qmlproperty regExp ItemModelSurfaceDataProxy::rowRolePattern
*
- * When set, a search and replace is done on the value mapped by row role before it is used as
+ * When set, a search and replace is done on the value mapped by the row role before it is used as
* a row category. This property specifies the regular expression to find the portion of the
- * mapped value to replace and rowRoleReplace property contains the replacement string.
+ * mapped value to replace and the rowRoleReplace property contains the replacement string.
*
* \sa rowRole, rowRoleReplace
*/
@@ -201,9 +205,9 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty regExp ItemModelSurfaceDataProxy::columnRolePattern
*
- * When set, a search and replace is done on the value mapped by column role before it is used
+ * When set, a search and replace is done on the value mapped by the column role before it is used
* as a column category. This property specifies the regular expression to find the portion of the
- * mapped value to replace and columnRoleReplace property contains the replacement string.
+ * mapped value to replace and the columnRoleReplace property contains the replacement string.
*
* \sa columnRole, columnRoleReplace
*/
@@ -211,9 +215,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty regExp ItemModelSurfaceDataProxy::xPosRolePattern
*
- * When set, a search and replace is done on the value mapped by xPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and xPosRoleReplace property contains the replacement string.
+ * When set, a search and replace is done on the value mapped by the x position
+ * role before it is used as an item position value. This property specifies
+ * the regular expression to find the portion of the mapped value to replace and
+ * the xPosRoleReplace property contains the replacement string.
*
* \sa xPosRole, xPosRoleReplace
*/
@@ -221,9 +226,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty regExp ItemModelSurfaceDataProxy::yPosRolePattern
*
- * When set, a search and replace is done on the value mapped by yPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and yPosRoleReplace property contains the replacement string.
+ * When set, a search and replace is done on the value mapped by the y position
+ * role before it is used as an item position value. This property specifies
+ * the regular expression to find the portion of the mapped value to replace and
+ * the yPosRoleReplace property contains the replacement string.
*
* \sa yPosRole, yPosRoleReplace
*/
@@ -231,9 +237,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty regExp ItemModelSurfaceDataProxy::zPosRolePattern
*
- * When set, a search and replace is done on the value mapped by zPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and zPosRoleReplace property contains the replacement string.
+ * When set, a search and replace is done on the value mapped by the z position
+ * role before it is used as an item position value. This property specifies
+ * the regular expression to find the portion of the mapped value to replace and
+ * the zPosRoleReplace property contains the replacement string.
*
* \sa zPosRole, zPosRoleReplace
*/
@@ -241,9 +248,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty string ItemModelSurfaceDataProxy::rowRoleReplace
*
- * This property defines the replace content to be used in conjunction with rowRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * The replace content to be used in conjunction with rowRolePattern.
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
* function documentation.
*
* \sa rowRole, rowRolePattern
@@ -252,9 +260,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty string ItemModelSurfaceDataProxy::columnRoleReplace
*
- * This property defines the replace content to be used in conjunction with columnRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * The replace content to be used in conjunction with columnRolePattern.
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
* function documentation.
*
* \sa columnRole, columnRolePattern
@@ -263,9 +272,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty string ItemModelSurfaceDataProxy::xPosRoleReplace
*
- * This property defines the replace content to be used in conjunction with xPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * The replace content to be used in conjunction with xPosRolePattern.
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
* function documentation.
*
* \sa xPosRole, xPosRolePattern
@@ -274,9 +284,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty string ItemModelSurfaceDataProxy::yPosRoleReplace
*
- * This property defines the replace content to be used in conjunction with yPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * The replace content to be used in conjunction with yPosRolePattern.
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
* function documentation.
*
* \sa yPosRole, yPosRolePattern
@@ -285,9 +296,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty string ItemModelSurfaceDataProxy::zPosRoleReplace
*
- * This property defines the replace content to be used in conjunction with zPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * The replace content to be used in conjunction with zPosRolePattern.
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
* function documentation.
*
* \sa zPosRole, zPosRolePattern
@@ -295,7 +307,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \qmlproperty ItemModelSurfaceDataProxy.MultiMatchBehavior ItemModelSurfaceDataProxy::multiMatchBehavior
- * This property defines how multiple matches for each row/column combination are handled.
+ * Defines how multiple matches for each row/column combination are handled.
* Defaults to \l{QItemModelSurfaceDataProxy::MMBLast}{ItemModelSurfaceDataProxy.MMBLast}.
*
* For example, you might have an item model with timestamped data taken at irregular intervals
@@ -350,7 +362,7 @@ QItemModelSurfaceDataProxy::QItemModelSurfaceDataProxy(QAbstractItemModel *itemM
* ownership of the \a itemModel, as typically item models are owned by other controls.
* The yPosRole role is set to \a yPosRole.
* This constructor is meant to be used with models that have data properly sorted
- * in rows and columns already, so it also sets useModelCategories property to true.
+ * in rows and columns already, so it also sets useModelCategories property to \c true.
*/
QItemModelSurfaceDataProxy::QItemModelSurfaceDataProxy(QAbstractItemModel *itemModel,
const QString &yPosRole,
@@ -481,8 +493,12 @@ QItemModelSurfaceDataProxy::~QItemModelSurfaceDataProxy()
/*!
* \property QItemModelSurfaceDataProxy::itemModel
*
- * Defines item model. Does not take ownership of the model, but does connect to it to listen for
- * changes.
+ * \brief The item model used as a data source for the 3D surface.
+ */
+
+/*!
+ * Sets the item model to \a itemModel. Does not take ownership of the model,
+ * but does connect to it to listen for changes.
*/
void QItemModelSurfaceDataProxy::setItemModel(QAbstractItemModel *itemModel)
{
@@ -497,10 +513,11 @@ QAbstractItemModel *QItemModelSurfaceDataProxy::itemModel() const
/*!
* \property QItemModelSurfaceDataProxy::rowRole
*
- * Defines the item model role to map into row category.
- * In addition to defining which row the data belongs to, the value indicated by row role
- * is also set as the Z-coordinate value of the QSurfaceDataItem when model data is resolved,
- * unless a separate zPos role is also defined.
+ * \brief The item model role to map to the row category.
+ *
+ * In addition to defining which row the data belongs to, the value indicated by the row role
+ * is also set as the Z-coordinate value of QSurfaceDataItem when model data is resolved,
+ * unless a separate z position role is also defined.
*/
void QItemModelSurfaceDataProxy::setRowRole(const QString &role)
{
@@ -518,10 +535,11 @@ QString QItemModelSurfaceDataProxy::rowRole() const
/*!
* \property QItemModelSurfaceDataProxy::columnRole
*
- * Defines the item model role to map into column category.
- * In addition to defining which column the data belongs to, the value indicated by column role
- * is also set as the X-coordinate value of the QSurfaceDataItem when model data is resolved,
- * unless a separate xPos role is also defined.
+ * \brief The item model role to map to the column category.
+ *
+ * In addition to defining which column the data belongs to, the value indicated by the column
+ * role is also set as the X-coordinate value of QSurfaceDataItem when model data is resolved,
+ * unless a separate x position role is also defined.
*/
void QItemModelSurfaceDataProxy::setColumnRole(const QString &role)
{
@@ -539,8 +557,10 @@ QString QItemModelSurfaceDataProxy::columnRole() const
/*!
* \property QItemModelSurfaceDataProxy::xPosRole
*
- * Defines the item model role to map into X position. If this role is not defined, columnRole is
- * used to determine the X-coordinate value of resolved \l{QSurfaceDataItem}s.
+ * \brief The item model role to map to the X position.
+ *
+ * If this role is not defined, columnRole is used to determine the X-coordinate
+ * value of the resolved \l{QSurfaceDataItem} objects.
*/
void QItemModelSurfaceDataProxy::setXPosRole(const QString &role)
{
@@ -558,7 +578,7 @@ QString QItemModelSurfaceDataProxy::xPosRole() const
/*!
* \property QItemModelSurfaceDataProxy::yPosRole
*
- * Defines the item model role to map into Y position.
+ * \brief The item model role to map to the Y position.
*/
void QItemModelSurfaceDataProxy::setYPosRole(const QString &role)
{
@@ -576,8 +596,10 @@ QString QItemModelSurfaceDataProxy::yPosRole() const
/*!
* \property QItemModelSurfaceDataProxy::zPosRole
*
- * Defines the item model role to map into Z position. If this role is not defined, rowRole is
- * used to determine the Z-coordinate value of resolved \l{QSurfaceDataItem}s.
+ * \brief The item model role to map to the Z position.
+ *
+ * If this role is not defined, rowRole is used to determine the Z-coordinate
+ * value of resolved \l{QSurfaceDataItem} objects.
*/
void QItemModelSurfaceDataProxy::setZPosRole(const QString &role)
{
@@ -595,7 +617,7 @@ QString QItemModelSurfaceDataProxy::zPosRole() const
/*!
* \property QItemModelSurfaceDataProxy::rowCategories
*
- * Defines the row \a categories for the mapping.
+ * \brief The row categories for the mapping.
*/
void QItemModelSurfaceDataProxy::setRowCategories(const QStringList &categories)
{
@@ -613,7 +635,7 @@ QStringList QItemModelSurfaceDataProxy::rowCategories() const
/*!
* \property QItemModelSurfaceDataProxy::columnCategories
*
- * Defines the column \a categories for the mapping.
+ * \brief The column categories for the mapping.
*/
void QItemModelSurfaceDataProxy::setColumnCategories(const QStringList &categories)
{
@@ -631,7 +653,9 @@ QStringList QItemModelSurfaceDataProxy::columnCategories() const
/*!
* \property QItemModelSurfaceDataProxy::useModelCategories
*
- * When set to true, the mapping ignores row and column roles and categories, and uses
+ * \brief Whether row and column roles and categories are used for mapping.
+ *
+ * When set to \c true, the mapping ignores row and column roles and categories, and uses
* the rows and columns from the model instead. Defaults to \c{false}.
*/
void QItemModelSurfaceDataProxy::setUseModelCategories(bool enable)
@@ -650,9 +674,11 @@ bool QItemModelSurfaceDataProxy::useModelCategories() const
/*!
* \property QItemModelSurfaceDataProxy::autoRowCategories
*
- * When set to true, the mapping ignores any explicitly set row categories
+ * \brief Whether row categories are generated automatically.
+ *
+ * When set to \c true, the mapping ignores any explicitly set row categories
* and overwrites them with automatically generated ones whenever the
- * data from model is resolved. Defaults to \c{true}.
+ * data from the model is resolved. Defaults to \c{true}.
*/
void QItemModelSurfaceDataProxy::setAutoRowCategories(bool enable)
{
@@ -670,9 +696,11 @@ bool QItemModelSurfaceDataProxy::autoRowCategories() const
/*!
* \property QItemModelSurfaceDataProxy::autoColumnCategories
*
- * When set to true, the mapping ignores any explicitly set column categories
+ * \brief Whether column categories are generated automatically.
+ *
+ * When set to \c true, the mapping ignores any explicitly set column categories
* and overwrites them with automatically generated ones whenever the
- * data from model is resolved. Defaults to \c{true}.
+ * data from the model is resolved. Defaults to \c{true}.
*/
void QItemModelSurfaceDataProxy::setAutoColumnCategories(bool enable)
{
@@ -709,7 +737,7 @@ void QItemModelSurfaceDataProxy::remap(const QString &rowRole,
}
/*!
- * \return index of the specified \a category in row categories list.
+ * Returns the index of the specified \a category in the row categories list.
* If the row categories list is empty, -1 is returned.
* \note If the automatic row categories generation is in use, this method will
* not return a valid index before the data in the model is resolved for the first time.
@@ -720,7 +748,7 @@ int QItemModelSurfaceDataProxy::rowCategoryIndex(const QString &category)
}
/*!
- * \return index of the specified \a category in column categories list.
+ * Returns the index of the specified \a category in the column categories list.
* If the category is not found, -1 is returned.
* \note If the automatic column categories generation is in use, this method will
* not return a valid index before the data in the model is resolved for the first time.
@@ -733,9 +761,12 @@ int QItemModelSurfaceDataProxy::columnCategoryIndex(const QString &category)
/*!
* \property QItemModelSurfaceDataProxy::rowRolePattern
*
- * When set, a search and replace is done on the value mapped by row role before it is used as
- * a row category. This property specifies the regular expression to find the portion of the
- * mapped value to replace and rowRoleReplace property contains the replacement string.
+ * \brief Whether a search and replace is performed on the value mapped by the
+ * row role before it is used as a row category.
+ *
+ * This property specifies the regular expression to find the portion of the
+ * mapped value to replace and the rowRoleReplace property contains the
+ * replacement string.
*
* \sa rowRole, rowRoleReplace
*/
@@ -755,9 +786,12 @@ QRegExp QItemModelSurfaceDataProxy::rowRolePattern() const
/*!
* \property QItemModelSurfaceDataProxy::columnRolePattern
*
- * When set, a search and replace is done on the value mapped by column role before it is used
- * as a column category. This property specifies the regular expression to find the portion of the
- * mapped value to replace and columnRoleReplace property contains the replacement string.
+ * \brief Whether a search and replace is done on the value mapped by the column
+ * role before it is used as a column category.
+ *
+ * This property specifies the regular expression to find the portion of the
+ * mapped value to replace and the columnRoleReplace property contains the
+ * replacement string.
*
* \sa columnRole, columnRoleReplace
*/
@@ -777,9 +811,12 @@ QRegExp QItemModelSurfaceDataProxy::columnRolePattern() const
/*!
* \property QItemModelSurfaceDataProxy::xPosRolePattern
*
- * When set, a search and replace is done on the value mapped by xPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and xPosRoleReplace property contains the replacement string.
+ * \brief Whether a search and replace is done on the value mapped by the x
+ * position role before it is used as an item position value.
+ *
+ * This property specifies the regular expression to find the portion of the
+ * mapped value to replace and the xPosRoleReplace property contains the
+ * replacement string.
*
* \sa xPosRole, xPosRoleReplace
*/
@@ -799,9 +836,12 @@ QRegExp QItemModelSurfaceDataProxy::xPosRolePattern() const
/*!
* \property QItemModelSurfaceDataProxy::yPosRolePattern
*
- * When set, a search and replace is done on the value mapped by yPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and yPosRoleReplace property contains the replacement string.
+ * \brief Whether a search and replace is done on the value mapped by the y
+ * position role before it is used as an item position value.
+ *
+ * This property specifies the regular expression to find the portion of the
+ * mapped value to replace and the yPosRoleReplace property contains the
+ * replacement string.
*
* \sa yPosRole, yPosRoleReplace
*/
@@ -821,9 +861,12 @@ QRegExp QItemModelSurfaceDataProxy::yPosRolePattern() const
/*!
* \property QItemModelSurfaceDataProxy::zPosRolePattern
*
- * When set, a search and replace is done on the value mapped by zPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and zPosRoleReplace property contains the replacement string.
+ * \brief Whether a search and replace is done on the value mapped by the z
+ * position role before it is used as an item position value.
+ *
+ * This property specifies the regular expression to find the portion of the
+ * mapped value to replace and the zPosRoleReplace property contains the
+ * replacement string.
*
* \sa zPosRole, zPosRoleReplace
*/
@@ -843,8 +886,10 @@ QRegExp QItemModelSurfaceDataProxy::zPosRolePattern() const
/*!
* \property QItemModelSurfaceDataProxy::rowRoleReplace
*
- * This property defines the replace content to be used in conjunction with rowRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
+ * \brief The replace content to be used in conjunction with the row role
+ * pattern.
+ *
+ * Defaults to an empty string. For more information on how the search and replace using regular
* expressions works, see QString::replace(const QRegExp &rx, const QString &after)
* function documentation.
*
@@ -866,9 +911,12 @@ QString QItemModelSurfaceDataProxy::rowRoleReplace() const
/*!
* \property QItemModelSurfaceDataProxy::columnRoleReplace
*
- * This property defines the replace content to be used in conjunction with columnRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * \brief The replace content to be used in conjunction with a column role
+ * pattern.
+ *
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
* function documentation.
*
* \sa columnRole, columnRolePattern
@@ -889,9 +937,12 @@ QString QItemModelSurfaceDataProxy::columnRoleReplace() const
/*!
* \property QItemModelSurfaceDataProxy::xPosRoleReplace
*
- * This property defines the replace content to be used in conjunction with xPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * \brief The replace content to be used in conjunction with an x position role
+ * pattern.
+ *
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
* function documentation.
*
* \sa xPosRole, xPosRolePattern
@@ -912,9 +963,12 @@ QString QItemModelSurfaceDataProxy::xPosRoleReplace() const
/*!
* \property QItemModelSurfaceDataProxy::yPosRoleReplace
*
- * This property defines the replace content to be used in conjunction with yPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * \brief The replace content to be used in conjunction with an y position role
+ * pattern.
+ *
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
* function documentation.
*
* \sa yPosRole, yPosRolePattern
@@ -935,9 +989,12 @@ QString QItemModelSurfaceDataProxy::yPosRoleReplace() const
/*!
* \property QItemModelSurfaceDataProxy::zPosRoleReplace
*
- * This property defines the replace content to be used in conjunction with zPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * \brief The replace content to be used in conjunction with a z position role
+ * pattern.
+ *
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
* function documentation.
*
* \sa zPosRole, zPosRolePattern
@@ -958,13 +1015,14 @@ QString QItemModelSurfaceDataProxy::zPosRoleReplace() const
/*!
* \property QItemModelSurfaceDataProxy::multiMatchBehavior
*
- * This property defines how multiple matches for each row/column combination are handled.
- * Defaults to QItemModelSurfaceDataProxy::MMBLast.
+ * \brief How multiple matches for each row/column combination are handled.
+ *
+ * Defaults to MMBLast.
*
* For example, you might have an item model with timestamped data taken at irregular intervals
* and you want to visualize an average position of data items on each hour with a surface graph.
* This can be done by specifying row and column categories so that each surface point represents
- * an hour, and setting multiMatchBehavior to QItemModelSurfaceDataProxy::MMBAverage.
+ * an hour, and setting this property to MMBAverage.
*/
void QItemModelSurfaceDataProxy::setMultiMatchBehavior(QItemModelSurfaceDataProxy::MultiMatchBehavior behavior)