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>

1 files changed, 14 insertions, 4 deletions

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.