From 76d4cae393305a1a87e53b88ef80a2a1a87758b7 Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@digia.com>
Date: Wed, 9 Oct 2013 13:26:10 +0200
Subject: Doc: Clean up SensorGesture QML example

Fix warnings, fix property names and strings shown in
the UI. Also touch the documentation and correct a
typo in the qdoc file name.

Task-number: QTBUG-33877
Change-Id: Ie790708ac4d1f8d72af03b52ee361d0bf3994adc
Reviewed-by: Lorn Potter <lorn.potter@jollamobile.com>
---
 .../doc/src/qmlsensorgestures.qdoc                 | 68 ++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 examples/sensors/qmlsensorgestures/doc/src/qmlsensorgestures.qdoc

(limited to 'examples/sensors/qmlsensorgestures/doc/src/qmlsensorgestures.qdoc')

diff --git a/examples/sensors/qmlsensorgestures/doc/src/qmlsensorgestures.qdoc b/examples/sensors/qmlsensorgestures/doc/src/qmlsensorgestures.qdoc
new file mode 100644
index 00000000..6d810711
--- /dev/null
+++ b/examples/sensors/qmlsensorgestures/doc/src/qmlsensorgestures.qdoc
@@ -0,0 +1,68 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** 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.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \example qmlsensorgestures
+    \title Qt Sensors - SensorGesture QML Type example
+    \ingroup qtsensors-examples
+
+    \brief Demonstrates the use of SensorGesture QML type.
+
+    \section1 Overview
+    To write a QML application that will use the gesture plugin, following
+    steps are needed:
+
+    Import the QtSensors 5.x module:
+
+    \snippet qmlsensorgestures/GestureView.qml 0
+
+    Add the SensorGesture QML type into your qml file.
+
+    \snippet qmlsensorgestures/GestureView.qml 1
+
+    Each SensorGesture QML type contains a property called gestures. This example
+    uses an alias \c gestureId for this property.
+
+    \snippet qmlsensorgestures/GestureView.qml 2
+
+    Then, the gesture or gestures to use can be specified using the alias:
+
+    \snippet qmlsensorgestures/qmlsensorgestures.qml 3
+    \dots 12
+    \snippet qmlsensorgestures/qmlsensorgestures.qml 4
+
+    A list of all available gestures is accessible through the
+    \c availableGestures property:
+
+    \snippet qmlsensorgestures/GestureList.qml 4
+    \codeline
+    \snippet qmlsensorgestures/GestureList.qml 5
+    \dots 12
+    \snippet qmlsensorgestures/GestureList.qml 6
+
+    \sa {Qt Sensors - ShakeIt QML Example}, {Qt Sensor Gestures}
+*/
-- 
cgit v1.2.3