Doc: language/style review datavisualization doc

Task-number: QTBUG-33360
Change-Id: Ib6918dcc4c0ee213dddb118616940306a10001fa
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com>

11 files changed, 60 insertions, 61 deletions

diff --git a/examples/audiolevels/doc/src/audiolevels.qdoc b/examples/audiolevels/doc/src/audiolevels.qdoc
index 3d392487..1aef9174 100644
--- a/examples/audiolevels/doc/src/audiolevels.qdoc
+++ b/examples/audiolevels/doc/src/audiolevels.qdoc
@@ -57,7 +57,7 @@
 
     \snippet ../examples/audiolevels/audiolevelsiodevice.cpp 1
 
-    The \c resolution constant indicates the sample rate, e.g. value 8 means every eighth
+    The \c resolution constant indicates the sample rate, for example, value 8 means every eighth
     byte from audio input is visualized. This is necessary to make the data readable, as it would
     otherwise make the graph scroll too fast.
 
@@ -71,7 +71,7 @@
 
     \snippet ../examples/audiolevels/audiolevelsiodevice.cpp 2
 
-    We use a couple of techniques here to improve performance. First off, we reuse
+    We use a couple of techniques here to improve performance. First, we reuse
     the existing data array, as this allows us to avoid any extra memory allocations in our
     application code. This also means the data array dimensions do not change, which further
     improves efficiency in the bar graph renderer.
diff --git a/examples/customproxy/doc/src/customproxy.qdoc b/examples/customproxy/doc/src/customproxy.qdoc
index 288a7149..be2e2a96 100644
--- a/examples/customproxy/doc/src/customproxy.qdoc
+++ b/examples/customproxy/doc/src/customproxy.qdoc
@@ -32,7 +32,7 @@
 
     This example defines a simple flexible data set \c VariantDataSet where each data item is a
     a variant list. Each item can have multiple different values, identified by their index in
-    the list. In this example, the data set is storing monthly rainfall data, where value in
+    the list. In this example, the data set is storing monthly rainfall data, where the value in
     index one is the year, index two contains the month, and the third value has the amount
     of rainfall in that month.
 
@@ -95,7 +95,7 @@
     \snippet ../examples/customproxy/variantbardatamapping.h 3
 
     The primary way to use a \c VariantBarDataMapping object is to give the mappings already at the
-    constructor, though they can be set later individually or all together with \c remap() method.
+    constructor, though they can be set later individually or all together with the \c remap() method.
     A signal is emitted if mapping changes. It is basically a simplified version of
     QItemModelBarDataMapping adapted to work with variant lists instead of item models.
 
@@ -106,7 +106,7 @@
 
     \snippet ../examples/customproxy/rainfallgraph.cpp 0
 
-    Bulk of that method is used for populating the variant data set. Once the set is populated,
+    The bulk of that method is used for populating the variant data set. Once the set is populated,
     visualizing the data is trivial with the help of our custom proxy:
 
     \snippet ../examples/customproxy/rainfallgraph.cpp 1
diff --git a/examples/itemmodel/doc/src/itemmodel.qdoc b/examples/itemmodel/doc/src/itemmodel.qdoc
index 35e72cf9..682ebb1f 100644
--- a/examples/itemmodel/doc/src/itemmodel.qdoc
+++ b/examples/itemmodel/doc/src/itemmodel.qdoc
@@ -57,7 +57,7 @@
 
     \snippet ../examples/itemmodel/main.cpp 2
 
-    Here we tell the mapping object to directly map model's rows and columns into proxy's rows and
+    Here we tell the mapping object to directly map the model's rows and columns into the proxy's rows and
     columns instead of defining row and column roles to map for them. Then we give the model from
     the table widget and the mapping object to the proxy. Finally we set the proxy as the active
     data proxy for the graph.
@@ -65,7 +65,7 @@
     Next, let's create another class to handle the data addition and other interaction with the
     graph. Let's call it GraphDataGenerator (See \l {Setting up the graph} and
     \l {Adding data to the graph} for details) and connect some signals between Q3DBars,
-    GraphDataGenerator and QTableWidget (See \l {Interacting with the data} for a closer look):
+    GraphDataGenerator, and QTableWidget (See \l {Interacting with the data} for a closer look):
 
     \snippet ../examples/itemmodel/main.cpp 3
 
@@ -92,7 +92,7 @@
     displayed separately.
 
     Next line sets the font to \c Impact. If your system doesn't have it, it will be replaced by
