Doc: Fix QDoc commands (QItemModelSurfaceDataProxy)

- Add \brief commands for property docs.
- Replace \return with "Returns".
- Use the \c command to format "true".
- Edit the text where necessary.

Change-Id: I9ab1f5ed2c242118990d08da8114012899d88289
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>

1 files changed, 171 insertions, 113 deletions

diff --git a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp b/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp
index 0d2c8997..d2f63a94 100644
--- a/src/datavisualization/data/qitemmodelsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qitemmodelsurfacedataproxy.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.
@@ -44,13 +44,14 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
  *
  * Data is resolved asynchronously whenever the mapping or the model changes.
  * QSurfaceDataProxy::arrayReset() is emitted when the data has been resolved.
- * However, when useModelCategories property is set to true, single item changes are resolved
+ * However, when useModelCategories property is set to \c true, single item changes are resolved
  * synchronously, unless the same frame also contains a change that causes the whole model to be
  * resolved.
  *
- * There are three ways to use mappings:
+ * Mappings can be used in the following ways:
  *
- * 1) If useModelCategories property is set to true, this proxy will map rows and
+ * \list
+ * \li If useModelCategories property is set to \c true, this proxy will map rows and
  *    columns of QAbstractItemModel to rows and columns of Q3DSurface, and uses the value returned for
  *    Qt::DisplayRole as Y-position by default. Row and column headers are used for Z-position and
  *    X-position by default, if they can be converted to floats. Otherwise row and column indices
@@ -59,14 +60,15 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
  *    The Z-position and X-position roles to be used can be redefined if the headers or indices
  *    are not suitable.
  *
- * 2) For models that do not have data already neatly sorted into rows and columns, such as
+ * \li For models that do not have data already neatly sorted into rows and columns, such as
  *    QAbstractListModel based models, you can define a role from the model to map for each of row,
  *    column and Y-position.
  *
- * 3) If you do not want to include all data contained in the model, or the autogenerated rows and
+ * \li If you do not want to include all data contained in the model, or the autogenerated rows and
  *    columns are not ordered as you wish, you can specify which rows and columns should be included
  *    and in which order by defining an explicit list of categories for either or both of rows and
  *    columns.
+ * \endlist
  *
  * For example, assume that you have a custom QAbstractItemModel storing surface topography data.
  * Each item in the model has the roles "longitude", "latitude", and "height".
