diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2017-04-05 16:51:12 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2017-04-07 07:00:11 +0000 |
commit | ddc020d6078572b8b5d17b6523acf70bd35b0518 (patch) | |
tree | ebfb42a4ed53067c82464f2d906dc422a1049b7a /src/datavisualization/data | |
parent | 6725566ff329c2ec94b7f7acd017221587f7cd8d (diff) |
Doc: Edit data item docs for grammar and style
Change-Id: Ic93eb2648bdff84e88acdf7941ddd85cc6d874ca
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Diffstat (limited to 'src/datavisualization/data')
-rw-r--r-- | src/datavisualization/data/qbardataitem.cpp | 22 | ||||
-rw-r--r-- | src/datavisualization/data/qscatterdataitem.cpp | 40 | ||||
-rw-r--r-- | src/datavisualization/data/qsurfacedataitem.cpp | 29 |
3 files changed, 47 insertions, 44 deletions
diff --git a/src/datavisualization/data/qbardataitem.cpp b/src/datavisualization/data/qbardataitem.cpp index a5f13fb2..5827cf42 100644 --- a/src/datavisualization/data/qbardataitem.cpp +++ b/src/datavisualization/data/qbardataitem.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. @@ -37,14 +37,14 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION * \brief The QBarDataItem class provides a container for resolved data to be added to bar graphs. * \since QtDataVisualization 1.0 * - * A QBarDataItem holds data for a single rendered bar in a graph. - * Bar data proxies parse data into QBarDataItem instances for visualizing. + * A bar data item holds the data for a single rendered bar in a graph. + * Bar data proxies parse data into QBarDataItem instances for visualization. * * \sa QBarDataProxy, {Qt Data Visualization C++ Classes} */ /*! - * Constructs QBarDataItem. + * Constructs a bar data item. */ QBarDataItem::QBarDataItem() : d_ptr(0), // private data doesn't exist by default (optimization) @@ -54,7 +54,7 @@ QBarDataItem::QBarDataItem() } /*! - * Constructs QBarDataItem with \a value. + * Constructs a bar data item with the value \a value. */ QBarDataItem::QBarDataItem(float value) : d_ptr(0), @@ -64,7 +64,7 @@ QBarDataItem::QBarDataItem(float value) } /*! - * Constructs QBarDataItem with \a value and \a angle + * Constructs a bar data item with the value \a value and angle \a angle. */ QBarDataItem::QBarDataItem(float value, float angle) : d_ptr(0), @@ -82,7 +82,7 @@ QBarDataItem::QBarDataItem(const QBarDataItem &other) } /*! - * Destroys QBarDataItem. + * Deletes a bar data item. */ QBarDataItem::~QBarDataItem() { @@ -105,22 +105,22 @@ QBarDataItem &QBarDataItem::operator=(const QBarDataItem &other) /*! * \fn void QBarDataItem::setValue(float val) - * Sets value \a val to this data item. + * Sets the value \a val to this data item. */ /*! * \fn float QBarDataItem::value() const - * \return value of this data item. + * Returns the value of this data item. */ /*! * \fn void QBarDataItem::setRotation(float angle) - * Sets rotation \a angle in degrees for this data item. + * Sets the rotation angle \a angle in degrees for this data item. */ /*! * \fn float QBarDataItem::rotation() const - * \return rotation angle in degrees for this data item. + * Returns the rotation angle in degrees for this data item. */ /*! diff --git a/src/datavisualization/data/qscatterdataitem.cpp b/src/datavisualization/data/qscatterdataitem.cpp index 50fac08d..12ea47af 100644 --- a/src/datavisualization/data/qscatterdataitem.cpp +++ b/src/datavisualization/data/qscatterdataitem.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. @@ -38,14 +38,15 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION * graphs. * \since QtDataVisualization 1.0 * - * A QScatterDataItem holds data for a single rendered item in a scatter graph. - * Scatter data proxies parse data into QScatterDataItem instances for visualizing. + * A scatter data item holds the data for a single rendered item in a scatter + * graph. Scatter data proxies parse data into QScatterDataItem instances for + * visualization. * * \sa QScatterDataProxy, {Qt Data Visualization C++ Classes} */ /*! - * Constructs QScatterDataItem. + * Constructs a scatter data item. */ QScatterDataItem::QScatterDataItem() : d_ptr(0) // private data doesn't exist by default (optimization) @@ -54,7 +55,7 @@ QScatterDataItem::QScatterDataItem() } /*! - * Constructs QScatterDataItem with \a position. + * Constructs a scatter data item at the position \a position. */ QScatterDataItem::QScatterDataItem(const QVector3D &position) : d_ptr(0), @@ -63,7 +64,8 @@ QScatterDataItem::QScatterDataItem(const QVector3D &position) } /*! - * Constructs QScatterDataItem with \a position and \a rotation. + * Constructs a scatter data item at the position \a position with the rotation + * \a rotation. */ QScatterDataItem::QScatterDataItem(const QVector3D &position, const QQuaternion &rotation) : d_ptr(0), @@ -81,7 +83,7 @@ QScatterDataItem::QScatterDataItem(const QScatterDataItem &other) } /*! - * Destroys QScatterDataItem. + * Deletes a scatter data item. */ QScatterDataItem::~QScatterDataItem() { @@ -105,56 +107,56 @@ QScatterDataItem &QScatterDataItem::operator=(const QScatterDataItem &other) /*! * \fn void QScatterDataItem::setPosition(const QVector3D &pos) - * Sets position \a pos to this data item. + * Sets the position \a pos for this data item. */ /*! * \fn QVector3D QScatterDataItem::position() const - * \return position of this data item. + * Returns the position of this data item. */ /*! * \fn void QScatterDataItem::setRotation(const QQuaternion &rot) - * Sets rotation \a rot to this data item. - * The \a rot should be a normalized QQuaternion. - * If the series also has rotation, item and series rotations are multiplied together. + * Sets the rotation \a rot for this data item. + * The value of \a rot should be a normalized QQuaternion. + * If the series also has rotation, item rotation is multiplied by it. * Defaults to no rotation. */ /*! * \fn QQuaternion QScatterDataItem::rotation() const - * \return rotation of this data item. + * Returns the rotation of this data item. * \sa setRotation() */ /*! * \fn void QScatterDataItem::setX(float value) - * Sets the X component of the item position to the \a value. + * Sets the x-coordinate of the item position to the value \a value. */ /*! * \fn void QScatterDataItem::setY(float value) - * Sets the Y component of the item position to the \a value. + * Sets the y-coordinate of the item position to the value \a value. */ /*! * \fn void QScatterDataItem::setZ(float value) - * Sets the Z component of the item position to the \a value. + * Sets the z-coordinate of the item position to the value \a value. */ /*! * \fn float QScatterDataItem::x() const - * \return the X component of the position of this data item. + * Returns the x-coordinate of the position of this data item. */ /*! * \fn float QScatterDataItem::y() const - * \return the Y component of the position of this data item. + * Returns the y-coordinate of the position of this data item. */ /*! * \fn float QScatterDataItem::z() const - * \return the Z component of the position of this data item. + * Returns the z-coordinate of the position of this data item. */ /*! diff --git a/src/datavisualization/data/qsurfacedataitem.cpp b/src/datavisualization/data/qsurfacedataitem.cpp index 2d361904..a4aeb18d 100644 --- a/src/datavisualization/data/qsurfacedataitem.cpp +++ b/src/datavisualization/data/qsurfacedataitem.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. @@ -38,14 +38,15 @@ QT_BEGIN_NAMESPACE_DATAVISUALIZATION * graphs. * \since QtDataVisualization 1.0 * - * A QSurfaceDataItem holds data for a single vertex in surface graph. - * Surface data proxies parse data into QSurfaceDataItem instances for visualizing. + * A surface data item holds the data for a single vertex in a surface graph. + * Surface data proxies parse data into QSurfaceDataItem instances for + * visualization. * * \sa QSurfaceDataProxy, {Qt Data Visualization C++ Classes} */ /*! - * Constructs QSurfaceDataItem. + * Constructs a surface data item. */ QSurfaceDataItem::QSurfaceDataItem() : d_ptr(0) // private data doesn't exist by default (optimization) @@ -54,7 +55,7 @@ QSurfaceDataItem::QSurfaceDataItem() } /*! - * Constructs QSurfaceDataItem with \a position. + * Constructs a surface data item at the position \a position. */ QSurfaceDataItem::QSurfaceDataItem(const QVector3D &position) : d_ptr(0), @@ -71,7 +72,7 @@ QSurfaceDataItem::QSurfaceDataItem(const QSurfaceDataItem &other) } /*! - * Destroys QSurfaceDataItem. + * Deletes a surface data item. */ QSurfaceDataItem::~QSurfaceDataItem() { @@ -94,42 +95,42 @@ QSurfaceDataItem &QSurfaceDataItem::operator=(const QSurfaceDataItem &other) /*! * \fn void QSurfaceDataItem::setPosition(const QVector3D &pos) - * Sets position \a pos to this data item. + * Sets the position \a pos to this data item. */ /*! * \fn QVector3D QSurfaceDataItem::position() const - * \return position of this data item. + * Returns the position of this data item. */ /*! * \fn void QSurfaceDataItem::setX(float value) - * Sets the X component of the item position to the \a value. + * Sets the x-coordinate of the item position to the value \a value. */ /*! * \fn void QSurfaceDataItem::setY(float value) - * Sets the Y component of the item position to the \a value. + * Sets the y-coordinate of the item position to the value \a value. */ /*! * \fn void QSurfaceDataItem::setZ(float value) - * Sets the Z component of the item position to the \a value. + * Sets the z-coordinate of the item position to the value \a value. */ /*! * \fn float QSurfaceDataItem::x() const - * \return the X component of the position of this data item. + * Returns the x-coordinate of the position of this data item. */ /*! * \fn float QSurfaceDataItem::y() const - * \return the Y component of the position of this data item. + * Returns the y-coordinate of the position of this data item. */ /*! * \fn float QSurfaceDataItem::z() const - * \return the Z component of the position of this data item. + * Returns the z-coordinate of the position of this data item. */ /*! |