summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/axis
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2017-02-10 16:54:43 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2017-02-10 16:06:14 +0000
commit25aeaddbfb62a705ea447b19e4d1771d603bde2b (patch)
tree7501e0aa118c555e42115ac5fc8b247dedc07640 /src/datavisualization/axis
parentf750a084bec3062b1531e299e880043cfa19d6e7 (diff)
Doc: Add \brief commands for property docs (axis)v5.9.0-alpha1
Adjust the text as necessary. Also remove \a commands, because properties don't take arguments. Change-Id: I9f2198e383806de6a4f06745f1398d67aee4ac09 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Diffstat (limited to 'src/datavisualization/axis')
-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
4 files changed, 72 insertions, 35 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.