-    system default.
+    the system default.
 
     And finally, we set theme to \c Digia and camera position to \c {Preset Front}. Now the initial
     graph settings are done.
diff --git a/examples/qmlbars/doc/src/qmlbars.qdoc b/examples/qmlbars/doc/src/qmlbars.qdoc
index 185956ea..9f51f89e 100644
--- a/examples/qmlbars/doc/src/qmlbars.qdoc
+++ b/examples/qmlbars/doc/src/qmlbars.qdoc
@@ -66,7 +66,7 @@
 
     \snippet ../examples/qmlbars/qml/qmlbars/main.qml 0
 
-    The axis change is done because income and expenses have different label format. The same could have
+    The axis change is done because income and expenses have a different label format. The same could have
     been achieved using a single axis and just changing the label format.
 
     The second interesting block is where we filter some of the rows away from the visualized data:
diff --git a/examples/qmlscatter/doc/src/qmlscatter.qdoc b/examples/qmlscatter/doc/src/qmlscatter.qdoc
index 91dd74b8..92e7ba35 100644
--- a/examples/qmlscatter/doc/src/qmlscatter.qdoc
+++ b/examples/qmlscatter/doc/src/qmlscatter.qdoc
@@ -98,14 +98,14 @@
 
     \snippet ../examples/qmlscatter/qml/qmlscatter/main.qml 2
 
-    Now the graph is ready to use, but has no data. It also has the default proxy, axes and visual
+    Now the graph is ready for use, but has no data. It also has the default proxy, axes, and visual
     properties.
 
     Let's modify some visual properties first by adding the following inside \c {scatterGraph}:
 
     \snippet ../examples/qmlscatter/qml/qmlscatter/main.qml 3
 
-    We changed the font, theme and shadow quality. We're happy with the other visual properties,
+    We changed the font, theme, and shadow quality. We're happy with the other visual properties,
     so we won't change them.
 
     Then it's time to start feeding the graph some data.
diff --git a/examples/qmlsurface/doc/src/qmlsurface.qdoc b/examples/qmlsurface/doc/src/qmlsurface.qdoc
index c93ed2d6..12e326c8 100644
--- a/examples/qmlsurface/doc/src/qmlsurface.qdoc
+++ b/examples/qmlsurface/doc/src/qmlsurface.qdoc
@@ -28,13 +28,13 @@
     \image qmlsurface-example.png
 
     The focus in this example is on generating a surface graph from height data, so in this section
-    we skip explaining application creation. For more detailed QML example documentation,
+    we skip explaining the application creation. For more detailed QML example documentation,
     see \l{Qt Quick 2 Scatter Example}.
 
     \section1 Adding data to the graph
 
-    This example shows two method to set data to surface graph, using the HeightMapSurfaceDataProxy
-    and ItemModelSurfaceDataProxy. First we go through setting the data using height map specific
+    This example shows two methods to set data to surface graph, using the HeightMapSurfaceDataProxy
+    and ItemModelSurfaceDataProxy. First we go through setting the data using the height map specific
     data proxy. It is done with the code snippet below. The \c heightMapFile property specifies the image
     file containing the height data. The value properties defines the minimum and maximum values for
     surface area width and depth. This example shows the terrain around Tycho crater at imaginary
diff --git a/examples/scatter/doc/src/scatter.qdoc b/examples/scatter/doc/src/scatter.qdoc
index f1c8ddf5..2016a052 100644
--- a/examples/scatter/doc/src/scatter.qdoc
+++ b/examples/scatter/doc/src/scatter.qdoc
@@ -61,7 +61,7 @@
 
     \snippet ../examples/scatter/main.cpp 2
 
-    The application main is done and we can show the graph and start the event loop:
+    The application main is done. We can show the graph and start the event loop:
 
     \snippet ../examples/scatter/main.cpp 3
 
@@ -109,7 +109,7 @@
 
     \snippet ../examples/scatter/scatterdatamodifier.cpp 5
 
-    And populate it:
+    and populate it:
 
     \snippet ../examples/scatter/scatterdatamodifier.cpp 6
 
diff --git a/examples/surface/doc/src/surface.qdoc b/examples/surface/doc/src/surface.qdoc
index 71c6582d..e669948c 100644
--- a/examples/surface/doc/src/surface.qdoc
+++ b/examples/surface/doc/src/surface.qdoc
@@ -100,9 +100,9 @@
 
     \section1 Selection modes
 
