From 782a5c2e5e05442430704ec5a549558dd73aaee3 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@qt.io>
Date: Wed, 22 Feb 2017 16:54:48 +0100
Subject: Doc: Fix QDoc commands (QScatterDataProxy)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Add \brief commands for property docs
- Replace \returns with "Returns".

Change-Id: I49b67c8a86135666e43c89f787a0821b48b5587a
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
---
 src/datavisualization/data/qscatterdataproxy.cpp | 21 ++++++++++-----------
 1 file changed, 10 insertions(+), 11 deletions(-)

(limited to 'src/datavisualization/data/qscatterdataproxy.cpp')

diff --git a/src/datavisualization/data/qscatterdataproxy.cpp b/src/datavisualization/data/qscatterdataproxy.cpp
index 1fe5b3fc..8d1626cf 100644
--- a/src/datavisualization/data/qscatterdataproxy.cpp
+++ b/src/datavisualization/data/qscatterdataproxy.cpp
@@ -41,7 +41,8 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
  *
  * QScatterDataProxy handles adding, inserting, changing, and removing data items.
  *
- * QScatterDataProxy takes ownership of all QScatterDataArrays and QScatterDataItems passed to it.
+ * QScatterDataProxy takes ownership of all QScatterDataArray and QScatterDataItem
+ * objects passed to it.
  *
  * \sa {Qt Data Visualization Data Handling}
  */
@@ -66,14 +67,12 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
  *
  * This type is uncreatable, but contains properties that are exposed via subtypes.
  *
- * For more complete description, see QScatterDataProxy.
- *
  * \sa ItemModelScatterDataProxy, {Qt Data Visualization Data Handling}
  */
 
 /*!
  * \qmlproperty int ScatterDataProxy::itemCount
- * Item count in the array.
+ * The number of items in the array.
  */
 
 /*!
@@ -108,7 +107,7 @@ QScatterDataProxy::~QScatterDataProxy()
 /*!
  * \property QScatterDataProxy::series
  *
- *  The series this proxy is attached to.
+ * \brief The series this proxy is attached to.
  */
 QScatter3DSeries *QScatterDataProxy::series() const
 {
@@ -151,7 +150,7 @@ void QScatterDataProxy::setItems(int index, const QScatterDataArray &items)
 /*!
  * Adds a single \a item to the end of the array.
  *
- * \return index of the added item.
+ * Returns the index of the added item.
  */
 int QScatterDataProxy::addItem(const QScatterDataItem &item)
 {
@@ -164,7 +163,7 @@ int QScatterDataProxy::addItem(const QScatterDataItem &item)
 /*!
  * Adds \a items to the end of the array.
  *
- * \return index of the first added item.
+ * Returns the index of the first added item.
  */
 int QScatterDataProxy::addItems(const QScatterDataArray &items)
 {
@@ -212,7 +211,7 @@ void QScatterDataProxy::removeItems(int index, int removeCount)
 /*!
  * \property QScatterDataProxy::itemCount
  *
- * \return item count in the array.
+ * \brief The number of items in the array.
  */
 int QScatterDataProxy::itemCount() const
 {
@@ -220,7 +219,7 @@ int QScatterDataProxy::itemCount() const
 }
 
 /*!
- * \return pointer to the data array.
+ * Returns the pointer to the data array.
  */
 const QScatterDataArray *QScatterDataProxy::array() const
 {
@@ -228,8 +227,8 @@ const QScatterDataArray *QScatterDataProxy::array() const
 }
 
 /*!
- * \return pointer to the item at \a index. It is guaranteed to be valid only until next call
- * that modifies data.
+ * Returns the pointer to the item at the index \a index. It is guaranteed to be
+ * valid only until the next call that modifies data.
  */
 const QScatterDataItem *QScatterDataProxy::itemAt(int index) const
 {
-- 
cgit v1.2.3