From b2e97817684f40ab9353fa279a4c02ef9c12e13d Mon Sep 17 00:00:00 2001 From: Lincoln Ramsay Date: Tue, 19 Jun 2012 15:47:09 +1000 Subject: Remove the 'special' naming of examples. Just go back to the naming convention we had before. Change-Id: Iefecb7a5e0ab3aa4d22267b4f475a8e9c1c96058 Reviewed-by: Lorn Potter --- doc/src/examples/accelbubble.qdoc | 10 +++++----- doc/src/examples/cubehouse.qdoc | 12 ++++++------ doc/src/examples/grue.qdoc | 16 ++++++++-------- doc/src/examples/maze.qdoc | 14 +++++++------- doc/src/examples/qmlqtsensors.qdoc | 16 ++++++++-------- doc/src/examples/qmlsensorgtestures.qdoc | 12 ++++++------ doc/src/examples/sensor_explorer.qdoc | 16 ++++++++-------- doc/src/examples/sensorgestures.qdoc | 6 +++--- doc/src/examples/shakeit.qdoc | 12 ++++++------ doc/src/qtsensors-cpp.qdoc | 2 +- 10 files changed, 58 insertions(+), 58 deletions(-) (limited to 'doc') diff --git a/doc/src/examples/accelbubble.qdoc b/doc/src/examples/accelbubble.qdoc index ea741282..db3f0311 100644 --- a/doc/src/examples/accelbubble.qdoc +++ b/doc/src/examples/accelbubble.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \example QtSensors/QtSensors_accelbubble + \example sensors/accelbubble \title Qt Sensors - Accel Bubble \brief The AccelBubble example demonstrates the Legacy Accelerometer QML type. \ingroup qtsensors-examples @@ -36,19 +36,19 @@ Import the Legacy Sensors Declarative module. -\snippet ../examples/QtSensors/QtSensors_accelbubble/QtSensors_accelbubble.qml 0 +\snippet ../examples/sensors/accelbubble/accelbubble.qml 0 Add an Accelerometer QML type. -\snippet ../examples/QtSensors/QtSensors_accelbubble/QtSensors_accelbubble.qml 1 +\snippet ../examples/sensors/accelbubble/accelbubble.qml 1 Use the 'active' property to start the sensor -\snippet ../examples/QtSensors/QtSensors_accelbubble/QtSensors_accelbubble.qml 2 +\snippet ../examples/sensors/accelbubble/accelbubble.qml 2 Move the bubble according to a factor of the accelerator sensor -\snippet ../examples/QtSensors/QtSensors_accelbubble/QtSensors_accelbubble.qml 3 +\snippet ../examples/sensors/accelbubble/accelbubble.qml 3 */ diff --git a/doc/src/examples/cubehouse.qdoc b/doc/src/examples/cubehouse.qdoc index 15e52fac..021906eb 100644 --- a/doc/src/examples/cubehouse.qdoc +++ b/doc/src/examples/cubehouse.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \example QtSensors/QtSensors_cubehouse + \example sensors/cubehouse \title Qt Sensors - Cube House QML Accelerometer example \ingroup qtsensors-examples \brief The Cube House example demonstrates the use of the accelerometer to drive a camera to create a pseudo-3D effect. @@ -37,24 +37,24 @@ Import the QtMobility.sensors declarative plugin: -\snippet ../examples/QtSensors/QtSensors_cubehouse/QtSensors_cubehouse.qml 0 +\snippet ../examples/sensors/cubehouse/cubehouse.qml 0 Add the Accelerometer QML types into your qml file. -\snippet ../examples/QtSensors/QtSensors_cubehouse/QtSensors_cubehouse.qml 1 +\snippet ../examples/sensors/cubehouse/cubehouse.qml 1 In additional two properties are added to save the calculated pitch and roll values: -\snippet ../examples/QtSensors/QtSensors_cubehouse/QtSensors_cubehouse.qml 2 +\snippet ../examples/sensors/cubehouse/cubehouse.qml 2 Reading out the Accelerometer data can be done by implementing the 'onReadingChanged' slot and accessing the 'reading' property from the Accelerometer type: -\snippet ../examples/QtSensors/QtSensors_cubehouse/QtSensors_cubehouse.qml 3 +\snippet ../examples/sensors/cubehouse/cubehouse.qml 3 By using a timer the view can be rotated using the pitch and roll properties from the Accelerometer type: -\snippet ../examples/QtSensors/QtSensors_cubehouse/QtSensors_cubehouse.qml 4 +\snippet ../examples/sensors/cubehouse/cubehouse.qml 4 */ diff --git a/doc/src/examples/grue.qdoc b/doc/src/examples/grue.qdoc index 37a602fe..6478f3bb 100644 --- a/doc/src/examples/grue.qdoc +++ b/doc/src/examples/grue.qdoc @@ -57,7 +57,7 @@ */ /*! - \example QtSensors/QtSensors_grue/lib + \example sensors/grue/lib \title Grue Sensor Definition \brief The Grue sensor is defined in a library so that applications can use it. @@ -78,7 +78,7 @@ */ /*! - \example QtSensors/QtSensors_grue/plugin + \example sensors/grue/plugin \title Grue Sensor Implementation \brief The Grue sensor implementation lives in a plugin that is loaded by the Qt Sensors library. @@ -94,13 +94,13 @@ light sensor. In the start method, the backend should be sure to call the sensorStopped() or sensorBusy() methods if it cannot start. - \snippet ../examples/QtSensors/QtSensors_grue/plugin/gruesensorimpl.cpp start + \snippet ../examples/sensors/grue/plugin/gruesensorimpl.cpp start The setReading method is needed so that the sensors library knows where the readings are coming from. This backend has a local copy of the reading so it passes a pointer to the function. - \snippet ../examples/QtSensors/QtSensors_grue/plugin/gruesensorimpl.cpp setReading + \snippet ../examples/sensors/grue/plugin/gruesensorimpl.cpp setReading However it is also possible to pass null to the setReading method in which case the sensors library will create an instance and return a pointer. @@ -123,7 +123,7 @@ */ /*! - \example QtSensors/QtSensors_grue/console_app + \example sensors/grue/console_app \title Grue Sensor Console Application \brief The Grue sensor console application demonstrates use of the Grue sensor. @@ -135,7 +135,7 @@ */ /*! - \example QtSensors/QtSensors_grue/import + \example sensors/grue/import \title Grue Sensor QML Import \brief The Grue sensor QML import exports the GrueSensor class as a QML type. @@ -145,7 +145,7 @@ */ /*! - \example QtSensors/QtSensors_grue + \example sensors/grue \title Grue Sensor QML Application \brief The Grue sensor QML application demonstrates use of the GrueSensor QML type. @@ -154,7 +154,7 @@ this example or it will not be able to find its dependencies. \code - qmlscene QtSensors_grue.qml + qmlscene grue.qml \endcode \sa {Qt Sensors - Grue Sensor Example} diff --git a/doc/src/examples/maze.qdoc b/doc/src/examples/maze.qdoc index edd7e65e..0a278a53 100644 --- a/doc/src/examples/maze.qdoc +++ b/doc/src/examples/maze.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \example QtSensors/QtSensors_maze + \example sensors/maze \title Qt Sensors - Maze QML Example \ingroup qtsensors-examples \image maze.png @@ -39,29 +39,29 @@ Import the QtSensors 5.x declarative plugin: - \snippet ../examples/QtSensors/QtSensors_maze/QtSensors_maze.qml 0 + \snippet ../examples/sensors/maze/maze.qml 0 Add the Sensor QML types into your qml file. In this example we use the TiltSensor with values based in degrees and an accuracy of 5 degree: - \snippet ../examples/QtSensors/QtSensors_maze/QtSensors_maze.qml 1 + \snippet ../examples/sensors/maze/maze.qml 1 Starting the sensor can be done by setting the 'enabled' property to true: - \snippet ../examples/QtSensors/QtSensors_maze/QtSensors_maze.qml 2 + \snippet ../examples/sensors/maze/maze.qml 2 The mouse should move by a factor of the tilt value: - \snippet ../examples/QtSensors/QtSensors_maze/QtSensors_maze.qml 3 + \snippet ../examples/sensors/maze/maze.qml 3 The walk direction of the mouse takes into account some collision detection: - \snippet ../examples/QtSensors/QtSensors_maze/QtSensors_maze.qml 4 + \snippet ../examples/sensors/maze/maze.qml 4 The rotation of the mouse image is determined according to the angle that the mouse is moving. - \snippet ../examples/QtSensors/QtSensors_maze/Mouse.qml 0 + \snippet ../examples/sensors/maze/Mouse.qml 0 */ diff --git a/doc/src/examples/qmlqtsensors.qdoc b/doc/src/examples/qmlqtsensors.qdoc index 1dfe3202..422f2d08 100644 --- a/doc/src/examples/qmlqtsensors.qdoc +++ b/doc/src/examples/qmlqtsensors.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \example QtSensors/QtSensors_qmlqtsensors + \example sensors/qmlqtsensors \title Qt Sensors - QML example \ingroup qtsensors-examples \image qmlqtsensors.png @@ -39,32 +39,32 @@ Import the QtSensors 5.x declarative plugin: - \snippet ../examples/QtSensors/QtSensors_qmlqtsensors/QtSensors_qmlqtsensors.qml 0 + \snippet ../examples/sensors/qmlqtsensors/qmlqtsensors.qml 0 Add the Sensor QML types into your qml file. In this example we use the TiltSensor: - \snippet ../examples/QtSensors/QtSensors_qmlqtsensors/QtSensors_qmlqtsensors.qml 1 + \snippet ../examples/sensors/qmlqtsensors/qmlqtsensors.qml 1 The Tilt-, AmbientLight- and the Proximity QML sensor types have the 'enabled' property in common. To start or stop the sensor set this property to true or false. - \snippet ../examples/QtSensors/QtSensors_qmlqtsensors/QtSensors_qmlqtsensors.qml 2 + \snippet ../examples/sensors/qmlqtsensors/qmlqtsensors.qml 2 Reading the data can be done for each sensor type like following: \l {QtSensors5::TiltSensor} {TiltSensor} - \snippet ../examples/QtSensors/QtSensors_qmlqtsensors/QtSensors_qmlqtsensors.qml 3 - \snippet ../examples/QtSensors/QtSensors_qmlqtsensors/QtSensors_qmlqtsensors.qml 4 + \snippet ../examples/sensors/qmlqtsensors/qmlqtsensors.qml 3 + \snippet ../examples/sensors/qmlqtsensors/qmlqtsensors.qml 4 \l {QtSensors5::AmbientLightSensor} {AmbientLightSensor} - \snippet ../examples/QtSensors/QtSensors_qmlqtsensors/QtSensors_qmlqtsensors.qml 5 + \snippet ../examples/sensors/qmlqtsensors/qmlqtsensors.qml 5 \l {QtSensors5::ProximitySensor} {ProximitySensor} - \snippet ../examples/QtSensors/QtSensors_qmlqtsensors/QtSensors_qmlqtsensors.qml 6 + \snippet ../examples/sensors/qmlqtsensors/qmlqtsensors.qml 6 */ diff --git a/doc/src/examples/qmlsensorgtestures.qdoc b/doc/src/examples/qmlsensorgtestures.qdoc index f655d2eb..a4f4fcd3 100644 --- a/doc/src/examples/qmlsensorgtestures.qdoc +++ b/doc/src/examples/qmlsensorgtestures.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \example QtSensors/QtSensors_qmlsensorgestures + \example sensors/qmlsensorgestures \title Qt Sensors - SensorGesture QML Type example \ingroup qtsensors-examples @@ -37,25 +37,25 @@ Import the QtSensors 5.x declarative plugin: -\snippet ../examples/QtSensors/QtSensors_qmlsensorgestures/GestureView.qml 0 +\snippet ../examples/sensors/qmlsensorgestures/GestureView.qml 0 Add the SensorGesture QML type into your qml file. -\snippet ../examples/QtSensors/QtSensors_qmlsensorgestures/GestureView.qml 1 +\snippet ../examples/sensors/qmlsensorgestures/GestureView.qml 1 Each SensorGesture QML type contains a property called gestures. In this example an alias 'gestureid' for this property is used. -\snippet ../examples/QtSensors/QtSensors_qmlsensorgestures/GestureView.qml 2 +\snippet ../examples/sensors/qmlsensorgestures/GestureView.qml 2 By using this alias property you define which gestures should be used: -\snippet ../examples/QtSensors/QtSensors_qmlsensorgestures/QtSensors_qmlsensorgestures.qml 3 +\snippet ../examples/sensors/qmlsensorgestures/qmlsensorgestures.qml 3 A list of all available gestures can be created by calling the 'availableGestures' property: -\snippet ../examples/QtSensors/QtSensors_qmlsensorgestures/GestureList.qml 4 +\snippet ../examples/sensors/qmlsensorgestures/GestureList.qml 4 \sa {Qt Sensors - ShakeIt QML Example} \sa {Qt Sensor Gestures} diff --git a/doc/src/examples/sensor_explorer.qdoc b/doc/src/examples/sensor_explorer.qdoc index 31eb4748..1869dff5 100644 --- a/doc/src/examples/sensor_explorer.qdoc +++ b/doc/src/examples/sensor_explorer.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \example QtSensors/QtSensors_sensor_explorer + \example sensors/sensor_explorer \title Qt Sensors - Explorer QML example \ingroup qtsensors-examples \image sensorexplorer.png @@ -55,31 +55,31 @@ Import the Explorer 1.0 declarative plugin: - \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 0 + \snippet ../examples/sensors/sensor_explorer/sensor_explorer.qml 0 Create a SensorExplorer QML item: - \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 1 + \snippet ../examples/sensors/sensor_explorer/sensor_explorer.qml 1 You can retrieve a list of all available sensors using the SensorExplorer: - \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 2 + \snippet ../examples/sensors/sensor_explorer/sensor_explorer.qml 2 To retrieve the properties of a SensorItem use: - \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 3 + \snippet ../examples/sensors/sensor_explorer/sensor_explorer.qml 3 Changing a property value can be done like: - \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 4 + \snippet ../examples/sensors/sensor_explorer/sensor_explorer.qml 4 Starting and stopping a sensor can be done like: - \snippet ../examples/QtSensors/QtSensors_sensor_explorer/QtSensors_sensor_explorer.qml 5 + \snippet ../examples/sensors/sensor_explorer/sensor_explorer.qml 5 */ /*! - \example QtSensors/QtSensors_sensor_explorer/import + \example sensors/sensor_explorer/import \title Sensor Explorer QML Import \section2 Sensor Explorer Declarative Plugin diff --git a/doc/src/examples/sensorgestures.qdoc b/doc/src/examples/sensorgestures.qdoc index 4940dfb5..d05cd55a 100644 --- a/doc/src/examples/sensorgestures.qdoc +++ b/doc/src/examples/sensorgestures.qdoc @@ -45,17 +45,17 @@ In order to know about custom signals that may be available, we need to ask the QSensorGestureManager about them, Using the QSensorGesture::gestureIds() function, the manager will return a QStringList of known and valid gesture Ids. - \snippet ../examples/QtSensors/QtSensors_sensorgestures/mainwindow.cpp 0 + \snippet ../examples/sensors/sensorgestures/mainwindow.cpp 0 We can then use this to create a QSensorGesture object that we can use to connect signals to, and start the detection process. A QSensorGesture object will take a list of one or more recognizer ids in it's constructor. - \snippet ../examples/QtSensors/QtSensors_sensorgestures/mainwindow.cpp 1 + \snippet ../examples/sensors/sensorgestures/mainwindow.cpp 1 and later stop the detection process. - \snippet ../examples/QtSensors/QtSensors_sensorgestures/mainwindow.cpp 2 + \snippet ../examples/sensors/sensorgestures/mainwindow.cpp 2 The QSensorGesture object will contain all the signals of the valid requested recognizers found on the system. diff --git a/doc/src/examples/shakeit.qdoc b/doc/src/examples/shakeit.qdoc index 05bb28bc..fca2d2a3 100644 --- a/doc/src/examples/shakeit.qdoc +++ b/doc/src/examples/shakeit.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \example QtSensors/QtSensors_shakeit + \example sensors/shakeit \title Qt Sensors - ShakeIt QML Example \ingroup qtsensors-examples \image shakeit.png @@ -39,25 +39,25 @@ Import the Sensors Declarative module. - \snippet ../examples/QtSensors/QtSensors_shakeit/QtSensors_shakeit.qml 0 + \snippet ../examples/sensors/shakeit/shakeit.qml 0 Add a SensorGesture QML type. - \snippet ../examples/QtSensors/QtSensors_shakeit/QtSensors_shakeit.qml 1 + \snippet ../examples/sensors/shakeit/shakeit.qml 1 In the SensorGesture type, specify which gesture to be used. Note that this can be a comma separated list. Here we are only interested in one gesture recognizer. - \snippet ../examples/QtSensors/QtSensors_shakeit/QtSensors_shakeit.qml 2 + \snippet ../examples/sensors/shakeit/shakeit.qml 2 Use the 'enabled' property to start the sensor gesture. - \snippet ../examples/QtSensors/QtSensors_shakeit/QtSensors_shakeit.qml 3 + \snippet ../examples/sensors/shakeit/shakeit.qml 3 Use the onDetected signal to do stuff. - \snippet ../examples/QtSensors/QtSensors_shakeit/QtSensors_shakeit.qml 4 + \snippet ../examples/sensors/shakeit/shakeit.qml 4 There are additional gestures to shake which are supported: whip, twistRight, hover, cover, turnover and pickup. diff --git a/doc/src/qtsensors-cpp.qdoc b/doc/src/qtsensors-cpp.qdoc index 6cdd6a4b..3df97f94 100644 --- a/doc/src/qtsensors-cpp.qdoc +++ b/doc/src/qtsensors-cpp.qdoc @@ -101,7 +101,7 @@ This code does not require any compile-time links to \l QAccelerometer or \snippet snippets/sensors/start.cpp Starting a sensor -You can discover all of this information at runtime too. The QtSensors_sensor_explorer example +You can discover all of this information at runtime too. The sensor_explorer example shows you information about available sensors. \section1 Front end, back end -- cgit v1.2.3