-    Q3Dsurface supports three different selection modes and these are demonstrated on the
-    example with radio buttons which the user can use to activate suitable selection mode.
-    Following inline methods are connected to radio buttons to activate the selected mode.
+    Q3Dsurface supports three different selection modes. These are demonstrated in the
+    example with radio buttons, which the user can use to activate a suitable selection mode.
+    The following inline methods are connected to radio buttons to activate the selected mode.
 
     \snippet ../examples/surface/surfacegraph.h 0
 
@@ -110,17 +110,15 @@
 
     The example has four slider controls for adjusting the min and max values for X and Z
     axis. When selecting the proxy these sliders are adjusted so that one step on the slider
-    moves the range by one segment step.
-
-    Finally the ranges are set for the graph like this:
+    moves the range by one segment step. Finally the ranges are set for the graph like this:
 
     \snippet ../examples/surface/surfacegraph.cpp 5
 
     \section1 Themes
 
     Q3Dsurface supports all the themes QtDatavisualization has. The example has a pull
-    down menu for selecting the theme and the following code snippet is connected to the menu to
-    activate the selected theme.
+    down menu for selecting the theme. The following code snippet is connected to the
+    menu to activate the selected theme.
 
     \snippet ../examples/surface/surfacegraph.cpp 6
 
diff --git a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc
index f2245c12..456f8ac5 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-index.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-index.qdoc
@@ -19,7 +19,7 @@
 /*!
     \title Qt Data Visualization
     \page qtdatavisualization-index.html
-    \brief QtDataVisualization module provides functionality for 3D visualization.
+    \brief Provides functionality for 3D visualization.
 
     Qt Data Visualization module provides a way to visualize data in 3D.
 
@@ -28,7 +28,7 @@
     \list
         \li Multiple data visualization options: 3D Bars, 3D Scatter, and 3D Surface
         \li 2D slice views of the 3D data
-        \li Interactive data: Rotate, zoom, and highlight data using mouse or touch
+        \li Interactive data: rotate, zoom, and highlight data using mouse or touch
         \li Uses OpenGL for rendering the data
         \li QML2 support
         \li Customizable axes for data - control viewable data window with axis ranges
@@ -50,14 +50,14 @@
 
     \snippet doc_src_qtdatavisualization.cpp 0
 
-    \note If you are using a few classes from this module, we recommend including those specific
-    classes only instead of the whole module.
+    \note If you are only using a few classes from this module, we recommend including only those
+    specific classes instead of the whole module.
 
-    To link against Qt Data Visualization module, add this line to your \c qmake project file:
+    To link against the Qt Data Visualization module, add this line to your \c qmake project file:
 
     \snippet doc_src_qtdatavisualization.pro 0
 
-    See \l{Qt Data Visualization Getting Started}{Getting started} page for further information
+    See the \l{Qt Data Visualization Getting Started}{Getting started} page for further information on
     how to use Qt Data Visualization in your application.
 
     \section1 Articles
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc
index ecc40cdf..c55b7ec1 100644
--- a/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization-qml-surface3d.qdoc
@@ -22,11 +22,11 @@
   \inqmlmodule com.digia.QtDataVisualization
   \since com.digia.QtDataVisualization 1.0
   \ingroup datavisualization_qml
-  \brief 3D surface graph.
+  \brief Describes the usage of the 3D surface graph.
 
   This type enables developers to render surface plots in 3D with Qt Quick 2.
 
-  You will need to import data visualization module to use this type:
+  You will need to import the data visualization module to use this type:
 
   \snippet doc_src_qmldatavisualization.cpp 0
 
@@ -53,7 +53,7 @@
 
   If an axis is not given, a temporary default axis with no labels and automatically adjusting
   range is created.
-  This temporary axis is destroyed if another axis is explicitly set to same orientation.
+  This temporary axis is destroyed if another axis is explicitly set to the same orientation.
  */
 
 /*!
@@ -62,7 +62,7 @@
 
   If an axis is not given, a temporary default axis with no labels and automatically adjusting
   range is created.
-  This temporary axis is destroyed if another axis is explicitly set to same orientation.
+  This temporary axis is destroyed if another axis is explicitly set to the same orientation.
  */
 
 /*!
@@ -71,17 +71,17 @@
 
   If an axis is not given, a temporary default axis with no labels and automatically adjusting
   range is created.
-  This temporary axis is destroyed if another axis is explicitly set to same orientation.
+  This temporary axis is destroyed if another axis is explicitly set to the same orientation.
  */
 
 /*!
   \qmlproperty bool Surface3D::smoothSurfaceEnabled
-  Smoothing of surface. If false, shading of the surface is flat.
+  The smoothing of surface. If false, the shading of the surface is flat.
  */
 
 /*!
   \qmlproperty bool Surface3D::surfaceGridEnabled
-  Surface grid visibility. If false, no surface grid is drawn.
+  The surface grid visibility. If false, no surface grid is drawn.
  */
 
 /*!
diff --git a/src/datavisualization/doc/src/qtdatavisualization.qdoc b/src/datavisualization/doc/src/qtdatavisualization.qdoc
index 92f8cc55..393bd6f9 100644
--- a/src/datavisualization/doc/src/qtdatavisualization.qdoc
+++ b/src/datavisualization/doc/src/qtdatavisualization.qdoc
@@ -23,7 +23,7 @@
 
     \brief C++ classes for the Qt Data Visualization API.
 
-    Qt Data Visualization functionality can be accessed via these C++ classes.
+    The Qt Data Visualization functionality can be accessed via these C++ classes.
 */
 
 /*!
@@ -33,7 +33,7 @@
 
     \brief QML types for the Qt Data Visualization API.
 
-    Qt Data Visualization functionality can be accessed via these QML types.
+    The Qt Data Visualization functionality can be accessed via these QML types.
 
     \section1 QML Types
 */
