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