diff options
author | Lincoln Ramsay <lincoln.ramsay@nokia.com> | 2011-09-27 16:34:20 +1000 |
---|---|---|
committer | Lincoln Ramsay <lincoln.ramsay@nokia.com> | 2011-10-10 09:25:31 +1000 |
commit | 7553fe500a0059ca2975e291b9acde6e372c002d (patch) | |
tree | 9f07560a699b9b5458b52455ce409d3c35adc453 /doc/src/examples/sensors.qdoc | |
parent | 2ae28157cc76180fd79765f612deece7974d5c0e (diff) |
Getting some structure into the sensors docs.
QtSensors is a landing page (from the Modules index).
There's a QtSensors Examples page that has all the examples on it.
The QtSensors page links off to the C++ and QML API pages.
More to do but this is a good start.
Change-Id: I2b795a759490e712137024101a630193d2d26033
Reviewed-on: http://codereview.qt-project.org/5589
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com>
Diffstat (limited to 'doc/src/examples/sensors.qdoc')
-rw-r--r-- | doc/src/examples/sensors.qdoc | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/src/examples/sensors.qdoc b/doc/src/examples/sensors.qdoc index 3f5a9a2a..3c045256 100644 --- a/doc/src/examples/sensors.qdoc +++ b/doc/src/examples/sensors.qdoc @@ -26,8 +26,22 @@ ****************************************************************************/ /*! + \group qtsensors-examples + \title QtSensors Examples + \brief Examples for the QtSensors module + \ingroup all-examples + \ingroup qtsensors + + These are the QtSensors examples. + + \generatelist related +*/ + +/*! \example sensors/grueplugin \title Grue Plugin + \brief The Grue Plugin demonstrates creation of a new sensor backend. + \ingroup qtsensors-examples The Grue plugin example demonstrates the creation of a new sensor type, a sensor backend and plugin for the sensors library. Related to this example @@ -119,6 +133,8 @@ /*! \example sensors/grueapp \title Grue Application + \brief The Grue Application demonstrates use of a new sensor type. + \ingroup qtsensors-examples The Grue application example demonstrates the use of the Grue sensor which was defined and implemented by the \l{sensors/grueplugin}{Grue Plugin} example. @@ -133,6 +149,7 @@ /*! \example sensors/cubehouse \title Cube House + \ingroup qtsensors-examples \image cubehouse.png @@ -157,6 +174,7 @@ /*! \example sensors/sensor_explorer \title Sensor Explorer + \ingroup qtsensors-examples \image sensor_explorer.png @@ -164,3 +182,22 @@ It was designed as a debugging aid. */ +/*! + \example sensors/qmlqtsensors5 + \title QtSensors 5 QML API example + \ingroup qtsensors-examples + + The QtSensors 5 QML API example demonstrates the QML elements in the QtSensors 5 import. + + \sa QtSensors +*/ + +/*! + \example sensors/maze + \title Maze + \brief The Maze example demonstrates the TiltSensor QML element + \ingroup qtsensors-examples + + The Maze example demonstrates the use of the TiltSensor QML element. +*/ + |