Doc: Fix documentation issues for event and input device classes

* Document the new base classes QPointerEvent and QSinglePointEvent,
  and move relevant documentation to be located under them.
* Replace linking to deprecated functions with their new counterparts.
* Remove non-existent function and parameter documentation.
* Document QEventPoint::State enum.
* Prefer \obsolete over \deprecated and fix the usage.
* Document the Capabilities enum in the correct location and
  add docs for the missing enum values.

Change-Id: Ic8f2732f2e90ecbf522cd744c601cedcc574825c
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>

1 files changed, 7 insertions, 32 deletions

diff --git a/src/gui/kernel/qpointingdevice.cpp b/src/gui/kernel/qpointingdevice.cpp
index 05bea8ccd7..dd0c4e8d8b 100644
--- a/src/gui/kernel/qpointingdevice.cpp
+++ b/src/gui/kernel/qpointingdevice.cpp
@@ -103,6 +103,9 @@ Q_DECLARE_LOGGING_CATEGORY(lcQpaInputDevices)
         A device that is similar to a flat mouse with a transparent circle with
         cross-hairs.
 
+    \value Keyboard
+        A keyboard.
+
     \value AllDevices
         Any of the above (used as a default filter value).
 */
@@ -133,40 +136,12 @@ Q_DECLARE_LOGGING_CATEGORY(lcQpaInputDevices)
     \value Eraser
         The other end of the stylus (if it has a virtual eraser on the other end).
     \value Cursor
-        A transparent circle with cross-hairs as found on a \l {DeviceType.Puck}{Puck} device.
+        A transparent circle with cross-hairs as found on a
+        \l {QInputDevice::DeviceType}{Puck} device.
     \value AllPointerTypes
         Any of the above (used as a default filter value).
 */
 
-/*! \enum QPointingDevice::Capability
-
-    This enum is used with QPointingDevice::capabilities() to indicate what kind of information the
-    touch device or its driver can provide.
-
-    \value Position
-        Indicates that position information is available, meaning that the
-        pos() family of functions in the touch points return valid points.
-
-    \value Area
-        Indicates that touch area information is available, meaning that the
-        rect() family of functions in the touch points return valid rectangles.
-
-    \value Pressure
-        Indicates that pressure information is available, meaning that
-        QPointerEvent::EventPoint::pressure() returns a valid value.
-
-    \value Velocity
-        Indicates that velocity information is available, meaning that
-        QPointerEvent::EventPoint::velocity() returns a valid vector.
-
-    \value NormalizedPosition
-        Indicates that the normalized position is available, meaning that
-        QPointerEvent::EventPoint::normalizedPos() returns a valid value.
-
-    \value MouseEmulation
-        Indicates that the device synthesizes mouse events.
-*/
-
 /*!
     Creates a new invalid pointing device instance.
 */
@@ -183,8 +158,8 @@ QPointingDevice::~QPointingDevice()
 
 /*!
     Creates a new pointing device instance with the given
-    \a deviceType, \a pointerType, \a capabilities, \a maxPoints,
-    \a buttonCount, \a name, \a id and \a seatId.
+    \a name, \a deviceType, \a pointerType, \a capabilities, \a maxPoints,
+    \a buttonCount, \a seatName, \a uniqueId and \a parent.
 */
 QPointingDevice::QPointingDevice(const QString &name, qint64 id, QInputDevice::DeviceType deviceType,
                                  QPointingDevice::PointerType pointerType, Capabilities capabilities, int maxPoints, int buttonCount,