@@ -117,40 +119,42 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 
 /*!
  * \qmlproperty model ItemModelSurfaceDataProxy::itemModel
- * The item model.
+ * The item model used as a data source for Surface3D.
  */
 
 /*!
  * \qmlproperty string ItemModelSurfaceDataProxy::rowRole
- * Defines the item model role to map into row category.
- * In addition to defining which row the data belongs to, the value indicated by row role
- * is also set as the Z-coordinate value of the QSurfaceDataItem when model data is resolved,
- * unless a separate zPos role is also defined.
+ * The item model role to map to the row category.
+ * In addition to defining which row the data belongs to, the value indicated by the row role
+ * is also set as the Z-coordinate value of QSurfaceDataItem when model data is resolved,
+ * unless a separate z position role is also defined.
  */
 
 /*!
  * \qmlproperty string ItemModelSurfaceDataProxy::columnRole
- * Defines the item model role to map into column category.
- * In addition to defining which column the data belongs to, the value indicated by column role
- * is also set as the X-coordinate value of the QSurfaceDataItem when model data is resolved,
- * unless a separate xPos role is also defined.
+ * The item model role to map to the column category.
+ * In addition to defining which column the data belongs to, the value indicated by the column role
+ * is also set as the X-coordinate value of QSurfaceDataItem when model data is resolved,
+ * unless a separate x position role is also defined.
  */
 
 /*!
  * \qmlproperty string ItemModelSurfaceDataProxy::xPosRole
- * Defines the item model role to map into X position. If this role is not defined, columnRole is
- * used to determine the X-coordinate value of resolved \l{QSurfaceDataItem}s.
+ * The item model role to map to the X position. If this role is not defined, columnRole is
+ * used to determine the X-coordinate value of the resolved \l{QSurfaceDataItem}
+ * items.
  */
 
 /*!
  * \qmlproperty string ItemModelSurfaceDataProxy::yPosRole
- * Defines the item model role to map into Y position.
+ * The item model role to map to the Y position.
  */
 
 /*!
  * \qmlproperty string ItemModelSurfaceDataProxy::zPosRole
- * Defines the item model role to map into Z position. If this role is not defined, rowRole is
- * used to determine the Z-coordinate value of resolved \l{QSurfaceDataItem}s.
+ * The item model role to map to the Z position. If this role is not defined, rowRole is
+ * used to determine the Z-coordinate value of resolved \l{QSurfaceDataItem}
+ * items.
  */
 
 /*!
@@ -168,32 +172,32 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 
 /*!
  * \qmlproperty bool ItemModelSurfaceDataProxy::useModelCategories
- * When set to true, the mapping ignores row and column roles and categories, and uses
+ * When set to \c true, the mapping ignores row and column roles and categories, and uses
  * the rows and columns from the model instead. Defaults to \c{false}.
  */
 
 /*!
  * \qmlproperty bool ItemModelSurfaceDataProxy::autoRowCategories
- * When set to true, the mapping ignores any explicitly set row categories
+ * When set to \c true, the mapping ignores any explicitly set row categories
  * and overwrites them with automatically generated ones whenever the
- * data from model is resolved. Proxy minimum and maximum row values are also
- * autogenerated from data when this is set to true. Defaults to \c{true}.
+ * data from the model is resolved. Proxy minimum and maximum row values are also
+ * autogenerated from the data when this is set to \c true. Defaults to \c{true}.
  */
 
 /*!
  * \qmlproperty bool ItemModelSurfaceDataProxy::autoColumnCategories
- * When set to true, the mapping ignores any explicitly set column categories
+ * When set to \c true, the mapping ignores any explicitly set column categories
  * and overwrites them with automatically generated ones whenever the
- * data from model is resolved. Proxy minimum and maximum column values are also
- * autogenerated from data when this is set to true. Defaults to \c{true}.
+ * data from the model is resolved. Proxy minimum and maximum column values are also
+ * autogenerated from the data when this is set to \c true. Defaults to \c{true}.
  */
 
 /*!
  * \qmlproperty regExp ItemModelSurfaceDataProxy::rowRolePattern
  *
- * When set, a search and replace is done on the value mapped by row role before it is used as
+ * When set, a search and replace is done on the value mapped by the row role before it is used as
  * a row category. This property specifies the regular expression to find the portion of the
- * mapped value to replace and rowRoleReplace property contains the replacement string.
+ * mapped value to replace and the rowRoleReplace property contains the replacement string.
  *
  * \sa rowRole, rowRoleReplace
  */
@@ -201,9 +205,9 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 /*!
  * \qmlproperty regExp ItemModelSurfaceDataProxy::columnRolePattern
  *
- * When set, a search and replace is done on the value mapped by column role before it is used
+ * When set, a search and replace is done on the value mapped by the column role before it is used
  * as a column category. This property specifies the regular expression to find the portion of the
- * mapped value to replace and columnRoleReplace property contains the replacement string.
+ * mapped value to replace and the columnRoleReplace property contains the replacement string.
  *
  * \sa columnRole, columnRoleReplace
  */
@@ -211,9 +215,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 /*!
  * \qmlproperty regExp ItemModelSurfaceDataProxy::xPosRolePattern
  *
- * When set, a search and replace is done on the value mapped by xPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and xPosRoleReplace property contains the replacement string.
+ * When set, a search and replace is done on the value mapped by the x position
+ * role before it is used as an item position value. This property specifies
+ * the regular expression to find the portion of the mapped value to replace and
+ * the xPosRoleReplace property contains the replacement string.
  *
  * \sa xPosRole, xPosRoleReplace
  */
@@ -221,9 +226,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 /*!
  * \qmlproperty regExp ItemModelSurfaceDataProxy::yPosRolePattern
  *
- * When set, a search and replace is done on the value mapped by yPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and yPosRoleReplace property contains the replacement string.
+ * When set, a search and replace is done on the value mapped by the y position
+ * role before it is used as an item position value. This property specifies
+ * the regular expression to find the portion of the mapped value to replace and
+ * the yPosRoleReplace property contains the replacement string.
  *
  * \sa yPosRole, yPosRoleReplace
  */
