summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTomi Korpipää <tomi.korpipaa@digia.com>2014-02-27 10:14:44 +0200
committerTomi Korpipää <tomi.korpipaa@digia.com>2014-02-27 10:29:55 +0200
commitfeec46ffea6f1cd39e679a9794c8c9159d2b25a2 (patch)
treee4029aecda0d67cdd1196f4b1c410eec1f3b2c31
parent5bcdebd086c3d5ea9d6c1874985f7df0eacb4489 (diff)
Doc fixes:
- QCategory3DAxis - QBarDataProxy - QHeightMapSurfaceDataProxy - QItemModelBarDataProxy Change-Id: I021af6e0b52a6cc0b8068784406c3422e45640e1 Change-Id: I021af6e0b52a6cc0b8068784406c3422e45640e1 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com>
-rw-r--r--src/datavisualization/axis/qcategory3daxis.cpp4
-rw-r--r--src/datavisualization/data/qbardataproxy.cpp8
-rw-r--r--src/datavisualization/data/qheightmapsurfacedataproxy.cpp15
-rw-r--r--src/datavisualization/data/qitemmodelbardataproxy.cpp24
4 files changed, 27 insertions, 24 deletions
diff --git a/src/datavisualization/axis/qcategory3daxis.cpp b/src/datavisualization/axis/qcategory3daxis.cpp
index c1d5777a..c11a65eb 100644
--- a/src/datavisualization/axis/qcategory3daxis.cpp
+++ b/src/datavisualization/axis/qcategory3daxis.cpp
@@ -75,8 +75,8 @@ QCategory3DAxis::~QCategory3DAxis()
/*!
* \property QCategory3DAxis::labels
*
- * Defines labels for 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
+ * 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
* generated from the data row (or column) labels of the primary series of the graph.
*/
QStringList QCategory3DAxis::labels() const
diff --git a/src/datavisualization/data/qbardataproxy.cpp b/src/datavisualization/data/qbardataproxy.cpp
index d2553f32..1c1170ff 100644
--- a/src/datavisualization/data/qbardataproxy.cpp
+++ b/src/datavisualization/data/qbardataproxy.cpp
@@ -49,12 +49,14 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
/*!
* \typedef QtDataVisualization::QBarDataRow
+ * \relates QBarDataProxy
*
* A vector of \l {QBarDataItem}s.
*/
/*!
* \typedef QtDataVisualization::QBarDataArray
+ * \relates QBarDataProxy
*
* A list of pointers to \l {QBarDataRow}s.
*/
@@ -358,7 +360,7 @@ void QBarDataProxy::removeRows(int rowIndex, int removeCount, bool removeLabels)
/*!
* \property QBarDataProxy::rowCount
*
- * Row count in the array.
+ * Row \a count in the array.
*/
int QBarDataProxy::rowCount() const
{
@@ -368,7 +370,7 @@ int QBarDataProxy::rowCount() const
/*!
* \property QBarDataProxy::rowLabels
*
- * Optional row labels for the array. Indexes in this array match row indexes in data array.
+ * Optional row \a labels for the array. Indexes in this array match row indexes in data array.
* If the list is shorter than row count, all rows will not get labels.
*/
QStringList QBarDataProxy::rowLabels() const
@@ -387,7 +389,7 @@ void QBarDataProxy::setRowLabels(const QStringList &labels)
/*!
* \property QBarDataProxy::columnLabels
*
- * Optional column labels for the array. Indexes in this array match column indexes in rows.
+ * Optional column \a labels for the array. Indexes in this array match column indexes in rows.
* If the list is shorter than the longest row, all columns will not get labels.
*/
QStringList QBarDataProxy::columnLabels() const
diff --git a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
index 1aead1d7..b7111afc 100644
--- a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
+++ b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp
@@ -123,7 +123,7 @@ QHeightMapSurfaceDataProxy::QHeightMapSurfaceDataProxy(QObject *parent) :
/*!
* Constructs QHeightMapSurfaceDataProxy with the given \a image and \a parent. Height map is set
- * by calling setHeighMap() with \a image.
+ * by calling setHeightMap() with \a image.
*
* \sa heightMap
*/
@@ -164,16 +164,17 @@ QHeightMapSurfaceDataProxy::~QHeightMapSurfaceDataProxy()
/*!
* \property QHeightMapSurfaceDataProxy::heightMap
*
- * A height map to be visualized. Setting this property replaces current data with height map data.
+ * A height map \a image to be visualized. Setting this property replaces current data with height
+ * map data.
*
- * There are several formats the image can be given in, but if it is not in a directly usable
+ * There are several formats the \a image can be given in, but if it is not in a directly usable
* format, a conversion is made. \note If the result seems wrong, the automatic conversion failed
- * and you should try converting the image yourself before setting it. Preferred format is
+ * and you should try converting the \a image yourself before setting it. Preferred format is
* QImage::Format_RGB32 in grayscale.
*
- * The height of the image is read from the red component of the pixels if the image is in grayscale,
- * otherwise it is an average calculated from red, green, and blue components of the pixels. Using
- * grayscale images may improve data conversion speed for large images.
+ * The height of the \a image is read from the red component of the pixels if the \a image is in
+ * grayscale, otherwise it is an average calculated from red, green, and blue components of the
+ * pixels. Using grayscale images may improve data conversion speed for large images.
*
* Not recommended formats: all mono formats (for example QImage::Format_Mono).
*
diff --git a/src/datavisualization/data/qitemmodelbardataproxy.cpp b/src/datavisualization/data/qitemmodelbardataproxy.cpp
index 0e880c77..4d220b13 100644
--- a/src/datavisualization/data/qitemmodelbardataproxy.cpp
+++ b/src/datavisualization/data/qitemmodelbardataproxy.cpp
@@ -125,21 +125,21 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION
* \qmlproperty list ItemModelBarDataProxy::useModelCategories
* When set to true, the mapping ignores row and column roles and categories, and uses
* the rows and columns from the model instead. Row and column headers are used for row and column
- * labels. Defaults to false.
+ * labels. Defaults to \c{false}.
*/
/*!
* \qmlproperty list ItemModelBarDataProxy::autoRowCategories
* When set to true, the mapping ignores any explicitly set row categories
* and overwrites them with automatically generated ones whenever the
- * data from the model is resolved. Defaults to true.
+ * data from the model is resolved. Defaults to \c{true}.
*/
/*!
* \qmlproperty list ItemModelBarDataProxy::autoColumnCategories
* When set to 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 true.
+ * data from model is resolved. Defaults to \c{true}.
*/
/*!
@@ -300,7 +300,7 @@ const QAbstractItemModel *QItemModelBarDataProxy::itemModel() const
/*!
* \property QItemModelBarDataProxy::rowRole
*
- * Defines the row role for the mapping.
+ * Defines the row \a role for the mapping.
*/
void QItemModelBarDataProxy::setRowRole(const QString &role)
{
@@ -318,7 +318,7 @@ QString QItemModelBarDataProxy::rowRole() const
/*!
* \property QItemModelBarDataProxy::columnRole
*
- * Defines the column role for the mapping.
+ * Defines the column \a role for the mapping.
*/
void QItemModelBarDataProxy::setColumnRole(const QString &role)
{
@@ -336,7 +336,7 @@ QString QItemModelBarDataProxy::columnRole() const
/*!
* \property QItemModelBarDataProxy::valueRole
*
- * Defines the value role for the mapping.
+ * Defines the value \a role for the mapping.
*/
void QItemModelBarDataProxy::setValueRole(const QString &role)
{
@@ -354,7 +354,7 @@ QString QItemModelBarDataProxy::valueRole() const
/*!
* \property QItemModelBarDataProxy::rotationRole
*
- * Defines the rotation role for the mapping.
+ * Defines the rotation \a role for the mapping.
*/
void QItemModelBarDataProxy::setRotationRole(const QString &role)
{
@@ -372,7 +372,7 @@ QString QItemModelBarDataProxy::rotationRole() const
/*!
* \property QItemModelBarDataProxy::rowCategories
*
- * Defines the row categories for the mapping.
+ * Defines the row \a categories for the mapping.
*/
void QItemModelBarDataProxy::setRowCategories(const QStringList &categories)
{
@@ -390,7 +390,7 @@ QStringList QItemModelBarDataProxy::rowCategories() const
/*!
* \property QItemModelBarDataProxy::columnCategories
*
- * Defines the column categories for the mapping.
+ * Defines the column \a categories for the mapping.
*/
void QItemModelBarDataProxy::setColumnCategories(const QStringList &categories)
{
@@ -409,7 +409,7 @@ QStringList QItemModelBarDataProxy::columnCategories() const
* \property QItemModelBarDataProxy::useModelCategories
*
* When set to true, the mapping ignores row and column roles and categories, and uses
- * the rows and columns from the model instead. Defaults to false.
+ * the rows and columns from the model instead. Defaults to \c{false}.
*/
void QItemModelBarDataProxy::setUseModelCategories(bool enable)
{
@@ -429,7 +429,7 @@ bool QItemModelBarDataProxy::useModelCategories() const
*
* When set to 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 true.
+ * data from model is resolved. Defaults to \c{true}.
*/
void QItemModelBarDataProxy::setAutoRowCategories(bool enable)
{
@@ -449,7 +449,7 @@ bool QItemModelBarDataProxy::autoRowCategories() const
*
* When set to 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 true.
+ * data from model is resolved. Defaults to \c{true}.
*/
void QItemModelBarDataProxy::setAutoColumnCategories(bool enable)
{