diff options
author | Sze Howe Koh <szehowe.koh@gmail.com> | 2014-03-14 23:41:01 +0800 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-03-18 13:17:42 +0100 |
commit | 303db2e8a19ea1f2c1b8d5dc59e2754b0d03bd61 (patch) | |
tree | 9fed3403c91ab9b43aa30e660cbd1530439e6083 /src/quick/items/qquickflickable.cpp | |
parent | d7ea461fde7a5d227313eda83b5af84ec9b0477b (diff) |
Doc: Document signals (not handlers) under \qmlsignal
Append the handler names to the end of the corresponding signal doc.
Task-number: QTBUG-35846
Change-Id: I3d627ba7ed5be94e5c402ab092b4d582536499e8
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/quick/items/qquickflickable.cpp')
-rw-r--r-- | src/quick/items/qquickflickable.cpp | 42 |
1 files changed, 27 insertions, 15 deletions
diff --git a/src/quick/items/qquickflickable.cpp b/src/quick/items/qquickflickable.cpp index 77687cf72a..7ac37c2853 100644 --- a/src/quick/items/qquickflickable.cpp +++ b/src/quick/items/qquickflickable.cpp @@ -548,19 +548,23 @@ is finished. */ /*! - \qmlsignal QtQuick::Flickable::onDragStarted() + \qmlsignal QtQuick::Flickable::dragStarted() - This handler is called when the view starts to be dragged due to user + This signal is emitted when the view starts to be dragged due to user interaction. + + The corresponding handler is \c onDragStarted. */ /*! - \qmlsignal QtQuick::Flickable::onDragEnded() + \qmlsignal QtQuick::Flickable::dragEnded() - This handler is called when the user stops dragging the view. + This signal is emitted when the user stops dragging the view. If the velocity of the drag is sufficient at the time the touch/mouse button is released then a flick will start. + + The corresponding handler is \c onDragEnded. */ /*! @@ -615,34 +619,42 @@ is finished. */ /*! - \qmlsignal QtQuick::Flickable::onMovementStarted() + \qmlsignal QtQuick::Flickable::movementStarted() - This handler is called when the view begins moving due to user + This signal is emitted when the view begins moving due to user interaction. + + The corresponding handler is \c onMovementStarted. */ /*! - \qmlsignal QtQuick::Flickable::onMovementEnded() + \qmlsignal QtQuick::Flickable::movementEnded() - This handler is called when the view stops moving due to user - interaction. If a flick was generated, this handler will - be triggered once the flick stops. If a flick was not - generated, the handler will be triggered when the + This signal is emitted when the view stops moving due to user + interaction. If a flick was generated, this signal will + be emitted once the flick stops. If a flick was not + generated, this signal will be emitted when the user stops dragging - i.e. a mouse or touch release. + + The corresponding handler is \c onMovementEnded. */ /*! - \qmlsignal QtQuick::Flickable::onFlickStarted() + \qmlsignal QtQuick::Flickable::flickStarted() - This handler is called when the view is flicked. A flick + This signal is emitted when the view is flicked. A flick starts from the point that the mouse or touch is released, while still in motion. + + The corresponding handler is \c onFlickStarted. */ /*! - \qmlsignal QtQuick::Flickable::onFlickEnded() + \qmlsignal QtQuick::Flickable::flickEnded() + + This signal is emitted when the view stops moving due to a flick. - This handler is called when the view stops moving due to a flick. + The corresponding handler is \c onFlickEnded. */ /*! |