summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2014-02-03 13:22:43 +0100
committerTopi Reiniƶ <topi.reinio@digia.com>2014-02-04 15:33:31 +0200
commit7887008b43e27aba29c9e66ee78e012f13614b96 (patch)
tree59099280b8f894786fdaab0ac93a2c828f4ce13b
parent6eca7933f42af800c64d3ee606ee56cb126970e4 (diff)
Doc: Improve demo documentation and descriptions
- Copy thumbnails from launcher to example documentation - Fix typos and improve demo descriptions and use them also in the example docs - Add missing docs for Qt 5 Launch Presentation, fix typo in its .pro file name. Change-Id: Ic658b7e536853d7272aaee26c6fd8769bc3fc060 Reviewed-by: Eirik Aavitsland <eirik.aavitsland@digia.com>
-rw-r--r--basicsuite/graphicaleffects/description.txt4
-rw-r--r--basicsuite/mediaplayer/description.txt4
-rw-r--r--basicsuite/photogallery/description.txt2
-rw-r--r--basicsuite/qt5-everywhere/description.txt2
-rw-r--r--basicsuite/qt5-launchpresentation/qt5-launchpresentation.pro (renamed from basicsuite/qt5-launchpresentation/qt5-lauchpresentation.pro)0
-rw-r--r--basicsuite/qt5-particlesdemo/doc/src/emitters.qdoc2
-rw-r--r--basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc5
-rw-r--r--basicsuite/sensors/description.txt5
-rw-r--r--basicsuite/textinput/description.txt2
-rw-r--r--doc/b2qt-demos.qdoc98
-rw-r--r--doc/b2qt-demos.qdocconf3
-rw-r--r--doc/images/b2qt-demo-about-b2qt.jpgbin0 -> 28727 bytes
-rw-r--r--doc/images/b2qt-demo-camera.jpgbin0 -> 33458 bytes
-rw-r--r--doc/images/b2qt-demo-controls-touch.jpgbin0 -> 11179 bytes
-rw-r--r--doc/images/b2qt-demo-graphicaleffects.jpgbin0 -> 33841 bytes
-rw-r--r--doc/images/b2qt-demo-mediaplayer.jpgbin0 -> 29015 bytes
-rw-r--r--doc/images/b2qt-demo-photogallery.jpgbin0 -> 55274 bytes
-rw-r--r--doc/images/b2qt-demo-qt5-cinematicdemo.jpgbin0 -> 36830 bytes
-rw-r--r--doc/images/b2qt-demo-qt5-everywhere.jpgbin0 -> 34331 bytes
-rw-r--r--doc/images/b2qt-demo-qt5-launchpresentation.jpgbin0 -> 16252 bytes
-rw-r--r--doc/images/b2qt-demo-qt5-particlesdemo.jpgbin0 -> 8889 bytes
-rw-r--r--doc/images/b2qt-demo-sensorexplorer.jpgbin0 -> 21553 bytes
-rw-r--r--doc/images/b2qt-demo-sensors.jpgbin0 -> 19464 bytes
-rw-r--r--doc/images/b2qt-demo-textinput.jpgbin0 -> 16465 bytes
24 files changed, 111 insertions, 16 deletions
diff --git a/basicsuite/graphicaleffects/description.txt b/basicsuite/graphicaleffects/description.txt
index e2d3acf..c19b2c4 100644
--- a/basicsuite/graphicaleffects/description.txt
+++ b/basicsuite/graphicaleffects/description.txt
@@ -1,2 +1,4 @@
-This example shows the Qt Quick 2.0 ShaderEffect type and the QtGraphicalEffect module. Qt Quick 2.0 provides the ability to use inline GLSL in your Qt Quick applications to create stunning visual effects. However, as UIs typically reuse many of the same effects, the QtGraphicalEffects module provides a set of predefined, commonly used effects. This includes blur, drop-shadows, glow, blending, opacity masks and more.
+This example shows the Qt Quick 2.0 ShaderEffect type and the Qt Graphical Effects module. Qt Quick 2.0 provides the ability to use inline GLSL in your Qt Quick applications to create stunning visual effects.
+
+However, as UIs typically reuse many of the same effects, the Qt Graphical Effects module provides a set of predefined, commonly used effects. This includes blur, drop-shadows, glow, blending, opacity masks and more.
diff --git a/basicsuite/mediaplayer/description.txt b/basicsuite/mediaplayer/description.txt
index bf034e5..0868473 100644
--- a/basicsuite/mediaplayer/description.txt
+++ b/basicsuite/mediaplayer/description.txt
@@ -1,3 +1,3 @@
-The Media Player example demonstrates the use of the media playback features of Qt Multimedia with Qt Quick.
+The Media Player example demonstrates the use of media playback features provided by Qt Multimedia with Qt Quick.
-It can play from a file or from Internet, both videos and music.
+It can play content either from a file or a network source, both videos and music.
diff --git a/basicsuite/photogallery/description.txt b/basicsuite/photogallery/description.txt
index f5e302c..f47f907 100644
--- a/basicsuite/photogallery/description.txt
+++ b/basicsuite/photogallery/description.txt
@@ -1 +1 @@
-This is a simple photo gallery, showing images found in /data/images.
+This is a simple photo gallery, showing images found in /data/images. Images captured with the Camera demo will also appear in this folder.
diff --git a/basicsuite/qt5-everywhere/description.txt b/basicsuite/qt5-everywhere/description.txt
index efa4b99..4846702 100644
--- a/basicsuite/qt5-everywhere/description.txt
+++ b/basicsuite/qt5-everywhere/description.txt
@@ -1 +1 @@
-This demo contains several Qt Quick 2 applications which you can launch by tapping the devices.
+This demo shows how to use different user interface styles in several platforms and device types with one source code. It contains several Qt Quick 2 applications which you can launch by tapping each device.
diff --git a/basicsuite/qt5-launchpresentation/qt5-lauchpresentation.pro b/basicsuite/qt5-launchpresentation/qt5-launchpresentation.pro
index c3aba46..c3aba46 100644
--- a/basicsuite/qt5-launchpresentation/qt5-lauchpresentation.pro
+++ b/basicsuite/qt5-launchpresentation/qt5-launchpresentation.pro
diff --git a/basicsuite/qt5-particlesdemo/doc/src/emitters.qdoc b/basicsuite/qt5-particlesdemo/doc/src/emitters.qdoc
index ead695c..f19d981 100644
--- a/basicsuite/qt5-particlesdemo/doc/src/emitters.qdoc
+++ b/basicsuite/qt5-particlesdemo/doc/src/emitters.qdoc
@@ -30,6 +30,8 @@
\ingroup b2qt-demos
\brief This is a collection of examples using Emitters in the QML particle system.
+ \image b2qt-demo-qt5-particlesdemo.jpg
+
This is a collection of small QML examples relating to using Emitters in the particle system.
Each example is a small QML file emphasizing a particular element or feature.
diff --git a/basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc b/basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc
index 35f28d0..c9921a1 100644
--- a/basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc
+++ b/basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc
@@ -31,8 +31,11 @@
\brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors.
\ingroup b2qt-demos
- \section2 Sensor Explorer in QML
+ \image b2qt-demo-sensorexplorer.jpg
+ This example provides a list of all available sensors installed on the system for which Qt has
+ a backend. Start a sensor to see how values change depending from environment and user-device
+ interaction.
This example is divided into two parts:
diff --git a/basicsuite/sensors/description.txt b/basicsuite/sensors/description.txt
index f6048cc..e306066 100644
--- a/basicsuite/sensors/description.txt
+++ b/basicsuite/sensors/description.txt
@@ -1,4 +1,3 @@
-This demo utilizes the accelerometer and light sensor readings in an application.
+Demonstrates using the accelerometer and light sensors in a QML application.
-For the accelometer, tilting the device moves the bubble around. For the light sensor,
-exposing the device to different lighting conditions changes the display.
+Tilting the device moves the bubble around, based on readings from the accelerometer sensor. For the light sensor, exposing the device to different lighting conditions changes the displayed image.
diff --git a/basicsuite/textinput/description.txt b/basicsuite/textinput/description.txt
index d9b2f4f..e65bb3e 100644
--- a/basicsuite/textinput/description.txt
+++ b/basicsuite/textinput/description.txt
@@ -1,3 +1,3 @@
-This examples illustrates how to handle input on touch devices.
+This example illustrates how to handle input on touch devices.
The Boot to Qt stack comes with Qt Virtual Keyboard - a framework that consists of a C++ back end with support for custom input methods, as well as a reference keyboard front end implemented in QML, supporting multiple languages.
diff --git a/doc/b2qt-demos.qdoc b/doc/b2qt-demos.qdoc
index 7e9e640..4b41067 100644
--- a/doc/b2qt-demos.qdoc
+++ b/doc/b2qt-demos.qdoc
@@ -35,6 +35,13 @@
\title About Boot to Qt
\ingroup b2qt-demos
\brief Displays information about the Boot to Qt software stack.
+
+ \image b2qt-demo-about-b2qt.jpg
+
+ The \e {About Boot to Qt} demo provides an introduction to what Boot to Qt is all about.
+
+ It talks briefly about how the software stack is built up, rough hardware requirements
+ and how Boot to Qt differs from the more traditional Qt editions.
*/
/*!
@@ -42,6 +49,17 @@
\title Camera
\ingroup b2qt-demos
\brief Demonstrates using camera in a QML application.
+
+ \image b2qt-demo-camera.jpg
+
+ This example demonstrates the use of the camera features provided by Qt Multimedia with
+ Qt Quick.
+
+ Demo can be used to take pictures. Files are saved inside the \c {/data/images/} folder
+ and can be then viewed with the \l {Photo Gallery} demo application.
+
+ Camera parameters such as flash mode, scene mode or white balance can be changed. The
+ availability of parameters depends on what the camera driver provides.
*/
/*!
@@ -49,6 +67,14 @@
\title Controls Touch
\ingroup b2qt-demos
\brief Demonstrates a touch UI implemented with Qt Quick Controls.
+
+ \image b2qt-demo-controls-touch.jpg
+
+ The purpose of this example is to show Qt Quick Controls in practice. The example uses a
+ StackView to navigate between pages and illustrates the use of many of the controls provided
+ by Qt Quick Control, including Button, Slider, ProgressBar, TabBar and TextInput types. The
+ style in the example is a custom style made to look like the Android theme, it is written
+ purely in QML.
*/
/*!
@@ -56,6 +82,14 @@
\title Graphical Effects
\ingroup b2qt-demos
\brief Demonstrates the different graphical effects that can be used in a QML application.
+
+ \image b2qt-demo-graphicaleffects.jpg
+
+ This example shows the Qt Quick 2.0 ShaderEffect type and the Qt Graphical Effects module. Qt Quick
+ 2.0 provides the ability to use inline GLSL in your Qt Quick applications to create stunning visual
+ effects. However, as UIs typically reuse many of the same effects, the Qt Graphical Effects module
+ provides a set of predefined, commonly used effects. This includes blur, drop-shadows, glow,
+ blending, opacity masks and more.
*/
/*!
@@ -63,6 +97,12 @@
\title Media Player
\ingroup b2qt-demos
\brief A media player implemented in QML.
+
+ \image b2qt-demo-mediaplayer.jpg
+ The Media Player example demonstrates the use of the media playback features of Qt Multimedia with
+ Qt Quick.
+
+ It can play from a file or from a network source, both videos and music.
*/
/*!
@@ -70,13 +110,44 @@
\title Photo Gallery
\ingroup b2qt-demos
\brief A photo gallery implemented in QML.
+
+ \image b2qt-demo-photogallery.jpg
+
+ This is a simple photo gallery, showing images found in \c {/data/images} directory.
*/
/*!
\example qt5-cinematicdemo
- \title Qt5 Cinematic Demo
+ \title Qt 5 Cinematic Demo
\ingroup b2qt-demos
\brief A cool demonstration of the graphical prowess of Qt 5 and Qt Quick 2.
+
+ \image b2qt-demo-qt5-cinematicdemo.jpg
+
+ The Qt5 Cinematic Experience is a demo by "QUIt Coding", a small group of talented individuals
+ enjoying software development with cutting edge technologies. They are official members of the
+ Qt Ambassador Program.
+
+ The demo shows off a number features of Qt Quick 2.0. A nicely styled list control of movie
+ covers with lighting effects, particles and transitions. The information roll-down curvy
+ curtain is implemented using inline GLSL in the QML file.
+
+ More awesome looking Qt Quick examples are available from \l {http://quitcoding.com}.
+*/
+
+/*!
+ \example qt5-launchpresentation
+ \title Qt 5 Launch Presentation
+ \ingroup b2qt-demos
+ \brief A quick tour of what is new in Qt 5.
+
+ \image b2qt-demo-qt5-launchpresentation.jpg
+
+ This is an application written with Qt Quick, based on Qt 5.
+
+ The source code is also available here: \l {https://qt.gitorious.org/qt-labs/qt5-launch-demo}.
+ The demo makes use of the QML Presentation System, available from
+ \c {ssh://codereview.qt-project.org/qt-labs/qml-presentation-system.git} repository.
*/
/*!
@@ -85,21 +156,40 @@
\ingroup b2qt-demos
\brief Highlights the versatility and cross-platform capability of Qt
- The Qt 5 Everywhere demo shows how to use different user interface styles in several platforms and device types with one source code.
+ \image b2qt-demo-qt5-everywhere.jpg
+
+ The Qt 5 Everywhere demo shows how to use different user interface styles in several platforms
+ and device types with one source code.
+
+ The demo contains several Qt Quick 2 applications which you can launch by tapping the devices.
*/
/*!
\example sensors
\title Sensors
\ingroup b2qt-demos
- \brief Demostrates using the accelerometer and light sensors in a QML application.
+ \brief Demonstrates using the accelerometer and light sensors in a QML application.
+
+ \image b2qt-demo-sensors.jpg
+
+ Tilting the device moves the bubble around, based on readings from the accelerometer sensor.
+ For the light sensor, exposing the device to different lighting conditions changes the
+ displayed image.
*/
/*!
\example textinput
\title Text Input
\ingroup b2qt-demos
- \brief Demostrates text input capabilities and the virtual keyboard in a QML application.
+ \brief Demonstrates text input capabilities and the virtual keyboard in a QML application.
+
+ \image b2qt-demo-textinput.jpg
+
+ This example illustrates how to handle input on touch devices.
+
+ The Boot to Qt stack comes with Qt Virtual Keyboard - a framework that consists of a C++ back
+ end with support for custom input methods, as well as a reference keyboard front end
+ implemented in QML, supporting multiple languages.
*/
/*!
diff --git a/doc/b2qt-demos.qdocconf b/doc/b2qt-demos.qdocconf
index ae55795..d1dec94 100644
--- a/doc/b2qt-demos.qdocconf
+++ b/doc/b2qt-demos.qdocconf
@@ -31,9 +31,8 @@ qhp.QtEnterpriseEmbeddedDemos.subprojects = demos
qhp.QtEnterpriseEmbeddedDemos.subprojects.demos.title = Qt Enterprise Embedded Examples and Demos
qhp.QtEnterpriseEmbeddedDemos.subprojects.demos.indexTitle = Qt Enterprise Embedded Examples and Demos
-# Add a thumbnail for all examples
manifestmeta.filters = thumbnail
-manifestmeta.thumbnail.attributes = "imageUrl:qthelp\://com.digia.b2qt-demos.200/b2qt-demos/images/b2qt-demo.png"
+#manifestmeta.thumbnail.attributes = "imageUrl:qthelp\://com.digia.b2qt-demos.200/b2qt-demos/images/b2qt-demo.png"
manifestmeta.thumbnail.tags = "b2qt,qtee"
manifestmeta.thumbnail.names = "QtEnterpriseEmbeddedDemos/*"
diff --git a/doc/images/b2qt-demo-about-b2qt.jpg b/doc/images/b2qt-demo-about-b2qt.jpg
new file mode 100644
index 0000000..f2eb2e0
--- /dev/null
+++ b/doc/images/b2qt-demo-about-b2qt.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-camera.jpg b/doc/images/b2qt-demo-camera.jpg
new file mode 100644
index 0000000..3f15310
--- /dev/null
+++ b/doc/images/b2qt-demo-camera.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-controls-touch.jpg b/doc/images/b2qt-demo-controls-touch.jpg
new file mode 100644
index 0000000..c57eac3
--- /dev/null
+++ b/doc/images/b2qt-demo-controls-touch.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-graphicaleffects.jpg b/doc/images/b2qt-demo-graphicaleffects.jpg
new file mode 100644
index 0000000..80fbbd5
--- /dev/null
+++ b/doc/images/b2qt-demo-graphicaleffects.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-mediaplayer.jpg b/doc/images/b2qt-demo-mediaplayer.jpg
new file mode 100644
index 0000000..0fff215
--- /dev/null
+++ b/doc/images/b2qt-demo-mediaplayer.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-photogallery.jpg b/doc/images/b2qt-demo-photogallery.jpg
new file mode 100644
index 0000000..0b67f1d
--- /dev/null
+++ b/doc/images/b2qt-demo-photogallery.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-qt5-cinematicdemo.jpg b/doc/images/b2qt-demo-qt5-cinematicdemo.jpg
new file mode 100644
index 0000000..21bb2f9
--- /dev/null
+++ b/doc/images/b2qt-demo-qt5-cinematicdemo.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-qt5-everywhere.jpg b/doc/images/b2qt-demo-qt5-everywhere.jpg
new file mode 100644
index 0000000..1bb40bf
--- /dev/null
+++ b/doc/images/b2qt-demo-qt5-everywhere.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-qt5-launchpresentation.jpg b/doc/images/b2qt-demo-qt5-launchpresentation.jpg
new file mode 100644
index 0000000..8decd76
--- /dev/null
+++ b/doc/images/b2qt-demo-qt5-launchpresentation.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-qt5-particlesdemo.jpg b/doc/images/b2qt-demo-qt5-particlesdemo.jpg
new file mode 100644
index 0000000..fa0db59
--- /dev/null
+++ b/doc/images/b2qt-demo-qt5-particlesdemo.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-sensorexplorer.jpg b/doc/images/b2qt-demo-sensorexplorer.jpg
new file mode 100644
index 0000000..b0469e5
--- /dev/null
+++ b/doc/images/b2qt-demo-sensorexplorer.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-sensors.jpg b/doc/images/b2qt-demo-sensors.jpg
new file mode 100644
index 0000000..7ce979d
--- /dev/null
+++ b/doc/images/b2qt-demo-sensors.jpg
Binary files differ
diff --git a/doc/images/b2qt-demo-textinput.jpg b/doc/images/b2qt-demo-textinput.jpg
new file mode 100644
index 0000000..f415a86
--- /dev/null
+++ b/doc/images/b2qt-demo-textinput.jpg
Binary files differ