From c5ee8b6f82d5a39260121433f95b28f8cf7762eb Mon Sep 17 00:00:00 2001
From: Wolfgang Beck <wolfgang.beck@nokia.com>
Date: Thu, 8 Dec 2011 12:42:35 +1000
Subject: Add MAZE tutorial

Change-Id: I076d5071aa27ba10da6885b1d856c24ca6bb4f7d
Sanity-Review: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Lincoln Ramsay <lincoln.ramsay@nokia.com>
Reviewed-by: Wolfgang Beck <wolfgang.beck@nokia.com>
---
 doc/src/examples/sensors.qdoc |  8 -------
 doc/src/maze.qdoc             | 56 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 56 insertions(+), 8 deletions(-)
 create mode 100644 doc/src/maze.qdoc

(limited to 'doc/src')

diff --git a/doc/src/examples/sensors.qdoc b/doc/src/examples/sensors.qdoc
index 98bf0e0e..e20eb35b 100644
--- a/doc/src/examples/sensors.qdoc
+++ b/doc/src/examples/sensors.qdoc
@@ -47,12 +47,4 @@
     It was designed as a debugging aid.
 */
 
-/*!
-    \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.
-*/
 
diff --git a/doc/src/maze.qdoc b/doc/src/maze.qdoc
new file mode 100644
index 00000000..51520caa
--- /dev/null
+++ b/doc/src/maze.qdoc
@@ -0,0 +1,56 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \example sensors/maze
+    \title Maze
+    \brief The Maze example demonstrates the TiltSensor QML element
+    \ingroup qtsensors-examples
+
+\section1 Overview
+    To write a QML application that will use the TiltSensor QML sensors element you need to do the following steps:
+
+    Import the QtSensors 5.x declarative plugin:
+
+\snippet ../examples/sensors/maze/Maze.qml 0
+
+    Add the Sensor QML elements into your qml file.
+
+    In this example we use the TiltSensor with values based in degrees and an accuracy of 5 degree:
+
+\snippet ../examples/sensors/maze/Maze.qml 1
+
+    Starting the sensor can be done by setting the 'enabled' property to true:
+
+\snippet ../examples/sensors/maze/Maze.qml 2
+
+    To determine the walk direction of the mouse we use the following if -else statements:
+
+\snippet ../examples/sensors/maze/Maze.qml 3
+
+*/
+
-- 
cgit v1.2.3