Doc: Add skeletal doc structure for the QML types of Qt3D Input module

Also marked a few private C++ classes as \internal.

Change-Id: I32a7da498c97e132f6b6e60d551cc0b7feb52b01
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

12 files changed, 185 insertions, 7 deletions

diff --git a/src/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf
index cecdf7705..c63108ce1 100644
--- a/src/doc/qt3d.qdocconf
+++ b/src/doc/qt3d.qdocconf
@@ -66,7 +66,7 @@ examples.fileextensions       += "*.fraq *.geom *.vert"
 examples.imageextensions      += "*.png"
 
 #excludedirs +=
-
+macro.TODO = ""
 imagedirs   += images \
                ../../examples/qt3d/shadow-map-qml/doc/images \
                ../../examples/qt3d/basicshapes-cpp/doc/images \
@@ -74,8 +74,7 @@ imagedirs   += images \
                ../../examples/qt3d/wireframe/doc/images \
                ../../examples/qt3d/audio-visualizer-qml/doc/images
 
-Cpp.ignoretokens     += QT3DCORE_PRIVATE_EXPORT \
-                        QT3DINPUTSHARED_EXPORT \
+Cpp.ignoretokens     += QT3DINPUTSHARED_EXPORT \
                         QT3DCORESHARED_EXPORT \
                         QT3DLOGIC_PRIVATE_EXPORT \
                         QT3DLOGICSHARED_EXPORT \
