diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-06-24 16:27:18 +0200 |
|---|---|---|
| committer | Tomi Korpipää <tomi.korpipaa@theqtcompany.com> | 2015-06-25 09:39:55 +0000 |
| commit | 330656aede38ce84735248de1d900a9ab998e826 (patch) | |
| tree | fce50bace726c6b55fd4f6f5215fc032dd4ef46b /examples/qt3d/planets-qml/doc | |
| parent | 8a3f7750511f050e8b31b0582aa3485f0722c1b8 (diff) | |
Doc: edit Planets example docs
Move the image to the top.
Use standard phrasing to introduce the example.
Add a reference to an include file from qtbase/doc/global/includes
that describes building and running examples from Qt Creator.
Add an Oxford comma.
Change-Id: I2595b4901754ad0181a607f74e31a56673bf5259
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Diffstat (limited to 'examples/qt3d/planets-qml/doc')
| -rw-r--r-- | examples/qt3d/planets-qml/doc/src/planets-qml.qdoc | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc b/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc index d68a21b2d..f50a84fec 100644 --- a/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc +++ b/examples/qt3d/planets-qml/doc/src/planets-qml.qdoc @@ -40,12 +40,12 @@ \ingroup qt3d-examples-qml \brief Demonstrates combining Qt 3D rendering and Qt Quick 2 elements. - The Planets example demonstrates how to implement an application that combines the use of + \image planets-qml-example.jpg + + \e Planets demonstrates how to implement an application that combines the use of Qt 3D rendering with Qt Quick 2D elements. The example shows the eight planets of our Solar System with the Sun. - \image planets-qml-example.jpg - Planet texture maps are Copyright (c) by James Hastings-Trew \l{http://planetpixelemporium.com/planets.html}{http://planetpixelemporium.com/planets.html} used with permission. @@ -55,6 +55,8 @@ \l {http://www.stjarnhimlen.se/comp/ppcomp.html}{http://www.stjarnhimlen.se/comp/ppcomp.html} and \l {http://www.davidcolarusso.com/astro/}{http://www.davidcolarusso.com/astro/}. + \include examples-run.qdocinc + \section1 Qt Quick 2D Implementation The Qt Quick Implementation \l{planets-qml/PlanetsMain.qml}{PlanetsMain.qml} of the @@ -99,7 +101,7 @@ constructed with JavaScript in \l{planets-qml/planets.js}{planets.js} by calling \c{loadPlanetData()} as the component completes. Other initializations, such as inserting the planets into an array for easier handling, calculating the ring radii for Saturn and Uranus - rings, and setting the default scale, speed and camera offset, are done as well: + rings, and setting the default scale, speed, and camera offset, are done as well: \snippet planets-qml/SolarSystem.qml 2 |