From c40d48102f853788f079c036beb7eb7113472a01 Mon Sep 17 00:00:00 2001
From: Miikka Heikkinen <miikka.heikkinen@qt.io>
Date: Mon, 5 Sep 2016 12:20:54 +0300
Subject: Improve QInputSettings docs

Change-Id: I583cca3c0af117b97465f84190663908877d51b0
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
---
 src/input/frontend/qinputsettings.cpp | 56 ++++++++++++++---------------------
 1 file changed, 22 insertions(+), 34 deletions(-)

(limited to 'src/input/frontend')

diff --git a/src/input/frontend/qinputsettings.cpp b/src/input/frontend/qinputsettings.cpp
index 08e3ce300..34ed3b438 100644
--- a/src/input/frontend/qinputsettings.cpp
+++ b/src/input/frontend/qinputsettings.cpp
@@ -48,10 +48,15 @@ namespace Qt3DInput {
 /*!
     \class Qt3DInput::QInputSettings
     \inmodule Qt3DInput
-    \inherits Qt3DCore::QComponant
-    \brief QInputSettings stores settings for the specified eventSource.
-
+    \inherits Qt3DCore::QComponent
+    \brief QInputSettings class holds the pointer to an input event source object.
     \since 5.7
+
+    The QInputSettings component must be set as a component of the scene root entity.
+    It stores a pointer to the object that acts as the source of input events to be handled
+    by various input classes. For example, a QWindow instance can be an event source.
+
+    \sa QMouseDevice, QKeyboardDevice
 */
 
 /*!
@@ -59,10 +64,14 @@ namespace Qt3DInput {
     \inqmlmodule Qt3D.Input
     \inherits Component3D
     \instantiates Qt3DInput::QInputSettings
-    \brief QML frontend for the Qt3DInput::QInputSettings C++ class.
-
-    Stores settings the specified eventSource
+    \brief InputSettings holds the pointer to an input event source object.
     \since 5.7
+
+    The InputSettings component must be set as a component of the scene root entity.
+    It stores a pointer to the object that acts as the source of input events to be handled
+    by various input classes. For example, a Window instance can be an event source.
+
+    \sa MouseDevice, KeyboardDevice
 */
 
 QInputSettingsPrivate::QInputSettingsPrivate()
@@ -71,15 +80,11 @@ QInputSettingsPrivate::QInputSettingsPrivate()
 {
 }
 
-/*!
-    Constructs a new QInputSettings instance with \a parent.
- */
 QInputSettings::QInputSettings(Qt3DCore::QNode *parent)
     : Qt3DCore::QComponent(*new QInputSettingsPrivate(), parent)
 {
 }
 
-/*! \internal */
 QInputSettings::~QInputSettings()
 {
 }
@@ -87,41 +92,24 @@ QInputSettings::~QInputSettings()
 /*!
     \property QInputSettings::eventSource
 
-    Holds the source for the QInputSettings.
+    Holds the current event source. An event source is an object that is capable
+    of receiving various input events, such as mouse or keyboard events.
+    Typically it is a QWindow instance.
  */
-/*!
-  \fn QInputSettings::eventSourceChanged(QObject *)
-
-  This signal is emitted when the even source associated with the input setting is changed.
-*/
 
 /*!
-  \qmlproperty QObject Qt3D.Input::InputSettings::eventSource
+    \qmlproperty Object InputSettings::eventSource
 
-  The current event source of the InputSettings object
+    Holds the current event source. An event source is an object that is capable
+    of receiving various input events, such as mouse or keyboard events.
+    Typically it is a Window instance.
 */
-
-/*!
-    \qmlsignal Qt3D.Input::InputSettings::ventSourceChanged(QObject *)
-
-    This signal is emitted when the even source associated with the input setting is changed.
-
-    The corresponding handler is \c onEventSourceChanged
-*/
-
-/*!
- * \brief QInputSettings::eventSource
- * \return the current event source of the QInputSettings instance.
- */
 QObject *QInputSettings::eventSource() const
 {
     Q_D(const QInputSettings);
     return d->m_eventSource;
 }
 
-/*!
-   Set the current event source of the QInputSettings instance to \a eventSource.
- */
 void QInputSettings::setEventSource(QObject *eventSource)
 {
     Q_D(QInputSettings);
-- 
cgit v1.2.3