From e9aa193181cb2d7f3cb45f3076079a2d8dfe6c13 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 1 Nov 2016 17:11:40 +0100 Subject: Doc: Add section on running examples to example docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Include examples-run.qdocinc from qtbase/doc/global. - Add section title to Audiolevels example docs. - Remove unnecessary leading paragraph from Custom Proxy example docs. - Remove information about running examples from Getting Started topic. Change-Id: I33e8189fa20bad38e52f424b0143b4031ad7872f Reviewed-by: Topi Reiniö --- examples/datavisualization/audiolevels/doc/src/audiolevels.qdoc | 4 ++++ examples/datavisualization/bars/doc/src/bars.qdoc | 2 ++ examples/datavisualization/custominput/doc/src/custominput.qdoc | 2 ++ examples/datavisualization/customitems/doc/src/customitems.qdoc | 2 ++ examples/datavisualization/customproxy/doc/src/customproxy.qdoc | 2 +- examples/datavisualization/draggableaxes/doc/src/draggableaxes.qdoc | 2 ++ examples/datavisualization/itemmodel/doc/src/itemmodel.qdoc | 2 ++ examples/datavisualization/qmlaxisdrag/doc/src/qmlaxisdrag.qdoc | 2 ++ .../datavisualization/qmlaxisformatter/doc/src/qmlaxisformatter.qdoc | 2 ++ examples/datavisualization/qmlbars/doc/src/qmlbars.qdoc | 2 ++ examples/datavisualization/qmlcustominput/doc/src/qmlcustominput.qdoc | 2 ++ examples/datavisualization/qmllegend/doc/src/qmllegend.qdoc | 2 ++ examples/datavisualization/qmlmultigraph/doc/src/qmlmultigraph.qdoc | 2 ++ .../datavisualization/qmloscilloscope/doc/src/qmloscilloscope.qdoc | 2 ++ examples/datavisualization/qmlscatter/doc/src/qmlscatter.qdoc | 2 ++ examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc | 2 ++ examples/datavisualization/qmlsurface/doc/src/qmlsurface.qdoc | 2 ++ .../datavisualization/qmlsurfacelayers/doc/src/qmlsurfacelayers.qdoc | 2 ++ examples/datavisualization/rotations/doc/src/rotations.qdoc | 2 ++ examples/datavisualization/scatter/doc/src/scatter.qdoc | 2 ++ examples/datavisualization/surface/doc/src/surface.qdoc | 2 ++ examples/datavisualization/texturesurface/doc/src/texturesurface.qdoc | 2 ++ examples/datavisualization/volumetric/doc/src/volumetric.qdoc | 2 ++ 23 files changed, 47 insertions(+), 1 deletion(-) (limited to 'examples/datavisualization') diff --git a/examples/datavisualization/audiolevels/doc/src/audiolevels.qdoc b/examples/datavisualization/audiolevels/doc/src/audiolevels.qdoc index 9d2e2c7e..9995a079 100644 --- a/examples/datavisualization/audiolevels/doc/src/audiolevels.qdoc +++ b/examples/datavisualization/audiolevels/doc/src/audiolevels.qdoc @@ -45,6 +45,10 @@ concentrate on those and skip explaining the basic Q3DBars functionality - for that see \l{Bars Example}. + \include examples-run.qdocinc + + \section1 Visualizing Audio Levels + \c AudioLevelsIODevice subclasses QIODevice and is given as input device for QAudioInput class, so it receives microphone data. diff --git a/examples/datavisualization/bars/doc/src/bars.qdoc b/examples/datavisualization/bars/doc/src/bars.qdoc index 42fd41a0..4d1275cb 100644 --- a/examples/datavisualization/bars/doc/src/bars.qdoc +++ b/examples/datavisualization/bars/doc/src/bars.qdoc @@ -49,6 +49,8 @@ \image bars-example.png + \include examples-run.qdocinc + \section1 Creating the application First, in main.cpp, we create a QApplication, instantiate Q3DBars and a window container diff --git a/examples/datavisualization/custominput/doc/src/custominput.qdoc b/examples/datavisualization/custominput/doc/src/custominput.qdoc index 49e21a69..79eedb0d 100644 --- a/examples/datavisualization/custominput/doc/src/custominput.qdoc +++ b/examples/datavisualization/custominput/doc/src/custominput.qdoc @@ -42,6 +42,8 @@ \image custominput-example.png + \include examples-run.qdocinc + \section1 Replacing default input handling The default input handling mechanism is replaced by setting the active input handler of diff --git a/examples/datavisualization/customitems/doc/src/customitems.qdoc b/examples/datavisualization/customitems/doc/src/customitems.qdoc index 80dd73a9..9716d8a7 100644 --- a/examples/datavisualization/customitems/doc/src/customitems.qdoc +++ b/examples/datavisualization/customitems/doc/src/customitems.qdoc @@ -39,6 +39,8 @@ \image customitems-example.png + \include examples-run.qdocinc + \section1 Adding custom meshes to the application We'll add the meshes in a resource file: diff --git a/examples/datavisualization/customproxy/doc/src/customproxy.qdoc b/examples/datavisualization/customproxy/doc/src/customproxy.qdoc index 22fc8b6d..6e641eb7 100644 --- a/examples/datavisualization/customproxy/doc/src/customproxy.qdoc +++ b/examples/datavisualization/customproxy/doc/src/customproxy.qdoc @@ -50,7 +50,7 @@ The custom proxy we provide here is similar to item model based proxies provided by Qt Data Visualization in that it requires a mapping to interpret the data. - Let's take a closer look at the custom classes: + \include examples-run.qdocinc \section1 VariantDataSet diff --git a/examples/datavisualization/draggableaxes/doc/src/draggableaxes.qdoc b/examples/datavisualization/draggableaxes/doc/src/draggableaxes.qdoc index 7d722813..69993cca 100644 --- a/examples/datavisualization/draggableaxes/doc/src/draggableaxes.qdoc +++ b/examples/datavisualization/draggableaxes/doc/src/draggableaxes.qdoc @@ -41,6 +41,8 @@ \image draggableaxes-example.png + \include examples-run.qdocinc + \section1 Replacing default input handling The default input handling mechanism is replaced by setting the active input handler of diff --git a/examples/datavisualization/itemmodel/doc/src/itemmodel.qdoc b/examples/datavisualization/itemmodel/doc/src/itemmodel.qdoc index 942a17fc..b7cd7d15 100644 --- a/examples/datavisualization/itemmodel/doc/src/itemmodel.qdoc +++ b/examples/datavisualization/itemmodel/doc/src/itemmodel.qdoc @@ -46,6 +46,8 @@ \image itemmodel-example-2.png + \include examples-run.qdocinc + \section1 Creating the application First, in main.cpp, we create a QApplication, instantiate Q3DBars and a window container for it: diff --git a/examples/datavisualization/qmlaxisdrag/doc/src/qmlaxisdrag.qdoc b/examples/datavisualization/qmlaxisdrag/doc/src/qmlaxisdrag.qdoc index 3b0c96ed..564e837f 100644 --- a/examples/datavisualization/qmlaxisdrag/doc/src/qmlaxisdrag.qdoc +++ b/examples/datavisualization/qmlaxisdrag/doc/src/qmlaxisdrag.qdoc @@ -40,6 +40,8 @@ \image qmlaxisdrag-example.png + \include examples-run.qdocinc + \section1 Overriding default input handling First we deactivate the default input handling mechanism by setting the active input handler diff --git a/examples/datavisualization/qmlaxisformatter/doc/src/qmlaxisformatter.qdoc b/examples/datavisualization/qmlaxisformatter/doc/src/qmlaxisformatter.qdoc index 0782db8c..fb7fdfc1 100644 --- a/examples/datavisualization/qmlaxisformatter/doc/src/qmlaxisformatter.qdoc +++ b/examples/datavisualization/qmlaxisformatter/doc/src/qmlaxisformatter.qdoc @@ -43,6 +43,8 @@ that and skip explaining the basic functionality - for more detailed QML example documentation, see \l{Qt Quick 2 Scatter Example}. + \include examples-run.qdocinc + \section1 Custom axis formatter Customizing axis formatters requires subclassing the QValue3DAxisFormatter, which cannot be diff --git a/examples/datavisualization/qmlbars/doc/src/qmlbars.qdoc b/examples/datavisualization/qmlbars/doc/src/qmlbars.qdoc index 7228a7be..63d26a0b 100644 --- a/examples/datavisualization/qmlbars/doc/src/qmlbars.qdoc +++ b/examples/datavisualization/qmlbars/doc/src/qmlbars.qdoc @@ -42,6 +42,8 @@ at once. We'll concentrate on those and skip explaining the basic Bars3D functionality - for more detailed QML example documentation, see \l{Qt Quick 2 Scatter Example}. + \include examples-run.qdocinc + \section1 Data The example data is monthly income and expenses of a fictional company over several years. diff --git a/examples/datavisualization/qmlcustominput/doc/src/qmlcustominput.qdoc b/examples/datavisualization/qmlcustominput/doc/src/qmlcustominput.qdoc index 933053e9..4685790a 100644 --- a/examples/datavisualization/qmlcustominput/doc/src/qmlcustominput.qdoc +++ b/examples/datavisualization/qmlcustominput/doc/src/qmlcustominput.qdoc @@ -40,6 +40,8 @@ \image qmlcustominput-example.png + \include examples-run.qdocinc + \section1 Removing default input handling The default input handling mechanism is disabled by setting the inputHandler property to null. diff --git a/examples/datavisualization/qmllegend/doc/src/qmllegend.qdoc b/examples/datavisualization/qmllegend/doc/src/qmllegend.qdoc index 63a6874f..096fc2f3 100644 --- a/examples/datavisualization/qmllegend/doc/src/qmllegend.qdoc +++ b/examples/datavisualization/qmllegend/doc/src/qmllegend.qdoc @@ -41,6 +41,8 @@ that and skip explaining the basic functionality - for more detailed QML example documentation, see \l{Qt Quick 2 Scatter Example}. + \include examples-run.qdocinc + \section1 Legend The legend is simply a column of custom \c LegendItem items inside a transparent rectangle. diff --git a/examples/datavisualization/qmlmultigraph/doc/src/qmlmultigraph.qdoc b/examples/datavisualization/qmlmultigraph/doc/src/qmlmultigraph.qdoc index bc39b866..887a8ccf 100644 --- a/examples/datavisualization/qmlmultigraph/doc/src/qmlmultigraph.qdoc +++ b/examples/datavisualization/qmlmultigraph/doc/src/qmlmultigraph.qdoc @@ -41,6 +41,8 @@ simultaneously, so most functionality is not explained in detail. For more detailed QML example documentation, see \l{Qt Quick 2 Scatter Example}. + \include examples-run.qdocinc + \section1 Multiple Graphs Using multiple graphs in a single application doesn't require anything special, simply define diff --git a/examples/datavisualization/qmloscilloscope/doc/src/qmloscilloscope.qdoc b/examples/datavisualization/qmloscilloscope/doc/src/qmloscilloscope.qdoc index 2c80ed98..a76347de 100644 --- a/examples/datavisualization/qmloscilloscope/doc/src/qmloscilloscope.qdoc +++ b/examples/datavisualization/qmloscilloscope/doc/src/qmloscilloscope.qdoc @@ -42,6 +42,8 @@ that and skip explaining the basic functionality - for more detailed QML example documentation, see \l{Qt Quick 2 Scatter Example}. + \include examples-run.qdocinc + \section1 Data source in C++ The item model based proxies are good for simple and/or static graphs, but to achieve diff --git a/examples/datavisualization/qmlscatter/doc/src/qmlscatter.qdoc b/examples/datavisualization/qmlscatter/doc/src/qmlscatter.qdoc index 3a2185c2..7e842d36 100644 --- a/examples/datavisualization/qmlscatter/doc/src/qmlscatter.qdoc +++ b/examples/datavisualization/qmlscatter/doc/src/qmlscatter.qdoc @@ -42,6 +42,8 @@ \image qmlscatter-example.png + \include examples-run.qdocinc + \section1 Application basics Before diving into the QML code, let's take a look at the application \c main.cpp. diff --git a/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc b/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc index 895bc6b6..58addaf1 100644 --- a/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc +++ b/examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc @@ -47,6 +47,8 @@ functionality is not explained. For more detailed QML example documentation, see \l{Qt Quick 2 Scatter Example}. + \include examples-run.qdocinc + \section1 Creating a spectrogram To create a 2D spectrogram, we define a Surface3D item: diff --git a/examples/datavisualization/qmlsurface/doc/src/qmlsurface.qdoc b/examples/datavisualization/qmlsurface/doc/src/qmlsurface.qdoc index 55ec2bdd..fea48bf1 100644 --- a/examples/datavisualization/qmlsurface/doc/src/qmlsurface.qdoc +++ b/examples/datavisualization/qmlsurface/doc/src/qmlsurface.qdoc @@ -42,6 +42,8 @@ we skip explaining the application creation. For more detailed QML example documentation, see \l{Qt Quick 2 Scatter Example}. + \include examples-run.qdocinc + \section1 Adding data to the graph This example shows two methods to set data to surface graph, using the HeightMapSurfaceDataProxy diff --git a/examples/datavisualization/qmlsurfacelayers/doc/src/qmlsurfacelayers.qdoc b/examples/datavisualization/qmlsurfacelayers/doc/src/qmlsurfacelayers.qdoc index b92ceec6..2216acc7 100644 --- a/examples/datavisualization/qmlsurfacelayers/doc/src/qmlsurfacelayers.qdoc +++ b/examples/datavisualization/qmlsurfacelayers/doc/src/qmlsurfacelayers.qdoc @@ -42,6 +42,8 @@ map images, so in this section we skip explaining the application creation. For a more detailed QML example documentation, see \l{Qt Quick 2 Scatter Example}. + \include examples-run.qdocinc + \section1 Adding data to the graph This example shows how to add several surface series to one graph using using diff --git a/examples/datavisualization/rotations/doc/src/rotations.qdoc b/examples/datavisualization/rotations/doc/src/rotations.qdoc index a7e8245e..d28b872c 100644 --- a/examples/datavisualization/rotations/doc/src/rotations.qdoc +++ b/examples/datavisualization/rotations/doc/src/rotations.qdoc @@ -45,6 +45,8 @@ \image rotations-example.png + \include examples-run.qdocinc + \section1 Using rotations In this example we want to orient the arrow items tangentially to the origin. This requires diff --git a/examples/datavisualization/scatter/doc/src/scatter.qdoc b/examples/datavisualization/scatter/doc/src/scatter.qdoc index e7733ca5..f364010c 100644 --- a/examples/datavisualization/scatter/doc/src/scatter.qdoc +++ b/examples/datavisualization/scatter/doc/src/scatter.qdoc @@ -47,6 +47,8 @@ \image scatter-example.png + \include examples-run.qdocinc + \section1 Creating the application First, in main.cpp, we create a QApplication, instantiate Q3DScatter, and a window container diff --git a/examples/datavisualization/surface/doc/src/surface.qdoc b/examples/datavisualization/surface/doc/src/surface.qdoc index 66879b91..e1cc8263 100644 --- a/examples/datavisualization/surface/doc/src/surface.qdoc +++ b/examples/datavisualization/surface/doc/src/surface.qdoc @@ -50,6 +50,8 @@ \image surface-example.png + \include examples-run.qdocinc + \section1 Creating the application First, in \c main.cpp, we create a QApplication, instantiate Q3DSurface, and a window container diff --git a/examples/datavisualization/texturesurface/doc/src/texturesurface.qdoc b/examples/datavisualization/texturesurface/doc/src/texturesurface.qdoc index 19e0b973..2388a3a2 100644 --- a/examples/datavisualization/texturesurface/doc/src/texturesurface.qdoc +++ b/examples/datavisualization/texturesurface/doc/src/texturesurface.qdoc @@ -45,6 +45,8 @@ \image texturesurface-example.png + \include examples-run.qdocinc + \section1 Texture to a surface series The image to be set as a texture to a surface can be set using QSurface3DSeries::setTextureFile(). diff --git a/examples/datavisualization/volumetric/doc/src/volumetric.qdoc b/examples/datavisualization/volumetric/doc/src/volumetric.qdoc index 69e0caf3..d07db913 100644 --- a/examples/datavisualization/volumetric/doc/src/volumetric.qdoc +++ b/examples/datavisualization/volumetric/doc/src/volumetric.qdoc @@ -38,6 +38,8 @@ \image volumetric-example.png + \include examples-run.qdocinc + \section1 Initializing volume item The QCustom3DVolume items are special custom items (see QCustom3DItem), which can be used -- cgit v1.2.3