summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2017-02-27 09:50:14 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2017-02-27 09:17:38 +0000
commit5799a84b1d36587eb61b52721f4315ef94b4152c (patch)
tree26954af5b0f3fe3ddee87206faf48805af4b3a02 /src/datavisualization/doc
parentbf772e8914580767f83fd55eaa265cd2719897cb (diff)
Doc: Fix QDoc commands (Q3dBars)
Change-Id: I75cb18ad5ea6b7c88c940d52ccb82753fcc0c7c7 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Diffstat (limited to 'src/datavisualization/doc')
-rw-r--r--src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc49
1 files changed, 33 insertions, 16 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
index 5f625a96..0149c805 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-bars3d.qdoc
@@ -55,16 +55,18 @@
* The active row axis.
*
* If an axis is not given, a temporary default axis with no labels is created.
- * This temporary axis is destroyed if another axis is explicitly set to same orientation.
+ * This temporary axis is destroyed if another axis is explicitly set to the
+ * same orientation.
*/
/*!
* \qmlproperty ValueAxis3D Bars3D::valueAxis
* The active value axis.
*
- * If an axis is not given, a temporary default axis with no labels and automatically adjusting
- * range is created.
- * This temporary axis is destroyed if another axis is explicitly set to same orientation.
+ * If an axis is not given, a temporary default axis with no labels and an
+ * automatically adjusting range is created.
+ * This temporary axis is destroyed if another axis is explicitly set to the
+ * same orientation.
*/
/*!
@@ -72,64 +74,79 @@
* The active column axis.
*
* If an axis is not given, a temporary default axis with no labels is created.
- * This temporary axis is destroyed if another axis is explicitly set to same orientation.
+ * This temporary axis is destroyed if another axis is explicitly set to the
+ * same orientation.
*/
/*!
* \qmlproperty bool Bars3D::multiSeriesUniform
- * This property controls if bars are to be scaled with proportions set to a single series bar even
+ * Defines whether bars are to be scaled with proportions set to a single series bar even
* if there are multiple series displayed. If set to \c {true}, \l{barSpacing}{bar spacing} will
- * affect only X-axis correctly. It is preset to \c false by default.
+ * be correctly applied only to the X-axis. Preset to \c false by default.
*/
/*!
* \qmlproperty real Bars3D::barThickness
- * Bar thickness ratio between X and Z dimensions. 1.0 means bars are as wide as they are deep, 0.5
+ * The bar thickness ratio between the X and Z dimensions. The value \c 1.0
+ * means that the bars are as wide as they are deep, whereas \c 0.5
* makes them twice as deep as they are wide.
*/
/*!
* \qmlproperty size Bars3D::barSpacing
* Bar spacing in X and Z dimensions.
+ *
+ * Preset to \c {(1.0, 1.0)} by default. Spacing is affected by the
+ * barSpacingRelative property.
*/
/*!
* \qmlproperty bool Bars3D::barSpacingRelative
- * Relative or absolute bar spacing.
+ * Whether spacing is absolute or relative to bar thickness.
+ *
+ * If \c true, the value of \c 0.0 means that the bars are placed
+ * side-to-side, \c 1.0 means that a space as wide as the thickness of one bar
+ * is left between the bars, and so on. Preset to \c true.
*/
/*!
* \qmlproperty Bar3DSeries Bars3D::selectedSeries
* The selected series or \c null. If \l {QAbstract3DGraph::selectionMode}{selectionMode} has
- * \c SelectionMultiSeries flag set, this property holds the series which owns the selected bar.
+ * the \c SelectionMultiSeries flag set, this property holds the series that
+ * owns the selected bar.
*/
/*!
* \qmlproperty list<Bar3DSeries> Bars3D::seriesList
* \default
- * This property holds the series of the graph.
+ * The series of the graph.
* By default, this property contains an empty list.
* To set the series, either use the addSeries() function or define them as children of the graph.
*/
/*!
* \qmlproperty Bar3DSeries Bars3D::primarySeries
- * Specifies the \a series that is the primary series of the graph. The primary series
+ * The primary series of the graph. It
* is used to determine the row and column axis labels when the labels are not explicitly
* set to the axes.
- * If the specified \a series is not already added to the graph, setting it as the
+ *
+ * If the specified series is not yet added to the graph, setting it as the
* primary series will also implicitly add it to the graph.
+ *
* If the primary series itself is removed from the graph, this property
* resets to default.
- * If \a series is null, this property resets to default.
+ *
+ * If the series is null, this property resets to default.
* Defaults to the first added series or zero if no series are added to the graph.
*/
/*!
* \qmlproperty real Bars3D::floorLevel
*
- * The desired floor level for the bar graph in Y-axis data coordinates.
- * The actual floor level cannot go below Y-axis minimum or above Y-axis maximum.
+ * The floor level for the bar graph in Y-axis data coordinates.
+ *
+ * The actual floor level will be restricted by the Y-axis minimum and maximum
+ * values.
* Defaults to zero.
*/