summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLincoln Ramsay <lincoln.ramsay@nokia.com>2012-02-15 13:59:13 +1000
committerQt by Nokia <qt-info@nokia.com>2012-02-15 06:32:03 +0100
commitdc4f4846c7ddbc03edd8950c674576fb44cd955d (patch)
treed13a851dd1d8930f0a2dc9fb8487c1c353a33afd /doc
parentc75ae5a33d3ee16181bf503db33ef7919fb40124 (diff)
downloadqtsensors-dc4f4846c7ddbc03edd8950c674576fb44cd955d.tar.gz
Locate sensor explorer QML app
It moved but the example page was looking in the wrong location. Since there is now one directory that holds the entire example, we can collapse 3 pages into 1. Change-Id: Id02844e88042436129c1e644d364a0c32fc71824 Reviewed-by: Wolfgang Beck <wolfgang.beck@nokia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/src/examples/sensor_explorer.qdoc24
1 files changed, 7 insertions, 17 deletions
diff --git a/doc/src/examples/sensor_explorer.qdoc b/doc/src/examples/sensor_explorer.qdoc
index 01ae17b..5fb5d99 100644
--- a/doc/src/examples/sensor_explorer.qdoc
+++ b/doc/src/examples/sensor_explorer.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
- \page sensor_explorer.html
+ \example sensors/sensor_explorer
\title Sensor Explorer example
\ingroup qtsensors-examples
\brief The Sensor Explorer example demonstrates how to read the meta-data of available sensors.
@@ -38,35 +38,25 @@
A \l{Sensor Explorer QML Import} to make the sensors and their meta-data available to a QML application.
A \l{Sensor Explorer QML Application} that represents the \l{Sensor Explorer QML Import} information to the user interface.
-*/
+ \section1 Sensor Explorer QML Import
-/*!
- \example sensors/sensor_explorer/import
- \title Sensor Explorer QML Import
- \brief The Sensor Explorer QML import exports the QSensorExplorer, QPropertyInfo and the QSensorItem class as a QML element.
+ The Sensor Explorer QML import exports the QSensorExplorer, QPropertyInfo and the QSensorItem class as a QML element.
This example creates the \e {Explorer 1.0} import.
- \sa {Sensor Explorer Example}
-*/
+ It consists of the code under the \c{import/} directory.
-/*!
- \example sensors/sensor_explorer/qml_app
- \title Sensor Explorer QML Application
- \brief The Sensor Explorer QML application demonstrates use of the Explorer 1.0 import QML elements.
+ \section1 Sensor Explorer QML Application
This is a pure QML application that can be run from Qt Creator or directly using the
- \c qmlscene binary. You should install the other projects before trying to run
- this example or it will not be able to find its dependencies.
+ \c qmlscene binary. This app won't work if it cannot locate its related import.
\code
qmlscene main.qml
\endcode
- \sa {Sensor Explorer Example}
-
-\section1 Overview
+\section2 Overview
To write a QML application that will use the Explorer QML element you need to do the following steps:
Import the Explorer 1.0 declarative plugin: