From 303db2e8a19ea1f2c1b8d5dc59e2754b0d03bd61 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Fri, 14 Mar 2014 23:41:01 +0800 Subject: 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 --- src/particles/qquickcustomaffector.cpp | 6 ++++-- src/particles/qquickparticleaffector.cpp | 8 +++++--- src/particles/qquickparticleemitter.cpp | 6 ++++-- src/particles/qquicktrailemitter.cpp | 7 +++---- 4 files changed, 16 insertions(+), 11 deletions(-) (limited to 'src/particles') diff --git a/src/particles/qquickcustomaffector.cpp b/src/particles/qquickcustomaffector.cpp index 890d415e3f..192f1676fd 100644 --- a/src/particles/qquickcustomaffector.cpp +++ b/src/particles/qquickcustomaffector.cpp @@ -49,9 +49,9 @@ QT_BEGIN_NAMESPACE //TODO: Move docs (and inheritence) to real base when docs can propagate. Currently this pretends to be the base class! /*! - \qmlsignal QtQuick.Particles::Affector::onAffectParticles(Array particles, real dt) + \qmlsignal QtQuick.Particles::Affector::affectParticles(Array particles, real dt) - This handler is called when particles are selected to be affected. particles contains + This signal is emitted when particles are selected to be affected. particles contains an array of particle objects which can be directly manipulated. dt is the time since the last time it was affected. Use dt to normalize @@ -59,6 +59,8 @@ QT_BEGIN_NAMESPACE Note that JavaScript is slower to execute, so it is not recommended to use this in high-volume particle systems. + + The corresponding handler is \c onAffectParticles. */ /*! 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) diff --git a/src/particles/qquickparticleemitter.cpp b/src/particles/qquickparticleemitter.cpp index 41c64306a2..7c3df09341 100644 --- a/src/particles/qquickparticleemitter.cpp +++ b/src/particles/qquickparticleemitter.cpp @@ -189,13 +189,15 @@ QT_BEGIN_NAMESPACE */ /*! - \qmlsignal QtQuick.Particles::Emitter::onEmitParticles(Array particles) + \qmlsignal QtQuick.Particles::Emitter::emitParticles(Array particles) - This handler is called when particles are emitted. particles is a JavaScript + This signal is emitted when particles are emitted. particles is a JavaScript array of Particle objects. You can modify particle attributes directly within the handler. Note that JavaScript is slower to execute, so it is not recommended to use this in high-volume particle systems. + + The corresponding handler is \c onEmitParticles. */ /*! \qmlmethod QtQuick.Particles::Emitter::burst(int count) diff --git a/src/particles/qquicktrailemitter.cpp b/src/particles/qquicktrailemitter.cpp index cbc738fba5..e68e851d43 100644 --- a/src/particles/qquicktrailemitter.cpp +++ b/src/particles/qquicktrailemitter.cpp @@ -119,12 +119,11 @@ QQuickTrailEmitter::QQuickTrailEmitter(QQuickItem *parent) : \qmlproperty real QtQuick.Particles::TrailEmitter::emitRatePerParticle */ /*! - \qmlsignal QtQuick.Particles::TrailEmitter::onEmitFollowParticles(Array particles, Particle followed) + \qmlsignal QtQuick.Particles::TrailEmitter::emitFollowParticles(Array particles, Particle followed) - This handler is called when particles are emitted from the \a followed particle. \a particles contains an array of particle objects which can be directly manipulated. - - If you use this signal handler, emitParticles will not be emitted. + This signal is emitted when particles are emitted from the \a followed particle. \a particles contains an array of particle objects which can be directly manipulated. + The corresponding handler is \c onEmitFollowParticles. If you use this signal handler, emitParticles will not be emitted. */ bool QQuickTrailEmitter::isEmitFollowConnected() -- cgit v1.2.3