diff options
| author | Bea Lam <bea.lam@nokia.com> | 2012-08-06 14:25:24 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-08 04:11:17 +0200 |
| commit | b2120f68683b7948891d72fe077f44ab7e6baf18 (patch) | |
| tree | ede9def668f55f2f32448700da5e6fdf80b3cad6 /src/particles/qquickparticleaffector.cpp | |
| parent | ec519529087cc3005d55242569dcbca3dcee91bf (diff) | |
Fix uses of various qml doc commands
Signals documented with \qmlsignal should indicate handler name,
i.e. 'onSignal' rather than 'signal'.
Methods documented with \qmlmethod do not need to document 'void'
return values.
Also the name of any documented attribute should be qualified
with 'QtQuick2::<qmltype>'.
Change-Id: I206dd9e8f39c3b84e029ae9d4101b05d0bfb3478
Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
Diffstat (limited to 'src/particles/qquickparticleaffector.cpp')
| -rw-r--r-- | src/particles/qquickparticleaffector.cpp | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/particles/qquickparticleaffector.cpp b/src/particles/qquickparticleaffector.cpp index 29f88fb5f8..94c2573bfa 100644 --- a/src/particles/qquickparticleaffector.cpp +++ b/src/particles/qquickparticleaffector.cpp @@ -115,15 +115,15 @@ QT_BEGIN_NAMESPACE non-rectangular area. */ /*! - \qmlsignal QtQuick.Particles2::Affector::affected(real x, real y) + \qmlsignal QtQuick.Particles2::Affector::onAffected(real x, real y) This handler is called when a particle is selected to be affected. It will not be called 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 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 \l {QtQuick.Particles2::Affector::affectParticles} - {affectParticles} signal handler if you want to execute code which affects the particles + execute arbitrary code in response to particles (use the Affector::onAffectParticles + signal handler if you want to execute code which affects the particles themselves). As this executes JavaScript code per particle, it is not recommended to use this signal with a high-volume particle system. |