From 0b5d01eeec9913a0bb0d545b48d13cec8dde5354 Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@qt.io>
Date: Wed, 13 Nov 2019 09:19:05 +0100
Subject: Doc: Fix documentation warnings
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Add (basic) documentation for Qt3DAnimation::QAnimationCallback.
- Add missing namespace qualifiers for \class, \fn, \instantiates,
  \sa, and \property commands.
- Remove linking to example file pages, as QDoc no longe treats them
  as linkable targets.
- Fix function/QML method parameter documentation
- Fix missing \qmlproperty types
- Fix linking to QKeyEvent in QtGui.
- Move Qt3DRender::Quick namespace documentation to where QDoc can
  see it.
- Add enum documentation for
  Qt3DRender::QBlitFramebuffer::InterpolationMethod and
  Qt3DRender::QMesh::Status.
- Other minor fixes

This brings the current warning count to zero.

Fixes: QTBUG-79822
Change-Id: I1154a7f9c34917a3f240e99da0e7a300be7d65a0
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
---
 src/input/frontend/qactioninput.cpp                 | 2 +-
 src/input/frontend/qkeyevent.cpp                    | 6 +++---
 src/input/frontend/qmousehandler.cpp                | 6 +++---
 src/input/frontend/qphysicaldevicecreatedchange.cpp | 2 +-
 4 files changed, 8 insertions(+), 8 deletions(-)

(limited to 'src/input')

diff --git a/src/input/frontend/qactioninput.cpp b/src/input/frontend/qactioninput.cpp
index 9f32f57cc..f013147f2 100644
--- a/src/input/frontend/qactioninput.cpp
+++ b/src/input/frontend/qactioninput.cpp
@@ -181,7 +181,7 @@ QAbstractPhysicalDevice *QActionInput::sourceDevice() const
 /*!
     \qmlsignal Qt3D.Input::ActionInput::buttonsChanged(const QVector<int> &buttons)
 
-    This signal is emitted when the buttons associated with the action input is changed.
+    This signal is emitted when the \a buttons associated with the action input is changed.
 
     The corresponding handler is \c onbuttonsChanged
 */
diff --git a/src/input/frontend/qkeyevent.cpp b/src/input/frontend/qkeyevent.cpp
index a70a2970b..efbddc771 100644
--- a/src/input/frontend/qkeyevent.cpp
+++ b/src/input/frontend/qkeyevent.cpp
@@ -160,7 +160,7 @@ QKeyEvent::~QKeyEvent()
 /*!
     \qmlmethod bool Qt3D.Input::KeyEvent::matches(StandardKey key)
 
-    Returns \c true if the key event matches the given standard key; otherwise
+    Returns \c true if the key event matches the given standard \a key; otherwise
     returns \c false.
 
     \sa QKeySequence::StandardKey
@@ -174,7 +174,7 @@ QKeyEvent::~QKeyEvent()
 
     See \l [CPP] {Qt::Key}{Qt.Key} for the list of keyboard codes.
 
-    \sa {QKeyEvent::key}
+    \b {See also} \l [QtGui] {QKeyEvent::key()}.
 */
 
 /*!
@@ -194,7 +194,7 @@ QKeyEvent::~QKeyEvent()
     This property holds the keyboard modifier flags that existed immediately
     before the event occurred.
 
-    \sa {QKeyEvent::modifiers}
+    \b {See also} \l [QtGui] {QKeyEvent::modifiers()}.
 */
 
 /*!
diff --git a/src/input/frontend/qmousehandler.cpp b/src/input/frontend/qmousehandler.cpp
index 1d45d85b6..89d76a057 100644
--- a/src/input/frontend/qmousehandler.cpp
+++ b/src/input/frontend/qmousehandler.cpp
@@ -197,21 +197,21 @@ void QMouseHandlerPrivate::mouseEvent(const QMouseEventPtr &event)
     \qmlsignal Qt3D.Input::MouseHandler::wheel(MouseEvent mouse)
 
     This signal is emitted when the mouse wheel is used with the event details
-    being contained within \a wheel
+    being contained within \a mouse.
  */
 
 /*!
     \fn Qt3DInput::QMouseHandler::clicked(Qt3DInput::QMouseEvent *mouse)
 
     This signal is emitted when a mouse button is clicked with the event details
-    being contained within \a mouse
+    being contained within \a mouse.
  */
 
 /*!
     \fn Qt3DInput::QMouseHandler::doubleClicked(Qt3DInput::QMouseEvent *mouse)
 
     This signal is emitted when a mouse button is double clicked with the event
-    details being contained within \a mouse
+    details being contained within \a mouse.
  */
 
 /*!
diff --git a/src/input/frontend/qphysicaldevicecreatedchange.cpp b/src/input/frontend/qphysicaldevicecreatedchange.cpp
index c14770d80..905633b7f 100644
--- a/src/input/frontend/qphysicaldevicecreatedchange.cpp
+++ b/src/input/frontend/qphysicaldevicecreatedchange.cpp
@@ -54,7 +54,7 @@ QPhysicalDeviceCreatedChangeBasePrivate::QPhysicalDeviceCreatedChangeBasePrivate
 }
 
 /*!
-    \class QPhysicalDeviceCreatedChangeBase
+    \class Qt3DInput::QPhysicalDeviceCreatedChangeBase
     \inmodule Qt3DInput
     \brief Base class for handling changes in physical devices.
 */
-- 
cgit v1.2.3