Doc: Add \brief commands for property docs (QBar3DSeries)

Separate documentation for setSelectedBar() from the property docs.

Change-Id: Iaf9e6b2cfeccd47cb5b3fee2fa8cd8baa43b8fcd
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>

1 files changed, 36 insertions, 17 deletions

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
  *