diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-07-18 15:18:31 +0200 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2019-08-29 13:04:58 +0200 |
commit | 1dc3f4c24583e14dee3c5fa650a8ac239b953458 (patch) | |
tree | bae8b90629c3215ec254221388aad85813237b32 /src/particles/qquickparticleemitter.cpp | |
parent | da04b1d716617fbe4a2d93dc5a51f38dbd03a5b8 (diff) |
Doc: Fix documentation warnings for qtdeclarative
After recent changes to QDoc, it now correctly warns about missing
documentation for QML method parameters - fix all of these and also
do some minor language editing.
Remove duplicated entries for
- \qmlmodule Qt.labs.qmlmodels
- \group qtjavascript
as they were causing issues.
Change-Id: I55cd670cc8a0cc6427cdb7945dbd7c28ea94f796
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src/particles/qquickparticleemitter.cpp')
-rw-r--r-- | src/particles/qquickparticleemitter.cpp | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/src/particles/qquickparticleemitter.cpp b/src/particles/qquickparticleemitter.cpp index 5ec834a463..f154446484 100644 --- a/src/particles/qquickparticleemitter.cpp +++ b/src/particles/qquickparticleemitter.cpp @@ -190,10 +190,10 @@ QT_BEGIN_NAMESPACE /*! \qmlsignal QtQuick.Particles::Emitter::emitParticles(Array particles) - This signal is emitted when particles are emitted. particles is a JavaScript + This signal is emitted when particles are emitted. \a 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 + \note JavaScript is slower to execute, so it is not recommended to use this in high-volume particle systems. The corresponding handler is \c onEmitParticles. @@ -201,19 +201,20 @@ QT_BEGIN_NAMESPACE /*! \qmlmethod QtQuick.Particles::Emitter::burst(int count) - Emits count particles from this emitter immediately. + Emits a number of particles, specified by \a count, from this emitter immediately. */ /*! \qmlmethod QtQuick.Particles::Emitter::burst(int count, int x, int y) - Emits count particles from this emitter immediately. The particles are emitted - as if the Emitter was positioned at x,y but all other properties are the same. + Emits a number of particles, specified by \a count, from this emitter immediately. + The particles are emitted as if the Emitter was positioned at (\a {x}, \a {y}) but + all other properties are the same. */ /*! \qmlmethod QtQuick.Particles::Emitter::pulse(int duration) - If the emitter is not enabled, enables it for duration milliseconds and then switches - it back off. + If the emitter is not enabled, enables it for a specified \a duration + (in milliseconds) and then switches it back off. */ QQuickParticleEmitter::QQuickParticleEmitter(QQuickItem *parent) : |