diff --git a/src/input/frontend/qabstractphysicaldevice.cpp b/src/input/frontend/qabstractphysicaldevice.cpp
index 61236e215..4dab89bdf 100644
--- a/src/input/frontend/qabstractphysicaldevice.cpp
+++ b/src/input/frontend/qabstractphysicaldevice.cpp
@@ -42,11 +42,28 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DInput {
 
+/*! \internal */
 QAbstractPhysicalDevicePrivate::QAbstractPhysicalDevicePrivate()
     : m_axisSettings()
 {
 }
 
+/*!
+ * \qmltype AbstractPhysicalDevice
+ * \instantiates Qt3DInput::QAbstractPhysicalDevice
+ * \inqmlmodule Qt3D.Input
+ * \since 5.6
+ * \TODO
+ *
+ */
+
+/*!
+ * \class Qt3DInput::QAbstractPhysicalDevice
+ * \inmodule Qt3DInput
+ * \since 5.6
+ * \TODO
+ *
+ */
 QAbstractPhysicalDevice::QAbstractPhysicalDevice(Qt3DCore::QNode *parent)
     : Qt3DCore::QNode(*new QAbstractPhysicalDevicePrivate, parent)
 {
diff --git a/src/input/frontend/qaction.cpp b/src/input/frontend/qaction.cpp
index e41917542..6c46e9c62 100644
--- a/src/input/frontend/qaction.cpp
+++ b/src/input/frontend/qaction.cpp
@@ -54,6 +54,22 @@ public:
     QVector<QActionInput *> m_inputs;
 };
 
+/*!
+ * \qmltype Action
+ * \inqmlmodule Qt3D.Input
+ * \since 5.6
+ * \TODO
+ *
+ */
+
+/*!
+ * \class Qt3DInput::QAction
+ * \inmodule Qt3DInput
+ * \since 5.6
+ * \TODO
+ *
+ */
+
 QAction::QAction(Qt3DCore::QNode *parent)
     : Qt3DCore::QNode(*new QActionPrivate(), parent)
 {
diff --git a/src/input/frontend/qactioninput.cpp b/src/input/frontend/qactioninput.cpp
index 252e858a4..fddc22680 100644
--- a/src/input/frontend/qactioninput.cpp
+++ b/src/input/frontend/qactioninput.cpp
@@ -53,6 +53,23 @@ public:
     QAbstractPhysicalDevice *m_sourceDevice;
 };
 
+/*!
+ * \qmltype ActionInput
+ * \instantiates Qt3DInput::QActionInput
+ * \inqmlmodule Qt3D.Input
+ * \since 5.5
+ * \TODO
+ *
+ */
+
+/*!
+ * \class Qt3DInput::QActionInput
+ * \inmodule Qt3DInput
+ * \since 5.5
+ * \TODO
+ *
+ */
+
 QActionInput::QActionInput(Qt3DCore::QNode *parent)
     : Qt3DCore::QNode(*new QActionInputPrivate(), parent)
 {
diff --git a/src/input/frontend/qaxis.cpp b/src/input/frontend/qaxis.cpp
index c2eb4e32b..d7587d51b 100644
--- a/src/input/frontend/qaxis.cpp
+++ b/src/input/frontend/qaxis.cpp
@@ -53,6 +53,22 @@ public:
     QVector<QAxisInput *> m_inputs;
 };
 
+/*!
+ * \qmltype Axis
+ * \inqmlmodule Qt3D.Input
+ * \since 5.5
+ * \TODO
+ *
+ */
+
+/*!
+ * \class Qt3DInput::QAxis
+ * \inmodule Qt3DInput
+ * \since 5.5
+ * \TODO
+ *
+ */
+
 QAxis::QAxis(Qt3DCore::QNode *parent)
     : Qt3DCore::QNode(*new QAxisPrivate(), parent)
 {
diff --git a/src/input/frontend/qaxisactionhandler.cpp b/src/input/frontend/qaxisactionhandler.cpp
index d69400e5b..d6999c607 100644
--- a/src/input/frontend/qaxisactionhandler.cpp
+++ b/src/input/frontend/qaxisactionhandler.cpp
@@ -45,12 +45,30 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DInput {
 
+/*! \internal */
 QAxisActionHandlerPrivate::QAxisActionHandlerPrivate()
     : Qt3DCore::QComponentPrivate()
     , m_logicalDevice(Q_NULLPTR)
 {
 }
 
+/*!
+ * \qmltype AxisActionHandler
+ * \instantiates Qt3DInput::QAxisActionHandler
+ * \inqmlmodule Qt3D.Input
+ * \since 5.5
+ * \TODO
+ *
+ */
+
+/*!
+ * \class Qt3DInput::QAxisActionHandler
+ * \inmodule Qt3DInput
+ * \since 5.5
+ * \TODO
+ *
+ */
+
 QAxisActionHandler::QAxisActionHandler(Qt3DCore::QNode *parent)
     : Qt3DCore::QComponent(*new QAxisActionHandlerPrivate, parent)
 {
diff --git a/src/input/frontend/qaxisinput.cpp b/src/input/frontend/qaxisinput.cpp
index efad7d095..e236ab5fb 100644
--- a/src/input/frontend/qaxisinput.cpp
+++ b/src/input/frontend/qaxisinput.cpp
@@ -58,7 +58,22 @@ public:
     int m_axis;
 };
 
-
+/*!
+ * \qmltype AxisInput
+ * \instantiates Qt3DInput::QAxisInput
+ * \inqmlmodule Qt3D.Input
+ * \since 5.5
+ * \TODO
+ *
+ */
+
+/*!
+ * \class Qt3DInput::QAxisInput
+ * \inmodule Qt3DInput
+ * \since 5.5
+ * \TODO
+ *
+ */
 QAxisInput::QAxisInput(Qt3DCore::QNode *parent)
     : QNode(*new QAxisInputPrivate(), parent)
 {
diff --git a/src/input/frontend/qaxissetting.cpp b/src/input/frontend/qaxissetting.cpp
index 5590200a3..91d049839 100644
--- a/src/input/frontend/qaxissetting.cpp
+++ b/src/input/frontend/qaxissetting.cpp
@@ -56,6 +56,24 @@ public:
     bool m_filter;
 };
 
+/*!
+ * \qmltype AxisSetting
+ * \instantiates Qt3DInput::QAxisSetting
+ * \inqmlmodule Qt3D.Input
+ * \since 5.5
+ * \TODO
+ *
+ */
+
+/*!
+ * \class Qt3DInput::QAxisSetting
+ * \inmodule Qt3DInput
+ * \since 5.5
+ * \TODO
+ *
+ */
+
+
 QAxisSetting::QAxisSetting(Qt3DCore::QNode *parent)
     : QNode(*new QAxisSettingPrivate(), parent)
 {
diff --git a/src/input/frontend/qlogicaldevice.cpp b/src/input/frontend/qlogicaldevice.cpp
index a22502488..5d92e27f3 100644
--- a/src/input/frontend/qlogicaldevice.cpp
+++ b/src/input/frontend/qlogicaldevice.cpp
@@ -55,6 +55,22 @@ public:
     QVector<QAxis *> m_axes;
 };
 
+/*!
+ * \qmltype LogicalDevice
+ * \inqmlmodule Qt3D.Input
+ * \since 5.5
+ * \TODO
+ *
+ */
+
+/*!
+ * \class Qt3DInput::QLogicalDevice
+ * \inmodule Qt3DInput
+ * \since 5.5
+ * \TODO
+ *
+ */
+
 QLogicalDevice::QLogicalDevice(Qt3DCore::QNode *parent)
     : Qt3DCore::QNode(*new QLogicalDevicePrivate(), parent)
 {
diff --git a/src/input/frontend/qmousecontroller.cpp b/src/input/frontend/qmousecontroller.cpp
index 30b200629..e22719455 100644
--- a/src/input/frontend/qmousecontroller.cpp
+++ b/src/input/frontend/qmousecontroller.cpp
@@ -43,12 +43,21 @@
 QT_BEGIN_NAMESPACE
 
 namespace Qt3DInput {
-
+/*! \internal */
 QMouseControllerPrivate::QMouseControllerPrivate()
     : QAbstractPhysicalDevicePrivate()
     , m_sensitivity(0.1f)
 {
 }
+/*!
+ * \qmltype MouseController
+ * \intantiates Qt3DInput::QMouseController
+ * \inqmlmodule Qt3D.Input
+ * \since 5.5
+ * \brief Delegates mouse events to the attached MouseInput objects.
+ * \TODO
+ * \sa MouseInput
+ */
 
 /*!
  * \class Qt3DInput::QMouseController
diff --git a/src/input/frontend/qmouseevent.cpp b/src/input/frontend/qmouseevent.cpp
index d94925f94..6b62ea908 100644
--- a/src/input/frontend/qmouseevent.cpp
+++ b/src/input/frontend/qmouseevent.cpp
@@ -48,6 +48,20 @@ namespace Qt3DInput {
 // These can always be added in follow up commits once the input API takes shape
 
 /*!
+ * \qmltype MouseEvent
+ * \instantiates Qt3DInput::QMouseEvent
+ * \inqmlmodule Qt3D.Input
+ * \since 5.5
+ * \brief Provides parameters that describe a mouse event.
+ *
+ * Mouse events occur when a mouse button is pressed and the ray
+ * traversing the view, originating from the mouse position intersects with one
+ * or more elements of the scene.
+ *
+ * \sa KeyEvent, WheelEvent, MouseInput
+ */
+
+/*!
  * \class Qt3DInput::QMouseEvent
  * \inmodule Qt3DInput
  *
@@ -158,6 +172,18 @@ QMouseEvent::Modifiers QMouseEvent::modifier() const
     }
 }
 
+/*!
+ * \qmltype WheelEvent
+ * \instantiates Qt3DInput::QWheelEvent
+ * \inqmlmodule Qt3D.Input
+ * \since 5.5
+ * \brief Contains parameters that describe a mouse wheel event.
+ *
+ * Mouse wheel events occur when the mouse wheel is rotated.
+ *
+ * \sa KeyEvent, MouseEvent, MouseInput
+ *
+ */
 
 /*!
  * \class Qt3DInput::QWheelEvent
diff --git a/src/input/frontend/qmouseinput.cpp b/src/input/frontend/qmouseinput.cpp
index d200a3b22..07fd9b52d 100644
--- a/src/input/frontend/qmouseinput.cpp
+++ b/src/input/frontend/qmouseinput.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
 using namespace Qt3DCore;
 
 namespace Qt3DInput {
-
+/*! \internal */
 QMouseInputPrivate::QMouseInputPrivate()
     : QComponentPrivate()
     , m_controller(Q_NULLPTR)
@@ -55,10 +55,21 @@ QMouseInputPrivate::QMouseInputPrivate()
 }
 
 /*!
+ * \qmltype MouseInput
+ * \instantiates Qt3DInput::QMouseInput
+ * \inqmlmodule Qt3D.Input
+ * \since 5.5
+ * \brief Provides mouse event notification
+ *
+ * \TODO
+ * \sa MouseController
+ */
+
+/*!
  * \class Qt3DInput::QMouseInput
  * \inmodule Qt3DInput
  *
- * \brief Provides a mean of being notified about mouse events when attached to
+ * \brief Provides a means of being notified about mouse events when attached to
  * a QMouseController instance.
  *
  * \since 5.5