From 986060cbcfd51c332c5832219147c3aff8f2141d Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Wed, 23 Oct 2013 16:05:04 +0200 Subject: Doc: language review datavisualization MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTBUG-33360 Change-Id: I67eaab3914effa2a7a5be1b72c6d2c59cb2402f6 Reviewed-by: Tomi Korpipää Reviewed-by: Miikka Heikkinen --- src/datavisualization/data/qabstractdataproxy.cpp | 4 ++-- src/datavisualization/data/qbardataproxy.cpp | 16 ++++++++-------- .../data/qheightmapsurfacedataproxy.cpp | 2 +- src/datavisualization/data/qitemmodelbardatamapping.cpp | 14 +++++++------- src/datavisualization/data/qitemmodelbardataproxy.cpp | 2 +- .../data/qitemmodelscatterdatamapping.cpp | 4 ++-- .../data/qitemmodelscatterdataproxy.cpp | 8 ++++---- .../data/qitemmodelsurfacedatamapping.cpp | 12 ++++++------ src/datavisualization/data/qscatterdataproxy.cpp | 10 +++++----- src/datavisualization/data/qsurfacedataproxy.cpp | 14 +++++++------- 10 files changed, 43 insertions(+), 43 deletions(-) (limited to 'src/datavisualization/data') diff --git a/src/datavisualization/data/qabstractdataproxy.cpp b/src/datavisualization/data/qabstractdataproxy.cpp index 15cb02de..2e4556fd 100644 --- a/src/datavisualization/data/qabstractdataproxy.cpp +++ b/src/datavisualization/data/qabstractdataproxy.cpp @@ -52,7 +52,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \qmlproperty string AbstractDataProxy::itemLabelFormat * * Label format for data items in this proxy. This format is used for single item labels, - * e.g. when an item is selected. How the format is interpreted depends on proxy type. See + * for example, when an item is selected. How the format is interpreted depends on proxy type. See * each proxy class documentation for more information. */ @@ -101,7 +101,7 @@ QAbstractDataProxy::DataType QAbstractDataProxy::type() const * \property QAbstractDataProxy::itemLabelFormat * * Sets label \a format for data items in this proxy. This format is used for single item labels, - * e.g. when an item is selected. How the format is interpreted depends on proxy type. See + * for example, when an item is selected. How the format is interpreted depends on proxy type. See * each proxy class documentation for more information. * * \sa QBarDataProxy, QScatterDataProxy, QSurfaceDataProxy diff --git a/src/datavisualization/data/qbardataproxy.cpp b/src/datavisualization/data/qbardataproxy.cpp index 066351f1..08d8151b 100644 --- a/src/datavisualization/data/qbardataproxy.cpp +++ b/src/datavisualization/data/qbardataproxy.cpp @@ -81,7 +81,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \inherits AbstractDataProxy * \brief Base proxy type for Bars3D. * - * This type handles adding, inserting, changing and removing rows of data with Qt Quick 2. + * This type handles adding, inserting, changing, and removing rows of data with Qt Quick 2. * * This type is uncreatable, but contains properties that are exposed via subtypes. * @@ -141,8 +141,8 @@ void QBarDataProxy::resetArray() } /*! - * Takes ownership of the \a newArray. Clears the existing array and if the \a newArray is - * different than the existing array. If it's the same array, this just triggers arrayReset() + * Takes ownership of the \a newArray. Clears the existing array if the \a newArray is + * different from the existing array. If it's the same array, this just triggers arrayReset() * signal. * Passing null array deletes the old array and creates a new empty array. * Row and column labels are not affected. @@ -154,10 +154,10 @@ void QBarDataProxy::resetArray(QBarDataArray *newArray) } /*! - * Takes ownership of the \a newArray. Clears the existing array and if the \a newArray is - * different than the existing array. If it's the same array, this just triggers arrayReset() + * Takes ownership of the \a newArray. Clears the existing array if the \a newArray is + * different from the existing array. If it's the same array, this just triggers arrayReset() * signal. - * Passing null array deletes the old array and creates a new empty array. + * Passing a null array deletes the old array and creates a new empty array. * The \a rowLabels and \a columnLabels lists specify the new labels for rows and columns. */ void QBarDataProxy::resetArray(QBarDataArray *newArray, const QStringList &rowLabels, @@ -388,7 +388,7 @@ const QBarDataArray *QBarDataProxy::array() const } /*! - * \return pointer to the row at \a rowIndex. It is guaranteed to be valid only until next call + * \return pointer to the row at \a rowIndex. It is guaranteed to be valid only until the next call * that modifies data. */ const QBarDataRow *QBarDataProxy::rowAt(int rowIndex) const @@ -400,7 +400,7 @@ const QBarDataRow *QBarDataProxy::rowAt(int rowIndex) const /*! * \return pointer to the item at \a rowIndex, \a columnIndex. It is guaranteed to be valid only - * until next call that modifies data. + * until the next call that modifies data. */ const QBarDataItem *QBarDataProxy::itemAt(int rowIndex, int columnIndex) const { diff --git a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp index 2c9d4d5e..cd63e603 100644 --- a/src/datavisualization/data/qheightmapsurfacedataproxy.cpp +++ b/src/datavisualization/data/qheightmapsurfacedataproxy.cpp @@ -168,7 +168,7 @@ QHeightMapSurfaceDataProxy::~QHeightMapSurfaceDataProxy() * 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 + * 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/qitemmodelbardatamapping.cpp b/src/datavisualization/data/qitemmodelbardatamapping.cpp index dd35173f..37bd7bf1 100644 --- a/src/datavisualization/data/qitemmodelbardatamapping.cpp +++ b/src/datavisualization/data/qitemmodelbardatamapping.cpp @@ -45,7 +45,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * For example, assume that you have a custom QAbstractItemModel for storing various monthly values * related to a business. - * Each item in the model has roles "year", "month", "income", and "expenses". + * Each item in the model has the roles "year", "month", "income", and "expenses". * You could do the following to display the data in a bar graph: * * \snippet doc_src_qtdatavisualization.cpp 3 @@ -62,7 +62,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \brief Item model mapping for Bars3D. * * This type is used to map roles of AbstractItemModel to rows, columns, and values of Bars3D. For - * more complete description, see QItemModelBarDataMapping. + * a more complete description, see QItemModelBarDataMapping. * * Usage example: * @@ -89,13 +89,13 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE /*! * \qmlproperty list BarDataMapping::rowCategories * The row categories of the mapping. Only items with row roles that are found in this list are - * included when data is resolved. The rows are ordered in the same order as they are in this list. + * included when the data is resolved. The rows are ordered in the same order as they are in this list. */ /*! * \qmlproperty list BarDataMapping::columnCategories * The column categories of the mapping. Only items with column roles that are found in this list are - * included when data is resolved. The columns are ordered in the same order as they are in this list. + * included when the data is resolved. The columns are ordered in the same order as they are in this list. */ /*! @@ -108,7 +108,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \qmlproperty list BarDataMapping::autoRowCategories * 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 the model is resolved. Defaults to true. */ /*! @@ -354,7 +354,7 @@ void QItemModelBarDataMapping::remap(const QString &rowRole, * /return index of the specified \a category in 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 valid index before the data in the model is resolved for the first time. + * not return a valid index before the data in the model is resolved for the first time. */ int QItemModelBarDataMapping::rowCategoryIndex(const QString &category) { @@ -365,7 +365,7 @@ int QItemModelBarDataMapping::rowCategoryIndex(const QString &category) * /return index of the specified \a category in 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 valid index before the data in the model is resolved for the first time. + * not return a valid index before the data in the model is resolved for the first time. */ int QItemModelBarDataMapping::columnCategoryIndex(const QString &category) { diff --git a/src/datavisualization/data/qitemmodelbardataproxy.cpp b/src/datavisualization/data/qitemmodelbardataproxy.cpp index c066f6ac..bee87606 100644 --- a/src/datavisualization/data/qitemmodelbardataproxy.cpp +++ b/src/datavisualization/data/qitemmodelbardataproxy.cpp @@ -32,7 +32,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * for Q3DBars. It uses QItemModelBarDataMapping instance to map data from the model to Q3DBars * graph. * - * Data is resolved asynchronously whenever the mapping or the model changes. + * The data is resolved asynchronously whenever the mapping or the model changes. * QBarDataProxy::arrayReset() is emitted when the data has been resolved. * * \sa QItemModelBarDataMapping, {Qt Data Visualization Data Handling} diff --git a/src/datavisualization/data/qitemmodelscatterdatamapping.cpp b/src/datavisualization/data/qitemmodelscatterdatamapping.cpp index c4eab20e..6705588d 100644 --- a/src/datavisualization/data/qitemmodelscatterdatamapping.cpp +++ b/src/datavisualization/data/qitemmodelscatterdatamapping.cpp @@ -34,7 +34,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * that can be mapped to X, Y, and Z-values for the scatter points. * * For example, assume that you have a custom QAbstractItemModel for storing various measurements - * done on material samples, providing data for roles such as "density", "hardness" and + * done on material samples, providing data for roles such as "density", "hardness", and * "conductivity". You could visualize these properties on a scatter graph: * * \snippet doc_src_qtdatavisualization.cpp 4 @@ -51,7 +51,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \brief Item model mapping for Scatter3D. * * This type is used to map roles of AbstractItemModel to the XYZ-values of Scatter3D points. For - * more complete description, see QItemModelScatterDataMapping. + * a more complete description, see QItemModelScatterDataMapping. * * Usage example: * diff --git a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp index cf605593..147b16da 100644 --- a/src/datavisualization/data/qitemmodelscatterdataproxy.cpp +++ b/src/datavisualization/data/qitemmodelscatterdataproxy.cpp @@ -31,7 +31,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * QItemModelScatterDataProxy allows you to use QAbstractItemModel derived models as a data source * for Q3DScatter. It maps roles defined in QItemModelScatterDataMapping to roles in the model. * - * Data is resolved asynchronously whenever the mapping or the model changes. + * The data is resolved asynchronously whenever the mapping or the model changes. * QScatterDataProxy::arrayReset() is emitted when the data has been resolved. * * /sa {Qt Data Visualization Data Handling} @@ -48,7 +48,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * This type allows you to use AbstractItemModel derived models as a data source for Scatter3D. * - * Data is resolved asynchronously whenever the mapping or the model changes. + * The data is resolved asynchronously whenever the mapping or the model changes. * QScatterDataProxy::arrayReset() is emitted when the data has been resolved. * * Usage example: @@ -99,7 +99,7 @@ QItemModelScatterDataProxy::~QItemModelScatterDataProxy() /*! * \property QItemModelScatterDataProxy::itemModel * - * Defines item model. Does not take ownership of the model, but does connect to it to listen for + * Defines the item model. Does not take ownership of the model, but does connect to it to listen for * changes. */ void QItemModelScatterDataProxy::setItemModel(const QAbstractItemModel *itemModel) @@ -115,7 +115,7 @@ const QAbstractItemModel *QItemModelScatterDataProxy::itemModel() const /*! * \property QItemModelScatterDataProxy::activeMapping * - * Defines data mapping. Proxy takes ownership of the \a mapping. + * Defines the data mapping. The proxy takes ownership of the \a mapping. * Modifying a mapping that is set to the proxy will trigger data set re-resolving. */ void QItemModelScatterDataProxy::setActiveMapping(QItemModelScatterDataMapping *mapping) diff --git a/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp b/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp index 928b8170..eead9a8e 100644 --- a/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp +++ b/src/datavisualization/data/qitemmodelsurfacedatamapping.cpp @@ -44,7 +44,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * columns. * * For example, assume that you have a custom QAbstractItemModel storing surface topography data. - * Each item in the model has roles "longitude", "latitude" and "height". The item model already + * Each item in the model has the roles "longitude", "latitude", and "height". The item model already * contains the data properly sorted so that longitudes and latitudes are first encountered in * correct order, which enables us to utilize the row and column category autogeneration. * You could do the following to display the data in a surface graph: @@ -63,7 +63,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \brief Item model mapping for Surface3D. * * This type is used to map roles of AbstractItemModel to rows, columns, and values of Surface3D. - * For more complete description, see QItemModelSurfaceDataMapping. + * For a more complete description, see QItemModelSurfaceDataMapping. * * Usage example: * @@ -142,7 +142,7 @@ QItemModelSurfaceDataMapping::QItemModelSurfaceDataMapping(const QString &valueR } /*! - * Constructs QItemModelSurfaceDataMapping with \a rowRole, \a columnRole, \a valueRole + * Constructs QItemModelSurfaceDataMapping with \a rowRole, \a columnRole, \a valueRole, * and the given \a parent. */ QItemModelSurfaceDataMapping::QItemModelSurfaceDataMapping(const QString &rowRole, @@ -158,7 +158,7 @@ QItemModelSurfaceDataMapping::QItemModelSurfaceDataMapping(const QString &rowRol /*! * Constructs QItemModelSurfaceDataMapping with \a rowRole, \a columnRole, \a valueRole, - * \a rowCategories, \a columnCategories and the given \a parent. This constructor + * \a rowCategories, \a columnCategories, and the given \a parent. This constructor * also sets autoRowCategories and autoColumnCategories to false. */ QItemModelSurfaceDataMapping::QItemModelSurfaceDataMapping(const QString &rowRole, @@ -359,7 +359,7 @@ void QItemModelSurfaceDataMapping::remap(const QString &rowRole, * /return index of the specified \a category in 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 valid index before the data in the model is resolved for the first time. + * not return a valid index before the data in the model is resolved for the first time. */ int QItemModelSurfaceDataMapping::rowCategoryIndex(const QString &category) { @@ -369,7 +369,7 @@ int QItemModelSurfaceDataMapping::rowCategoryIndex(const QString &category) /*! * /return index of the specified \a category in column categories list. * \note If the automatic column categories generation is in use, this method will - * not return valid index before the data in the model is resolved for the first time. + * not return a valid index before the data in the model is resolved for the first time. */ int QItemModelSurfaceDataMapping::columnCategoryIndex(const QString &category) { diff --git a/src/datavisualization/data/qscatterdataproxy.cpp b/src/datavisualization/data/qscatterdataproxy.cpp index af237799..479fdd75 100644 --- a/src/datavisualization/data/qscatterdataproxy.cpp +++ b/src/datavisualization/data/qscatterdataproxy.cpp @@ -27,7 +27,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \brief Base proxy class for Q3DScatter. * \since Qt Data Visualization 1.0 * - * QScatterDataProxy handles adding, inserting, changing and removing data items. + * QScatterDataProxy handles adding, inserting, changing, and removing data items. * * QScatterDataProxy takes ownership of all QScatterDataArrays and QScatterDataItems passed to it. * @@ -65,7 +65,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * \inherits AbstractDataProxy * \brief Base proxy class for Scatter3D. * - * This type handles adding, inserting, changing and removing data items. + * This type handles adding, inserting, changing, and removing data items. * * This type is uncreatable, but contains properties that are exposed via subtypes. * @@ -103,10 +103,10 @@ QScatterDataProxy::~QScatterDataProxy() } /*! - * Takes ownership of the \a newArray. Clears the existing array and if the \a newArray is - * different than the existing array. If it's the same array, this just triggers arrayReset() + * Takes ownership of the \a newArray. Clears the existing array if the \a newArray is + * different from the existing array. If it's the same array, this just triggers arrayReset() * signal. - * Passing null array deletes the old array and creates a new empty array. + * Passing a null array deletes the old array and creates a new empty array. */ void QScatterDataProxy::resetArray(QScatterDataArray *newArray) { diff --git a/src/datavisualization/data/qsurfacedataproxy.cpp b/src/datavisualization/data/qsurfacedataproxy.cpp index c09213bd..1f152978 100644 --- a/src/datavisualization/data/qsurfacedataproxy.cpp +++ b/src/datavisualization/data/qsurfacedataproxy.cpp @@ -33,7 +33,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * objects. See Q3DSurface documentation and basic sample code there how to feed the data for the * QSurfaceDataProxy. * - * All rows must have same number of items. + * All rows must have the same number of items. * * When determining what rows and columns are visible, the first item in each row and the first item in * each column determine if the whole row or column is visible, even if other items in the row or column @@ -78,7 +78,7 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE * * This type is uncreatable, but contains properties that are exposed via subtypes. * - * For more complete description, see QSurfaceDataProxy. + * For a more complete description, see QSurfaceDataProxy. * * \sa ItemModelSurfaceDataProxy, {Qt Data Visualization Data Handling} */ @@ -117,10 +117,10 @@ QSurfaceDataProxy::~QSurfaceDataProxy() } /*! - * Takes ownership of the \a newArray. Clears the existing array and if the \a newArray is - * different than the existing array. If it's the same array, this just triggers arrayReset() + * Takes ownership of the \a newArray. Clears the existing array if the \a newArray is + * different from the existing array. If it's the same array, this just triggers arrayReset() * signal. - * Passing null array deletes the old array and creates a new empty array. + * Passing a null array deletes the old array and creates a new empty array. * All rows in \a newArray must be of same length. */ void QSurfaceDataProxy::resetArray(QSurfaceDataArray *newArray) @@ -163,7 +163,7 @@ int QSurfaceDataProxy::columnCount() const } /*! - * \return pointer to the item at \a index. It is guaranteed to be valid only until next call that + * \return pointer to the item at \a index. It is guaranteed to be valid only until the next call that * modifies data. */ const QSurfaceDataItem *QSurfaceDataProxy::itemAt(int index) const @@ -190,7 +190,7 @@ const QSurfaceDataProxyPrivate *QSurfaceDataProxy::dptrc() const /*! * \fn void QSurfaceDataProxy::arrayReset() * - * Emitted when data array is reset. + * Emitted when the data array is reset. * If you change the whole array contents without calling resetArray(), you need to * emit this signal yourself or the graph won't get updated. */ -- cgit v1.2.3