aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/util/qquickanimation.cpp
diff options
context:
space:
mode:
authorSze Howe Koh <szehowe.koh@gmail.com>2014-03-14 23:41:01 +0800
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-18 13:17:42 +0100
commit303db2e8a19ea1f2c1b8d5dc59e2754b0d03bd61 (patch)
tree9fed3403c91ab9b43aa30e660cbd1530439e6083 /src/quick/util/qquickanimation.cpp
parentd7ea461fde7a5d227313eda83b5af84ec9b0477b (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/util/qquickanimation.cpp')
-rw-r--r--src/quick/util/qquickanimation.cpp14
1 files changed, 9 insertions, 5 deletions
diff --git a/src/quick/util/qquickanimation.cpp b/src/quick/util/qquickanimation.cpp
index 36316e27c0..e46eb77ce2 100644
--- a/src/quick/util/qquickanimation.cpp
+++ b/src/quick/util/qquickanimation.cpp
@@ -200,19 +200,21 @@ QQmlProperty QQuickAbstractAnimationPrivate::createProperty(QObject *obj, const
}
/*!
- \qmlsignal QtQuick::Animation::onStarted()
+ \qmlsignal QtQuick::Animation::started()
- This signal handler is called when the animation begins.
+ This signal is emitted when the animation begins.
It is only triggered for top-level, standalone animations. It will not be
triggered for animations in a Behavior or Transition, or animations
that are part of an animation group.
+
+ The corresponding handler is \c onStarted.
*/
/*!
- \qmlsignal QtQuick::Animation::onStopped()
+ \qmlsignal QtQuick::Animation::stopped()
- This signal handler is called when the animation ends.
+ This signal is emitted when the animation ends.
The animation may have been stopped manually, or may have run to completion.
@@ -220,8 +222,10 @@ QQmlProperty QQuickAbstractAnimationPrivate::createProperty(QObject *obj, const
triggered for animations in a Behavior or Transition, or animations
that are part of an animation group.
- If \l alwaysRunToEnd is true, onStopped will not be called until the animation
+ If \l alwaysRunToEnd is true, this signal will not be emitted until the animation
has completed its current iteration.
+
+ The corresponding handler is \c onStopped.
*/
void QQuickAbstractAnimation::setRunning(bool r)