@@ -57,7 +57,7 @@
 
     \section1 Building Qt Data Visualization
 
-    To build Qt Data Visualization module, set up a command prompt with an environment for
+    To build the Qt Data Visualization module, set up a command prompt with an environment for
     building Qt applications, navigate to the directory containing \c qtdatavisualization.pro, and
     configure the project with qmake:
     \code
@@ -122,8 +122,8 @@
 
     \section1 Running examples
 
-    Qt Data Visualization examples are found under \c examples subdirectory. To build and run a
-    single example, e.g. the qmlsurface example, navigate to the example directory and give the
+    Qt Data Visualization examples are found under the \c examples subdirectory. To build and run a
+    single example, for example, the qmlsurface example, navigate to the example directory and enter the
     following commands:
 
     \snippet doc_src_qtdatavisualization.cpp 8
@@ -143,12 +143,13 @@
     \snippet doc_src_qtdatavisualization.cpp 0
 
     Then, add the sample code found in one of the following pages, depending on what kind of
-    visualization you are interested in: \l{How to construct a minimal Q3DBars graph},
+    visualization you are interested in:
+    \l{How to construct a minimal Q3DBars graph},
     \l{How to construct a minimal Q3DScatter graph}, or
     \l{How to construct a minimal Q3DSurface graph}.
 
     To use Qt Data Visualization graphs in widget based applications, you can use
-    QWidget::createWindowContainer() function to wrap the graph into a widget:
+    the QWidget::createWindowContainer() function to wrap the graph into a widget:
 
     \snippet doc_src_qtdatavisualization.cpp 9
 
@@ -163,8 +164,8 @@
 
     \section1 Data proxies
 
-    The data users wish to visualize comes in many formats, all of which cannot obviously be
-    directly supported. Therefore Qt Data Visualization implements data proxies into which
+    The data that users wish to visualize comes in many formats, all of which cannot obviously be
+    directly supported. Therefore, Qt Data Visualization implements data proxies into which
     user can feed their data in a known format. Each visualization type has a basic proxy type,
     which takes data in a format suitable for that visualization.
     For example, the basic proxy for Q3DBars is QBarDataProxy, which stores rows of QBarDataItem
@@ -178,7 +179,7 @@
 
     \note The graph objects can own more than one data proxy, but only one proxy can be
     active at a time. If you need to switch back and forth between two different sets of data,
-    it may be more efficient to store each set in different proxy and just change the active
+    it may be more efficient to store each set in a different proxy and just change the active
     proxy, rather than reset the data in one proxy every time you need to switch.
 
     \section1 Item models and data mapping
@@ -186,8 +187,8 @@
     For common use cases, Qt Data Visualization offers specialized proxies. One such case is having
     data in an item model (QAbstractItemModel subclass), which is a common way to store data in
     Qt applications. Each of the visualization types offers a special proxy and a corresponding mapping
