aboutsummaryrefslogtreecommitdiffstats
path: root/src/particles/qquickparticleaffector.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/particles/qquickparticleaffector.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/particles/qquickparticleaffector.cpp')
-rw-r--r--src/particles/qquickparticleaffector.cpp8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/particles/qquickparticleaffector.cpp b/src/particles/qquickparticleaffector.cpp
index 7c72c27b74..261894402b 100644
--- a/src/particles/qquickparticleaffector.cpp
+++ b/src/particles/qquickparticleaffector.cpp
@@ -115,12 +115,12 @@ QT_BEGIN_NAMESPACE
non-rectangular area.
*/
/*!
- \qmlsignal QtQuick.Particles::Affector::onAffected(real x, real y)
+ \qmlsignal QtQuick.Particles::Affector::affected(real x, real y)
- This handler is called when a particle is selected to be affected. It will not be called
+ This signal is emitted when a particle is selected to be affected. It will not be emitted
if a particle is considered by the Affector but not actually altered in any way.
- In the special case where an Affector has no possible effect (e.g. Affector {}), affected
+ In the special case where an Affector has no possible effect (e.g. Affector {}), this signal
will be emitted for all particles being considered if you connect to it. This allows you to
execute arbitrary code in response to particles (use the Affector::onAffectParticles
signal handler if you want to execute code which affects the particles
@@ -128,6 +128,8 @@ QT_BEGIN_NAMESPACE
signal with a high-volume particle system.
x,y is the particle's current position.
+
+ The corresponding handler is \c onAffected.
*/
QQuickParticleAffector::QQuickParticleAffector(QQuickItem *parent) :
QQuickItem(parent), m_needsReset(false), m_ignoresTime(false), m_onceOff(false), m_enabled(true)