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/qquickpincharea.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/qquickpincharea.cpp')
| -rw-r--r-- | src/quick/items/qquickpincharea.cpp | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/src/quick/items/qquickpincharea.cpp b/src/quick/items/qquickpincharea.cpp index 98661d8f00..e58dfad5c1 100644 --- a/src/quick/items/qquickpincharea.cpp +++ b/src/quick/items/qquickpincharea.cpp @@ -190,33 +190,39 @@ QQuickPinchAreaPrivate::~QQuickPinchAreaPrivate() */ /*! - \qmlsignal QtQuick::PinchArea::onPinchStarted() + \qmlsignal QtQuick::PinchArea::pinchStarted() - This handler is called when the pinch area detects that a pinch gesture has started. + This signal is emitted when the pinch area detects that a pinch gesture has started. The \l {PinchEvent}{pinch} parameter provides information about the pinch gesture, including the scale, center and angle of the pinch. To ignore this gesture set the \c pinch.accepted property to false. The gesture will be canceled and no further events will be sent. + + The corresponding handler is \c onPinchStarted. */ /*! - \qmlsignal QtQuick::PinchArea::onPinchUpdated() + \qmlsignal QtQuick::PinchArea::pinchUpdated() - This handler is called when the pinch area detects that a pinch gesture has changed. + This signal is emitted when the pinch area detects that a pinch gesture has changed. The \l {PinchEvent}{pinch} parameter provides information about the pinch gesture, including the scale, center and angle of the pinch. + + The corresponding handler is \c onPinchUpdated. */ /*! - \qmlsignal QtQuick::PinchArea::onPinchFinished() + \qmlsignal QtQuick::PinchArea::pinchFinished() - This handler is called when the pinch area detects that a pinch gesture has finished. + This signal is emitted when the pinch area detects that a pinch gesture has finished. The \l {PinchEvent}{pinch} parameter provides information about the pinch gesture, including the scale, center and angle of the pinch. + + The corresponding handler is \c onPinchFinished. */ |