diff options
author | Nico Vertriest <nico.vertriest@digia.com> | 2013-10-16 12:49:19 +0200 |
---|---|---|
committer | Miikka Heikkinen <miikka.heikkinen@digia.com> | 2013-10-18 07:51:37 +0300 |
commit | d7b9b0d216f594ce9964ee3c8253f1c8ba2a920a (patch) | |
tree | b379c8261b2abaf7dbca02b95f524c050cefa582 /examples | |
parent | 790a1797eb43aa063240de829f5a34b4a7c86753 (diff) |
Doc: language/style review datavisualization doc
Task-number: QTBUG-33360
Change-Id: Ib6918dcc4c0ee213dddb118616940306a10001fa
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@digia.com>
Diffstat (limited to 'examples')
-rw-r--r-- | examples/audiolevels/doc/src/audiolevels.qdoc | 4 | ||||
-rw-r--r-- | examples/customproxy/doc/src/customproxy.qdoc | 6 | ||||
-rw-r--r-- | examples/itemmodel/doc/src/itemmodel.qdoc | 6 | ||||
-rw-r--r-- | examples/qmlbars/doc/src/qmlbars.qdoc | 2 | ||||
-rw-r--r-- | examples/qmlscatter/doc/src/qmlscatter.qdoc | 4 | ||||
-rw-r--r-- | examples/qmlsurface/doc/src/qmlsurface.qdoc | 6 | ||||
-rw-r--r-- | examples/scatter/doc/src/scatter.qdoc | 4 | ||||
-rw-r--r-- | examples/surface/doc/src/surface.qdoc | 14 |
8 files changed, 22 insertions, 24 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 |