summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/engine
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2013-10-23 16:05:04 +0200
committerMiikka Heikkinen <miikka.heikkinen@digia.com>2013-10-25 07:53:36 +0300
commit986060cbcfd51c332c5832219147c3aff8f2141d (patch)
tree37a3f5953e09c3b96d2d33834962062970ee6cd9 /src/datavisualization/engine
parent24e79858946808da060fb1cb3088f554d82d4984 (diff)
Doc: language review datavisualization
Task-number: QTBUG-33360 Change-Id: I67eaab3914effa2a7a5be1b72c6d2c59cb2402f6 Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com>
Diffstat (limited to 'src/datavisualization/engine')
-rw-r--r--src/datavisualization/engine/bars3dcontroller.cpp2
-rw-r--r--src/datavisualization/engine/q3dbars.cpp18
-rw-r--r--src/datavisualization/engine/q3dcamera.cpp12
-rw-r--r--src/datavisualization/engine/q3dscatter.cpp16
-rw-r--r--src/datavisualization/engine/q3dsurface.cpp18
-rw-r--r--src/datavisualization/engine/surface3dcontroller.cpp2
-rw-r--r--src/datavisualization/engine/surface3drenderer.cpp2
7 files changed, 35 insertions, 35 deletions
diff --git a/src/datavisualization/engine/bars3dcontroller.cpp b/src/datavisualization/engine/bars3dcontroller.cpp
index 50d8d030..2eea6c74 100644
--- a/src/datavisualization/engine/bars3dcontroller.cpp
+++ b/src/datavisualization/engine/bars3dcontroller.cpp
@@ -43,7 +43,7 @@ Bars3DController::Bars3DController(QRect boundRect)
setActiveDataProxy(0);
// Setting a null axis creates a new default axis according to orientation and graph type.
- // Note: These cannot be set in Abstract3DController constructor, as they will call virtual
+ // Note: these cannot be set in the Abstract3DController constructor, as they will call virtual
// functions implemented by subclasses.
setAxisX(0);
setAxisY(0);
diff --git a/src/datavisualization/engine/q3dbars.cpp b/src/datavisualization/engine/q3dbars.cpp
index bc2ffeba..d6b48e03 100644
--- a/src/datavisualization/engine/q3dbars.cpp
+++ b/src/datavisualization/engine/q3dbars.cpp
@@ -42,11 +42,11 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* reset to default camera view by clicking mouse wheel. In touch devices rotation is done
* by tap-and-move, selection by tap-and-hold and zoom by pinch.
*
- * If no axes are explicitly set to Q3DBars, temporary default axes with no labels are created.
- * These default axes can be modified via axis accessors, but as soon any axis is explicitly
- * set for the orientation, the default axis for that orientation is destroyed.
+ * If no axes are set explicitly to Q3DBars, temporary default axes with no labels are created.
+ * These default axes can be modified via axis accessors, but as soon any axis is set explicitly
+ * for the orientation, the default axis for that orientation is destroyed.
*
- * Data proxies work similarly: If no data proxy is explicitly set, Q3DBars creates a default
+ * Data proxies work similarly: If no data proxy is set explicitly, Q3DBars creates a default
* proxy. If any other proxy is set as active data proxy later, the default proxy and all data
* added to it is destroyed.
*
@@ -209,7 +209,7 @@ qreal Q3DBars::barThickness()
/*!
* \property Q3DBars::barSpacing
*
- * Bar spacing, ie. the empty space between bars, in X and Z dimensions. It is preset to
+ * Bar spacing, which is the empty space between bars, in X and Z dimensions. It is preset to
* \c {(1.0, 1.0)} by default. Spacing is affected by barSpacingRelative -property.
*
* \sa barSpacingRelative
@@ -439,7 +439,7 @@ QDataVis::ShadowQuality Q3DBars::shadowQuality() const
* the \a axis to this graph.
*
* If the \a axis is null, a temporary default axis with no labels is created.
- * This temporary axis is destroyed if another \a axis is explicitly set to same orientation.
+ * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation.
*
* \sa addAxis(), releaseAxis()
*/
@@ -461,7 +461,7 @@ Q3DCategoryAxis *Q3DBars::rowAxis() const
* the \a axis to this graph.
*
* If the \a axis is null, a temporary default axis with no labels is created.
- * This temporary axis is destroyed if another \a axis is explicitly set to same orientation.
+ * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation.
*
* \sa addAxis(), releaseAxis()
*/
@@ -484,7 +484,7 @@ Q3DCategoryAxis *Q3DBars::columnAxis() const
*
* If the \a axis is null, a temporary default axis with no labels and automatically adjusting
* range is created.
- * This temporary axis is destroyed if another \a axis is explicitly set to same orientation.
+ * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation.
*
* \sa addAxis(), releaseAxis()
*/
@@ -541,7 +541,7 @@ QList<Q3DAbstractAxis *> Q3DBars::axes() const
* the \a proxy to this graph.
*
* If the \a proxy is null, a temporary default proxy is created and activated.
- * This temporary proxy is destroyed if another \a proxy is explicitly set active via this method.
+ * This temporary proxy is destroyed if another \a proxy is set explicitly active via this method.
*
* \sa addDataProxy(), releaseDataProxy()
*/
diff --git a/src/datavisualization/engine/q3dcamera.cpp b/src/datavisualization/engine/q3dcamera.cpp
index 86505ccb..fe452739 100644
--- a/src/datavisualization/engine/q3dcamera.cpp
+++ b/src/datavisualization/engine/q3dcamera.cpp
@@ -153,7 +153,7 @@ void Q3DCamera::setYRotation(qreal rotation)
*
* This property contains the current minimum X-rotation for the camera.
* The full circle range is [-180,180] and the minimum value is limited to -180.
- * Also the value can't be higher than maximum, and is adjusted if necessary.
+ * Also the value can't be higher than the maximum, and is adjusted if necessary.
*
* \sa wrapXRotation, maxXRotation
*/
@@ -185,7 +185,7 @@ void Q3DCamera::setMinXRotation(qreal minRotation)
*
* This property contains the current minimum Y-rotation for the camera.
* The full Y angle range is [-90,90] and the minimum value is limited to -90.
- * Also the value can't be higher than maximum, and is adjusted if necessary.
+ * Also the value can't be higher than the maximum, and is adjusted if necessary.
*
* \sa wrapYRotation, maxYRotation
*/
@@ -217,7 +217,7 @@ void Q3DCamera::setMinYRotation(qreal minRotation)
*
* This property contains the current maximum X-rotation for the camera.
* The full circle range is [-180,180] and the maximum value is limited to 180.
- * Also the value can't be lower than minimum, and is adjusted if necessary.
+ * Also the value can't be lower than the minimum, and is adjusted if necessary.
*
* \sa wrapXRotation, minXRotation
*/
@@ -250,7 +250,7 @@ void Q3DCamera::setMaxXRotation(qreal maxRotation)
*
* This property contains the current maximum Y-rotation for the camera.
* The full Y angle range is [-90,90] and the maximum value is limited to 90.
- * Also the value can't be lower than minimum, and is adjusted if necessary.
+ * Also the value can't be lower than the minimum, and is adjusted if necessary.
*
* \sa wrapYRotation, minYRotation
*/
@@ -301,8 +301,8 @@ void Q3DCamera::setBaseOrientation(const QVector3D &basePosition,
/*!
* \property Q3DCamera::viewMatrix
*
- * This property contains the view matrix used in the 3D calculations. When the default orbiting camera behavior is sufficient
- * there is no need to touch this property. But if the default behavior is insufficient the view matrix can be set directly.
+ * This property contains the view matrix used in the 3D calculations. When the default orbiting camera behavior is sufficient,
+ * there is no need to touch this property. But if the default behavior is insufficient, the view matrix can be set directly.
* When setting the view matrix directly remember to set Q3DCamera::viewMatrixAutoUpdateEnabled to false.
*/
QMatrix4x4 Q3DCamera::viewMatrix() const
diff --git a/src/datavisualization/engine/q3dscatter.cpp b/src/datavisualization/engine/q3dscatter.cpp
index 68470407..fc95842a 100644
--- a/src/datavisualization/engine/q3dscatter.cpp
+++ b/src/datavisualization/engine/q3dscatter.cpp
@@ -40,11 +40,11 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* reset to default camera view by clicking mouse wheel. In touch devices rotation is done
* by tap-and-move, selection by tap-and-hold and zoom by pinch.
*
- * If no axes are explicitly set to Q3DScatter, temporary default axes with no labels are created.
- * These default axes can be modified via axis accessors, but as soon any axis is explicitly
- * set for the orientation, the default axis for that orientation is destroyed.
+ * If no axes are set explicitly to Q3DScatter, temporary default axes with no labels are created.
+ * These default axes can be modified via axis accessors, but as soon any axis is set explicitly
+ * for the orientation, the default axis for that orientation is destroyed.
*
- * Data proxies work similarly: If no data proxy is explicitly set, Q3DScatter creates a default
+ * Data proxies work similarly: if no data proxy is set explicitly, Q3DScatter creates a default
* proxy. If any other proxy is set as active data proxy later, the default proxy and all data
* added to it is destroyed.
*
@@ -374,7 +374,7 @@ QDataVis::ShadowQuality Q3DScatter::shadowQuality() const
*
* If the \a axis is null, a temporary default axis with no labels and automatically adjusting
* range is created.
- * This temporary axis is destroyed if another \a axis is explicitly set to same orientation.
+ * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation.
*
* \sa addAxis(), releaseAxis()
*/
@@ -397,7 +397,7 @@ Q3DValueAxis *Q3DScatter::axisX() const
*
* If the \a axis is null, a temporary default axis with no labels and automatically adjusting
* range is created.
- * This temporary axis is destroyed if another \a axis is explicitly set to same orientation.
+ * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation.
*
* \sa addAxis(), releaseAxis()
*/
@@ -420,7 +420,7 @@ Q3DValueAxis *Q3DScatter::axisY() const
*
* If the \a axis is null, a temporary default axis with no labels and automatically adjusting
* range is created.
- * This temporary axis is destroyed if another \a axis is explicitly set to same orientation.
+ * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation.
*
* \sa addAxis(), releaseAxis()
*/
@@ -482,7 +482,7 @@ QList<Q3DValueAxis *> Q3DScatter::axes() const
* the \a proxy to this graph.
*
* If the \a proxy is null, a temporary default proxy is created and activated.
- * This temporary proxy is destroyed if another \a proxy is explicitly set active via this method.
+ * This temporary proxy is destroyed if another \a proxy is set explicitly active via this method.
*
* \sa addDataProxy(), releaseDataProxy()
*/
diff --git a/src/datavisualization/engine/q3dsurface.cpp b/src/datavisualization/engine/q3dsurface.cpp
index 72fd50c0..42260e8b 100644
--- a/src/datavisualization/engine/q3dsurface.cpp
+++ b/src/datavisualization/engine/q3dsurface.cpp
@@ -48,11 +48,11 @@ QT_DATAVISUALIZATION_BEGIN_NAMESPACE
* To rotate the graph, hold down the right mouse button and move the mouse. Zooming is done using mouse
* wheel. Both assume the default input handler is in use.
*
- * If no axes are explicitly set to Q3DSurface, temporary default axes with no labels are created.
- * These default axes can be modified via axis accessors, but as soon any axis is explicitly
- * set for the orientation, the default axis for that orientation is destroyed.
+ * If no axes are set explicitly to Q3DSurface, temporary default axes with no labels are created.
+ * These default axes can be modified via axis accessors, but as soon any axis is set explicitly
+ * for the orientation, the default axis for that orientation is destroyed.
*
- * Data proxies work similarly: If no data proxy is explicitly set, Q3DSurface creates a default
+ * Data proxies work similarly: if no data proxy is set explicitly, Q3DSurface creates a default
* proxy. If any other proxy is set as active data proxy later, the default proxy and all data
* added to it is destroyed.
*
@@ -323,7 +323,7 @@ QFont Q3DSurface::font() const
/*!
* \property Q3DSurface::scene
*
- * This property contains the read only Q3DScene that can be used to access e.g. camera object.
+ * This property contains the read only Q3DScene that can be used to access, for example, a camera object.
*/
Q3DScene *Q3DSurface::scene() const
{
@@ -352,7 +352,7 @@ QDataVis::LabelStyle Q3DSurface::labelStyle() const
*
* If the \a axis is null, a temporary default axis with no labels and automatically adjusting
* range is created.
- * This temporary axis is destroyed if another \a axis is explicitly set to same orientation.
+ * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation.
*
* \sa addAxis(), releaseAxis()
*/
@@ -375,7 +375,7 @@ Q3DValueAxis *Q3DSurface::axisX() const
*
* If the \a axis is null, a temporary default axis with no labels and automatically adjusting
* range is created.
- * This temporary axis is destroyed if another \a axis is explicitly set to same orientation.
+ * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation.
*
* \sa addAxis(), releaseAxis()
*/
@@ -398,7 +398,7 @@ Q3DValueAxis *Q3DSurface::axisY() const
*
* If the \a axis is null, a temporary default axis with no labels and automatically adjusting
* range is created.
- * This temporary axis is destroyed if another \a axis is explicitly set to same orientation.
+ * This temporary axis is destroyed if another \a axis is set explicitly to the same orientation.
*
* \sa addAxis(), releaseAxis()
*/
@@ -460,7 +460,7 @@ QList<Q3DValueAxis *> Q3DSurface::axes() const
* the \a proxy to this graph.
*
* If the \a proxy is null, a temporary default proxy is created and activated.
- * This temporary proxy is destroyed if another \a proxy is explicitly set active via this method.
+ * This temporary proxy is destroyed if another \a proxy is set explicitly active via this method.
*
* \sa addDataProxy(), releaseDataProxy()
*/
diff --git a/src/datavisualization/engine/surface3dcontroller.cpp b/src/datavisualization/engine/surface3dcontroller.cpp
index 688747bb..8d1bcf85 100644
--- a/src/datavisualization/engine/surface3dcontroller.cpp
+++ b/src/datavisualization/engine/surface3dcontroller.cpp
@@ -39,7 +39,7 @@ Surface3DController::Surface3DController(QRect rect)
setActiveDataProxy(0);
// Setting a null axis creates a new default axis according to orientation and graph type.
- // Note: These cannot be set in Abstract3DController constructor, as they will call virtual
+ // Note: these cannot be set in the Abstract3DController constructor, as they will call virtual
// functions implemented by subclasses.
setAxisX(0);
setAxisY(0);
diff --git a/src/datavisualization/engine/surface3drenderer.cpp b/src/datavisualization/engine/surface3drenderer.cpp
index 22ad3c7f..a989ed3f 100644
--- a/src/datavisualization/engine/surface3drenderer.cpp
+++ b/src/datavisualization/engine/surface3drenderer.cpp
@@ -235,7 +235,7 @@ void Surface3DRenderer::updateDataModel(QSurfaceDataProxy *dataProxy)
if (!m_surfaceObj)
loadSurfaceObj();
- // Note: Data setup can change samplespace (as min width/height is 1)
+ // Note: Data setup can change sample space (as min width/height is 1)
if (m_cachedSmoothSurface) {
m_surfaceObj->setUpSmoothData(m_dataArray, m_sampleSpace, m_heightNormalizer,
m_axisCacheY.min(), dimensionChanged);