From 0dc1fb59a1f8716dd51e046d5b375468a51f907c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Antti=20M=C3=A4=C3=A4tt=C3=A4?= <antti.maatta@qt.io>
Date: Mon, 5 Sep 2016 10:48:55 +0300
Subject: Update QMouseDevice docs

Change-Id: I6739fb95ed549fa02e9308d89e695f028fec4ed7
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
---
 src/input/frontend/qmousedevice.cpp | 63 +++++++++++++++++++++++--------------
 1 file changed, 40 insertions(+), 23 deletions(-)

(limited to 'src/input/frontend/qmousedevice.cpp')

diff --git a/src/input/frontend/qmousedevice.cpp b/src/input/frontend/qmousedevice.cpp
index d0ae0317d..bbf42b793 100644
--- a/src/input/frontend/qmousedevice.cpp
+++ b/src/input/frontend/qmousedevice.cpp
@@ -45,35 +45,43 @@
 QT_BEGIN_NAMESPACE
 
 namespace Qt3DInput {
+
 /*! \internal */
 QMouseDevicePrivate::QMouseDevicePrivate()
     : QAbstractPhysicalDevicePrivate()
     , m_sensitivity(0.1f)
 {
 }
-/*!
- * \qmltype MouseDevice
- * \instantiates Qt3DInput::QMouseDevice
- * \inqmlmodule Qt3D.Input
- * \since 5.5
- * \brief Delegates mouse events to the attached MouseHandler objects.
- * \TODO
- * \sa MouseHandler
- */
 
 /*!
- * \class Qt3DInput::QMouseDevice
- * \inmodule Qt3DInput
- *
- * \brief QMouseDevice is in charge of dispatching mouse events to
- * attached QMouseHandler objects.
- *
- * \since 5.5
- * \sa QMouseHandler
+    \qmltype MouseDevice
+    \instantiates Qt3DInput::QMouseDevice
+    \inqmlmodule Qt3D.Input
+    \since 5.5
+    \brief Delegates mouse events to the attached MouseHandler objects.
+
+    A MouseDevice delegates mouse events from physical mouse device to
+    MouseHandler objects. The sensitivity of the mouse can be controlled
+    with the \l MouseDevice::sensitivity property, which specifies the rate
+    in which the logical mouse coordinates change in response to physical
+    movement of the mouse.
+
+    \sa MouseHandler
  */
 
 /*!
-    \qmlproperty real MouseDevice::sensitivity
+    \class Qt3DInput::QMouseDevice
+    \inmodule Qt3DInput
+    \since 5.5
+    \brief Delegates mouse events to the attached MouseHandler objects.
+
+    A QMouseDevice delegates mouse events from physical mouse device to
+    QMouseHandler objects.  The sensitivity of the mouse can be controlled
+    with the \l QMouseDevice::sensitivity property, which specifies the rate
+    in which the logical mouse coordinates change in response to physical
+    movement of the mouse.
+
+    \sa QMouseHandler
  */
 
 /*!
@@ -87,6 +95,20 @@ QMouseDevicePrivate::QMouseDevicePrivate()
     \sa Qt3DInput::QAnalogAxisInput::setAxis
  */
 
+/*!
+    \qmlproperty real MouseDevice::sensitivity
+
+    Holds the current sensitivity of the mouse device.
+    Default is 0.1.
+ */
+
+/*!
+    \property Qt3DInput::QMouseDevice::sensitivity
+
+    Holds the sensitivity of the mouse device.
+    Default is 0.1.
+ */
+
 /*!
     Constructs a new QMouseDevice instance with parent \a parent.
  */
@@ -158,11 +180,6 @@ int QMouseDevice::axisIdentifier(const QString &name) const
     return -1;
 }
 
-/*!
-  \property Qt3DInput::QMouseDevice::sensitivity
-
-  The sensitivity of the device.
- */
 float QMouseDevice::sensitivity() const
 {
     Q_D(const QMouseDevice);
-- 
cgit v1.2.3