-    class for this purpose, e.g. QItemModelBarDataProxy and QItemModelBarDataMapping for Q3DBars.
-    These proxies are simple to use - just give them a pointer to the item model containing the
+    class for this purpose, for example, QItemModelBarDataProxy and QItemModelBarDataMapping for Q3DBars.
+    These proxies are simple to use: just give them a pointer to the item model containing the
     data and the mapping object containing rules how to map the data into format the basic proxy can
     digest.
 
@@ -197,16 +198,16 @@
     and which role specifies the value of the item. When the proxy resolves the data from the model,
     it uses these mappings to generate the rows and columns of the bar graph.
 
-    Depending on the visualization type, mapping classes may support other functionality as well,
+    Depending on the visualization type, mapping classes may support other functionalities as well,
     such as QItemModelBarDataMapping optionally mapping QAbstractItemModel rows and columns directly
     into bar graph rows and columns. See individual mapping classes for more information and examples
-    how to use them: QItemModelBarDataMapping, QItemModelScatterDataMapping, and
+    about how to use them: QItemModelBarDataMapping, QItemModelScatterDataMapping, and
     QItemModelSurfaceDataMapping.
 
     \section1 Other custom proxies
 
     QHeightMapSurfaceDataProxy is a specialized proxy for generating a surface graph from a
-    heightmap image. See QHeightMapSurfaceDataProxy documentation for more information.
+    heightmap image. See the QHeightMapSurfaceDataProxy documentation for more information.
 
     The \l{Custom Proxy Example}{Custom Proxy} example shows how a custom proxy can be created. It
     defines a custom data set based on variant lists and an extension of the basic proxy to resolve
@@ -218,13 +219,13 @@
     ensure good performance. Since memory allocation is a costly operation, always use
     QList::reserve() and QVector::resize() where possible to avoid reallocations when constructing
     the array to give to the proxy. If you need to change the entire data set for each frame,
-    it is in most cases best to re-use the existing array - especially if the array dimensions do not
+    it is in most cases best to reuse the existing array - especially if the array dimensions do not
     change. If you need to add, insert, remove, or change several rows or items for each frame, it
     is always more efficient to do it with one method call instead of multiple calls affecting
     a single row or item each. For example, adding ten rows with a single QBarDataProxy::addRows() call
     is much more efficient than ten separate QBarDataProxy::addRow() calls.
 
-    Bars renderer is optimized to access only data that is within data window and thus should not
+    Bars renderer is optimized to access only data that is within the data window and thus should not
     suffer noticeable slowdown even if more data is continually added to the proxy.
 
     Due to the unsorted nature of the scatter data, any change in the data window ranges requires
@@ -232,9 +233,9 @@
     continually added to the proxy.
 
     Surface data, while on item level similar to scatter data, is already assigned into rows and
-    columns, so the surface renderer can do some optimization by making assumption that the data in
+    columns, so the surface renderer can do some optimization by making the assumption that the data in
     rows and columns is sorted along their respective axes, but it is nowhere near as efficient
-    as in bars case. Surface rendering can suffer significant slowdown if the data size grows unchecked.
+    as in the bars case. Surface rendering can suffer significant slowdown if the data size grows unchecked.
 
     For the best performance with the scatter and surface graphs, only keep the data you need in the
     proxy.
@@ -253,21 +254,21 @@
     see QTouch3DInputHandler documentation.
 
     \note In the technology preview version, default input handlers cannot be replaced or even accessed
-    via public API. This feature is planned for the final release.
+    via the public API. This feature is planned for the final release.
 
     \section1 Data selection modes
 
-    All visualization types support selecting single data item - a bar, a scatter item, or a surface
+    All visualization types support selecting a single data item - a bar, a scatter item, or a surface
     vertex - using mouse, touch, and programmatically via the graph APIs. The selected item is highlighted
     in the rendered graph, and selecting causes emission of a graph specific signal for this purpose,
-    e.g. Q3DBars::selectedBarPosChanged(), which the application can handle.
+    for example, Q3DBars::selectedBarPosChanged(), which the application can handle.
 
-    \note Surface graph doesn't have fully implemented selection API yet, it only supports
+    \note The surface graph doesn't have a fully implemented selection API yet. It only supports
     selection with mouse and touch in the technology preview version.
 
     Bar and surface graphs support slice selection modes, where the selected row or column is drawn
     in a separate viewport as a pseudo-2D graph. This makes it easier to see the actual values of
-    single row or column.
+    a single row or column.
 
     Bar graph additionally supports simply highlighting the whole row and/or column of the selected bar
     without opening the slice view.