diff options
author | Topi Reinio <topi.reinio@qt.io> | 2020-11-04 12:37:45 +0100 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2020-11-05 09:00:48 +0100 |
commit | 0b12055548a8781b0c328991c267d62222667e8e (patch) | |
tree | de91b0183203dd00318fed9fa5ca4cff6713142a /src/quick/handlers | |
parent | c01ad45d67ec0ce96d6944496dc292a94f17efea (diff) |
Doc: Fix documentation warnings for Qt Quick
- Remove links to modules and examples that are not part of Qt 6.
- Remove links to entities marked as \internal
- Add missing enum value and QML property docs where it's trivial
to do so.
Task-number: QTBUG-88156
Change-Id: I10a1c7bcc5fe0e2354ea69eaf24930362edb7415
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/quick/handlers')
-rw-r--r-- | src/quick/handlers/qquickhandlerpoint.cpp | 6 | ||||
-rw-r--r-- | src/quick/handlers/qquickhoverhandler.cpp | 4 | ||||
-rw-r--r-- | src/quick/handlers/qquickpointerdevicehandler.cpp | 4 | ||||
-rw-r--r-- | src/quick/handlers/qquickpointerhandler.cpp | 4 | ||||
-rw-r--r-- | src/quick/handlers/qquickwheelhandler.cpp | 15 |
5 files changed, 18 insertions, 15 deletions
diff --git a/src/quick/handlers/qquickhandlerpoint.cpp b/src/quick/handlers/qquickhandlerpoint.cpp index 58123630ac..35c3bb1b3f 100644 --- a/src/quick/handlers/qquickhandlerpoint.cpp +++ b/src/quick/handlers/qquickhandlerpoint.cpp @@ -218,7 +218,7 @@ void QQuickHandlerPoint::reset(const QVector<QQuickHandlerPoint> &points) Interpreting the contents of this ID requires knowledge of the hardware and drivers in use. - \sa QTabletEvent::uniqueId, QtQuick::TouchPoint::uniqueId, QtQuick::EventTouchPoint::uniqueId + \sa QTabletEvent::uniqueId, QtQuick::TouchPoint::uniqueId */ /*! @@ -295,7 +295,7 @@ void QQuickHandlerPoint::reset(const QVector<QQuickHandlerPoint> &points) nonzero when this point is in motion. It holds the average recent velocity: how fast and in which direction the event point has been moving recently. - \sa QtQuick::EventPoint::velocity, QtQuick::TouchPoint::velocity, QEventPoint::velocity + \sa QtQuick::TouchPoint::velocity, QEventPoint::velocity */ /*! @@ -345,7 +345,7 @@ void QQuickHandlerPoint::reset(const QVector<QQuickHandlerPoint> &points) If the contact patch is unknown, or the device is not a touchscreen, these values will be zero. - \sa QtQuick::EventTouchPoint::ellipseDiameters, QtQuick::TouchPoint::ellipseDiameters, QEventPoint::ellipseDiameters + \sa QtQuick::TouchPoint::ellipseDiameters, QEventPoint::ellipseDiameters */ QT_END_NAMESPACE diff --git a/src/quick/handlers/qquickhoverhandler.cpp b/src/quick/handlers/qquickhoverhandler.cpp index cdb9b2578c..c105bf6537 100644 --- a/src/quick/handlers/qquickhoverhandler.cpp +++ b/src/quick/handlers/qquickhoverhandler.cpp @@ -176,14 +176,14 @@ void QQuickHoverHandler::setHovered(bool hovered) \endlist The default value of this property is not set, which allows any active - handler on the same \l parentItem to determine the cursor shape. + handler on the same \e parent item to determine the cursor shape. This property can be reset to the initial condition by setting it to \c undefined. If any handler with defined \c cursorShape is \l {PointerHandler::active}{active}, that cursor will appear. Else if the HoverHandler has a defined \c cursorShape, that cursor will appear. - Otherwise, the \l {QQuickItem::cursor()}{cursor} of \l parentItem will appear. + Otherwise, the \l {QQuickItem::cursor()}{cursor} of \e parent item will appear. \note When this property has not been set, or has been set to \c undefined, if you read the value it will return \c Qt.ArrowCursor. diff --git a/src/quick/handlers/qquickpointerdevicehandler.cpp b/src/quick/handlers/qquickpointerdevicehandler.cpp index a27aec7d56..a838f46d83 100644 --- a/src/quick/handlers/qquickpointerdevicehandler.cpp +++ b/src/quick/handlers/qquickpointerdevicehandler.cpp @@ -136,7 +136,7 @@ Qt::KeyboardModifiers QQuickPointerDeviceHandler::acceptedModifiers() const The types of pointing devices that can activate this Pointer Handler. By default, this property is set to - \l{QtQuick::PointerDevice::type} {PointerDevice.AllDevices}. + \l{QInputDevice::DeviceType}{PointerDevice.AllDevices}. If you set it to an OR combination of device types, it will ignore events from non-matching devices. @@ -173,7 +173,7 @@ void QQuickPointerDeviceHandler::setAcceptedDevices(QPointingDevice::DeviceTypes that can activate this Pointer Handler. By default, this property is set to - \l {QtQuick::PointerDevice::pointerType} {PointerDevice.AllPointerTypes}. + \l {QPointingDevice::PointerType} {PointerDevice.AllPointerTypes}. If you set it to an OR combination of device types, it will ignore events from non-matching events. diff --git a/src/quick/handlers/qquickpointerhandler.cpp b/src/quick/handlers/qquickpointerhandler.cpp index a9cf294e2b..cae700b1c8 100644 --- a/src/quick/handlers/qquickpointerhandler.cpp +++ b/src/quick/handlers/qquickpointerhandler.cpp @@ -157,7 +157,7 @@ void QQuickPointerHandler::resetDragThreshold() \since 5.15 \qmlproperty Qt::CursorShape PointerHandler::cursorShape This property holds the cursor shape that will appear whenever the mouse is - hovering over the \l parentItem while \l active is \c true. + hovering over the \l parent item while \l active is \c true. The available cursor shapes are: \list @@ -186,7 +186,7 @@ void QQuickPointerHandler::resetDragThreshold() \endlist The default value is not set, which allows the \l {QQuickItem::cursor()}{cursor} - of \l parentItem to appear. This property can be reset to the same initial + of \l parent item to appear. This property can be reset to the same initial condition by setting it to undefined. \note When this property has not been set, or has been set to \c undefined, diff --git a/src/quick/handlers/qquickwheelhandler.cpp b/src/quick/handlers/qquickwheelhandler.cpp index b9c112a0d2..563bf16b49 100644 --- a/src/quick/handlers/qquickwheelhandler.cpp +++ b/src/quick/handlers/qquickwheelhandler.cpp @@ -163,10 +163,12 @@ void QQuickWheelHandler::setInvertible(bool invertible) \l {Qt::ScrollPhase}{scroll phase} information, such as events from some touchpads, the \l active property will become \c false as soon as an event with phase \l Qt::ScrollEnd is received; in that case the timeout is not - necessary. But a conventional mouse with a wheel does not provide the - \l {QQuickPointerScrollEvent::phase}{scroll phase}: the mouse cannot detect - when the user has decided to stop scrolling, so the \l active property - transitions to \c false after this much time has elapsed. + necessary. But a conventional mouse with a wheel does not provide a scroll + phase: the mouse cannot detect when the user has decided to stop + scrolling, so the \l active property transitions to \c false after this + much time has elapsed. + + \sa QWheelEvent::phase() */ qreal QQuickWheelHandler::activeTimeout() const { @@ -506,8 +508,9 @@ void QQuickWheelHandler::timerEvent(QTimerEvent *event) /*! \qmlsignal QtQuick::WheelHandler::wheel(PointerScrollEvent event) - This signal is emitted every time this handler receives a \l QWheelEvent: - that is, every time the wheel is moved or the scrolling gesture is updated. + This signal is emitted every time this handler receives an \a event + of type \l QWheelEvent: that is, every time the wheel is moved or the + scrolling gesture is updated. */ QQuickWheelHandlerPrivate::QQuickWheelHandlerPrivate() |