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/particles/qquickparticleemitter.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/particles/qquickparticleemitter.cpp')
| -rw-r--r-- | src/particles/qquickparticleemitter.cpp | 6 |
1 files changed, 4 insertions, 2 deletions
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) |