From 7887008b43e27aba29c9e66ee78e012f13614b96 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 3 Feb 2014 13:22:43 +0100 Subject: 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 --- basicsuite/graphicaleffects/description.txt | 4 +++- basicsuite/mediaplayer/description.txt | 4 ++-- basicsuite/photogallery/description.txt | 2 +- basicsuite/qt5-everywhere/description.txt | 2 +- .../qt5-launchpresentation/qt5-lauchpresentation.pro | 18 ------------------ .../qt5-launchpresentation/qt5-launchpresentation.pro | 18 ++++++++++++++++++ basicsuite/qt5-particlesdemo/doc/src/emitters.qdoc | 2 ++ basicsuite/sensorexplorer/doc/src/sensor_explorer.qdoc | 5 ++++- basicsuite/sensors/description.txt | 5 ++--- basicsuite/textinput/description.txt | 2 +- 10 files changed, 34 insertions(+), 28 deletions(-) delete mode 100644 basicsuite/qt5-launchpresentation/qt5-lauchpresentation.pro create mode 100644 basicsuite/qt5-launchpresentation/qt5-launchpresentation.pro (limited to 'basicsuite') 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-lauchpresentation.pro deleted file mode 100644 index c3aba46..0000000 --- a/basicsuite/qt5-launchpresentation/qt5-lauchpresentation.pro +++ /dev/null @@ -1,18 +0,0 @@ -TARGET = qt5-launchpresentation - -include(../shared/shared.pri) -b2qtdemo_deploy_defaults() - -content.files = \ - *.qml \ - calqlatr \ - maroon \ - particles \ - presentation \ - samegame \ - images -content.path = $$DESTPATH - -OTHER_FILES += $${content.files} - -INSTALLS += target content \ No newline at end of file diff --git a/basicsuite/qt5-launchpresentation/qt5-launchpresentation.pro b/basicsuite/qt5-launchpresentation/qt5-launchpresentation.pro new file mode 100644 index 0000000..c3aba46 --- /dev/null +++ b/basicsuite/qt5-launchpresentation/qt5-launchpresentation.pro @@ -0,0 +1,18 @@ +TARGET = qt5-launchpresentation + +include(../shared/shared.pri) +b2qtdemo_deploy_defaults() + +content.files = \ + *.qml \ + calqlatr \ + maroon \ + particles \ + presentation \ + samegame \ + images +content.path = $$DESTPATH + +OTHER_FILES += $${content.files} + +INSTALLS += target content \ No newline at end of file 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. -- cgit v1.2.3