@@ -231,9 +237,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 /*!
  * \qmlproperty regExp ItemModelSurfaceDataProxy::zPosRolePattern
  *
- * When set, a search and replace is done on the value mapped by zPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and zPosRoleReplace property contains the replacement string.
+ * When set, a search and replace is done on the value mapped by the z position
+ * role before it is used as an item position value. This property specifies
+ * the regular expression to find the portion of the mapped value to replace and
+ * the zPosRoleReplace property contains the replacement string.
  *
  * \sa zPosRole, zPosRoleReplace
  */
@@ -241,9 +248,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 /*!
  * \qmlproperty string ItemModelSurfaceDataProxy::rowRoleReplace
  *
- * This property defines the replace content to be used in conjunction with rowRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * The replace content to be used in conjunction with rowRolePattern.
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
  * function documentation.
  *
  * \sa rowRole, rowRolePattern
@@ -252,9 +260,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 /*!
  * \qmlproperty string ItemModelSurfaceDataProxy::columnRoleReplace
  *
- * This property defines the replace content to be used in conjunction with columnRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * The replace content to be used in conjunction with columnRolePattern.
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
  * function documentation.
  *
  * \sa columnRole, columnRolePattern
@@ -263,9 +272,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 /*!
  * \qmlproperty string ItemModelSurfaceDataProxy::xPosRoleReplace
  *
- * This property defines the replace content to be used in conjunction with xPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * The replace content to be used in conjunction with xPosRolePattern.
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
  * function documentation.
  *
  * \sa xPosRole, xPosRolePattern
@@ -274,9 +284,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 /*!
  * \qmlproperty string ItemModelSurfaceDataProxy::yPosRoleReplace
  *
- * This property defines the replace content to be used in conjunction with yPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * The replace content to be used in conjunction with yPosRolePattern.
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
  * function documentation.
  *
  * \sa yPosRole, yPosRolePattern
@@ -285,9 +296,10 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 /*!
  * \qmlproperty string ItemModelSurfaceDataProxy::zPosRoleReplace
  *
- * This property defines the replace content to be used in conjunction with zPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * The replace content to be used in conjunction with zPosRolePattern.
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
  * function documentation.
  *
  * \sa zPosRole, zPosRolePattern
@@ -295,7 +307,7 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
 
 /*!
  * \qmlproperty ItemModelSurfaceDataProxy.MultiMatchBehavior ItemModelSurfaceDataProxy::multiMatchBehavior
- * This property defines how multiple matches for each row/column combination are handled.
+ * Defines how multiple matches for each row/column combination are handled.
  * Defaults to \l{QItemModelSurfaceDataProxy::MMBLast}{ItemModelSurfaceDataProxy.MMBLast}.
  *
  * For example, you might have an item model with timestamped data taken at irregular intervals
@@ -350,7 +362,7 @@ QItemModelSurfaceDataProxy::QItemModelSurfaceDataProxy(QAbstractItemModel *itemM
  * ownership of the \a itemModel, as typically item models are owned by other controls.
  * The yPosRole role is set to \a yPosRole.
  * This constructor is meant to be used with models that have data properly sorted
- * in rows and columns already, so it also sets useModelCategories property to true.
+ * in rows and columns already, so it also sets useModelCategories property to \c true.
  */
 QItemModelSurfaceDataProxy::QItemModelSurfaceDataProxy(QAbstractItemModel *itemModel,
                                                        const QString &yPosRole,
@@ -481,8 +493,12 @@ QItemModelSurfaceDataProxy::~QItemModelSurfaceDataProxy()
 /*!
  * \property QItemModelSurfaceDataProxy::itemModel
  *
- * Defines item model. Does not take ownership of the model, but does connect to it to listen for
- * changes.
+ * \brief The item model used as a data source for the 3D surface.
+ */
+
+/*!
+ * Sets the item model to \a itemModel. Does not take ownership of the model,
+ * but does connect to it to listen for changes.
  */
 void QItemModelSurfaceDataProxy::setItemModel(QAbstractItemModel *itemModel)
 {
@@ -497,10 +513,11 @@ QAbstractItemModel *QItemModelSurfaceDataProxy::itemModel() const
 /*!
  * \property QItemModelSurfaceDataProxy::rowRole
  *
- * Defines the item model role to map into row category.
- * In addition to defining which row the data belongs to, the value indicated by row role
- * is also set as the Z-coordinate value of the QSurfaceDataItem when model data is resolved,
- * unless a separate zPos role is also defined.
+ * \brief The item model role to map to the row category.
+ *
+ * In addition to defining which row the data belongs to, the value indicated by the row role
+ * is also set as the Z-coordinate value of QSurfaceDataItem when model data is resolved,
+ * unless a separate z position role is also defined.
  */
 void QItemModelSurfaceDataProxy::setRowRole(const QString &role)
 {
@@ -518,10 +535,11 @@ QString QItemModelSurfaceDataProxy::rowRole() const
 /*!
  * \property QItemModelSurfaceDataProxy::columnRole
  *
- * Defines the item model role to map into column category.
- * In addition to defining which column the data belongs to, the value indicated by column role
- * is also set as the X-coordinate value of the QSurfaceDataItem when model data is resolved,
- * unless a separate xPos role is also defined.
+ * \brief The item model role to map to the column category.
+ *
+ * In addition to defining which column the data belongs to, the value indicated by the column
+ * role is also set as the X-coordinate value of QSurfaceDataItem when model data is resolved,
+ * unless a separate x position role is also defined.
  */
 void QItemModelSurfaceDataProxy::setColumnRole(const QString &role)
 {
@@ -539,8 +557,10 @@ QString QItemModelSurfaceDataProxy::columnRole() const
 /*!
  * \property QItemModelSurfaceDataProxy::xPosRole
  *
- * Defines the item model role to map into X position. If this role is not defined, columnRole is
- * used to determine the X-coordinate value of resolved \l{QSurfaceDataItem}s.
+ * \brief The item model role to map to the X position.
+ *
+ * If this role is not defined, columnRole is used to determine the X-coordinate
+ * value of the resolved \l{QSurfaceDataItem} objects.
  */
 void QItemModelSurfaceDataProxy::setXPosRole(const QString &role)
 {
@@ -558,7 +578,7 @@ QString QItemModelSurfaceDataProxy::xPosRole() const
 /*!
  * \property QItemModelSurfaceDataProxy::yPosRole
  *
- * Defines the item model role to map into Y position.
+ * \brief The item model role to map to the Y position.
  */
 void QItemModelSurfaceDataProxy::setYPosRole(const QString &role)
 {
@@ -576,8 +596,10 @@ QString QItemModelSurfaceDataProxy::yPosRole() const
 /*!
  * \property QItemModelSurfaceDataProxy::zPosRole
  *
- * Defines the item model role to map into Z position. If this role is not defined, rowRole is
- * used to determine the Z-coordinate value of resolved \l{QSurfaceDataItem}s.
+ * \brief The item model role to map to the Z position.
+ *
+ * If this role is not defined, rowRole is used to determine the Z-coordinate
+ * value of resolved \l{QSurfaceDataItem} objects.
  */
 void QItemModelSurfaceDataProxy::setZPosRole(const QString &role)
 {
@@ -595,7 +617,7 @@ QString QItemModelSurfaceDataProxy::zPosRole() const
 /*!
  * \property QItemModelSurfaceDataProxy::rowCategories
  *
- * Defines the row \a categories for the mapping.
+ * \brief The row categories for the mapping.
  */
 void QItemModelSurfaceDataProxy::setRowCategories(const QStringList &categories)
 {
@@ -613,7 +635,7 @@ QStringList QItemModelSurfaceDataProxy::rowCategories() const
 /*!
  * \property QItemModelSurfaceDataProxy::columnCategories
  *
- * Defines the column \a categories for the mapping.
+ * \brief The column categories for the mapping.
  */
 void QItemModelSurfaceDataProxy::setColumnCategories(const QStringList &categories)
 {
@@ -631,7 +653,9 @@ QStringList QItemModelSurfaceDataProxy::columnCategories() const
 /*!
  * \property QItemModelSurfaceDataProxy::useModelCategories
  *
- * When set to true, the mapping ignores row and column roles and categories, and uses
+ * \brief Whether row and column roles and categories are used for mapping.
+ *
+ * When set to \c true, the mapping ignores row and column roles and categories, and uses
  * the rows and columns from the model instead. Defaults to \c{false}.
  */
 void QItemModelSurfaceDataProxy::setUseModelCategories(bool enable)
@@ -650,9 +674,11 @@ bool QItemModelSurfaceDataProxy::useModelCategories() const
 /*!
  * \property QItemModelSurfaceDataProxy::autoRowCategories
  *
- * When set to true, the mapping ignores any explicitly set row categories
+ * \brief Whether row categories are generated automatically.
+ *
+ * When set to \c true, the mapping ignores any explicitly set row categories
  * and overwrites them with automatically generated ones whenever the
- * data from model is resolved. Defaults to \c{true}.
+ * data from the model is resolved. Defaults to \c{true}.
  */
 void QItemModelSurfaceDataProxy::setAutoRowCategories(bool enable)
 {
@@ -670,9 +696,11 @@ bool QItemModelSurfaceDataProxy::autoRowCategories() const
 /*!
  * \property QItemModelSurfaceDataProxy::autoColumnCategories
  *
- * When set to true, the mapping ignores any explicitly set column categories
+ * \brief Whether column categories are generated automatically.
+ *
+ * When set to \c true, the mapping ignores any explicitly set column categories
  * and overwrites them with automatically generated ones whenever the
- * data from model is resolved. Defaults to \c{true}.
+ * data from the model is resolved. Defaults to \c{true}.
  */
 void QItemModelSurfaceDataProxy::setAutoColumnCategories(bool enable)
 {
@@ -709,7 +737,7 @@ void QItemModelSurfaceDataProxy::remap(const QString &rowRole,
 }
 
 /*!
- * \return index of the specified \a category in row categories list.
+ * Returns the index of the specified \a category in the row categories list.
  * If the row categories list is empty, -1 is returned.
  * \note If the automatic row categories generation is in use, this method will
  * not return a valid index before the data in the model is resolved for the first time.
@@ -720,7 +748,7 @@ int QItemModelSurfaceDataProxy::rowCategoryIndex(const QString &category)
 }
 
 /*!
- * \return index of the specified \a category in column categories list.
+ * Returns the index of the specified \a category in the column categories list.
  * If the category is not found, -1 is returned.
  * \note If the automatic column categories generation is in use, this method will
  * not return a valid index before the data in the model is resolved for the first time.
@@ -733,9 +761,12 @@ int QItemModelSurfaceDataProxy::columnCategoryIndex(const QString &category)
 /*!
  * \property QItemModelSurfaceDataProxy::rowRolePattern
  *
- * When set, a search and replace is done on the value mapped by row role before it is used as
- * a row category. This property specifies the regular expression to find the portion of the
- * mapped value to replace and rowRoleReplace property contains the replacement string.
+ * \brief Whether a search and replace is performed on the value mapped by the
+ * row role before it is used as a row category.
+ *
+ * This property specifies the regular expression to find the portion of the
+ * mapped value to replace and the rowRoleReplace property contains the
+ * replacement string.
  *
  * \sa rowRole, rowRoleReplace
  */
@@ -755,9 +786,12 @@ QRegExp QItemModelSurfaceDataProxy::rowRolePattern() const
 /*!
  * \property QItemModelSurfaceDataProxy::columnRolePattern
  *
- * When set, a search and replace is done on the value mapped by column role before it is used
- * as a column category. This property specifies the regular expression to find the portion of the
- * mapped value to replace and columnRoleReplace property contains the replacement string.
+ * \brief Whether a search and replace is done on the value mapped by the column
+ * role before it is used as a column category.
+ *
+ * This property specifies the regular expression to find the portion of the
+ * mapped value to replace and the columnRoleReplace property contains the
+ * replacement string.
  *
  * \sa columnRole, columnRoleReplace
  */
@@ -777,9 +811,12 @@ QRegExp QItemModelSurfaceDataProxy::columnRolePattern() const
 /*!
  * \property QItemModelSurfaceDataProxy::xPosRolePattern
  *
- * When set, a search and replace is done on the value mapped by xPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and xPosRoleReplace property contains the replacement string.
+ * \brief Whether a search and replace is done on the value mapped by the x
+ * position role before it is used as an item position value.
+ *
+ * This property specifies the regular expression to find the portion of the
+ * mapped value to replace and the xPosRoleReplace property contains the
+ * replacement string.
  *
  * \sa xPosRole, xPosRoleReplace
  */
@@ -799,9 +836,12 @@ QRegExp QItemModelSurfaceDataProxy::xPosRolePattern() const
 /*!
  * \property QItemModelSurfaceDataProxy::yPosRolePattern
  *
- * When set, a search and replace is done on the value mapped by yPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and yPosRoleReplace property contains the replacement string.
+ * \brief Whether a search and replace is done on the value mapped by the y
+ * position role before it is used as an item position value.
+ *
+ * This property specifies the regular expression to find the portion of the
+ * mapped value to replace and the yPosRoleReplace property contains the
+ * replacement string.
  *
  * \sa yPosRole, yPosRoleReplace
  */
@@ -821,9 +861,12 @@ QRegExp QItemModelSurfaceDataProxy::yPosRolePattern() const
 /*!
  * \property QItemModelSurfaceDataProxy::zPosRolePattern
  *
- * When set, a search and replace is done on the value mapped by zPos role before it is used as
- * a item position value. This property specifies the regular expression to find the portion of the
- * mapped value to replace and zPosRoleReplace property contains the replacement string.
+ * \brief Whether a search and replace is done on the value mapped by the z
+ * position role before it is used as an item position value.
+ *
+ * This property specifies the regular expression to find the portion of the
+ * mapped value to replace and the zPosRoleReplace property contains the
+ * replacement string.
  *
  * \sa zPosRole, zPosRoleReplace
  */
@@ -843,8 +886,10 @@ QRegExp QItemModelSurfaceDataProxy::zPosRolePattern() const
 /*!
  * \property QItemModelSurfaceDataProxy::rowRoleReplace
  *
- * This property defines the replace content to be used in conjunction with rowRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
+ * \brief The replace content to be used in conjunction with the row role
+ * pattern.
+ *
+ * Defaults to an empty string. For more information on how the search and replace using regular
  * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
  * function documentation.
  *
@@ -866,9 +911,12 @@ QString QItemModelSurfaceDataProxy::rowRoleReplace() const
 /*!
  * \property QItemModelSurfaceDataProxy::columnRoleReplace
  *
- * This property defines the replace content to be used in conjunction with columnRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * \brief The replace content to be used in conjunction with a column role
+ * pattern.
+ *
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
  * function documentation.
  *
  * \sa columnRole, columnRolePattern
@@ -889,9 +937,12 @@ QString QItemModelSurfaceDataProxy::columnRoleReplace() const
 /*!
  * \property QItemModelSurfaceDataProxy::xPosRoleReplace
  *
- * This property defines the replace content to be used in conjunction with xPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * \brief The replace content to be used in conjunction with an x position role
+ * pattern.
+ *
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
  * function documentation.
  *
  * \sa xPosRole, xPosRolePattern
@@ -912,9 +963,12 @@ QString QItemModelSurfaceDataProxy::xPosRoleReplace() const
 /*!
  * \property QItemModelSurfaceDataProxy::yPosRoleReplace
  *
- * This property defines the replace content to be used in conjunction with yPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * \brief The replace content to be used in conjunction with an y position role
+ * pattern.
+ *
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
  * function documentation.
  *
  * \sa yPosRole, yPosRolePattern
@@ -935,9 +989,12 @@ QString QItemModelSurfaceDataProxy::yPosRoleReplace() const
 /*!
  * \property QItemModelSurfaceDataProxy::zPosRoleReplace
  *
- * This property defines the replace content to be used in conjunction with zPosRolePattern.
- * Defaults to empty string. For more information on how the search and replace using regular
- * expressions works, see QString::replace(const QRegExp &rx, const QString &after)
+ * \brief The replace content to be used in conjunction with a z position role
+ * pattern.
+ *
+ * Defaults to an empty string. For more information on how the search and
+ * replace using regular expressions works, see the
+ * QString::replace(const QRegExp &rx, const QString &after)
  * function documentation.
  *
  * \sa zPosRole, zPosRolePattern
@@ -958,13 +1015,14 @@ QString QItemModelSurfaceDataProxy::zPosRoleReplace() const
 /*!
  * \property QItemModelSurfaceDataProxy::multiMatchBehavior
  *
- * This property defines how multiple matches for each row/column combination are handled.
- * Defaults to QItemModelSurfaceDataProxy::MMBLast.
+ * \brief How multiple matches for each row/column combination are handled.
+ *
+ * Defaults to MMBLast.
  *
  * For example, you might have an item model with timestamped data taken at irregular intervals
  * and you want to visualize an average position of data items on each hour with a surface graph.
  * This can be done by specifying row and column categories so that each surface point represents
- * an hour, and setting multiMatchBehavior to QItemModelSurfaceDataProxy::MMBAverage.
+ * an hour, and setting this property to MMBAverage.
  */
 
 void QItemModelSurfaceDataProxy::setMultiMatchBehavior(QItemModelSurfaceDataProxy::MultiMatchBehavior behavior)