From 045f8727e7646967dd250f28fdddb7ccb2886397 Mon Sep 17 00:00:00 2001 From: Bea Lam Date: Fri, 3 Aug 2012 15:56:48 +1000 Subject: [PATCH] Particle doc fixes Change-Id: I65e8ecdedde6d0faec8b8d61e320df73100faf2c Reviewed-by: Bea Lam --- src/particles/qquickparticlesystem.cpp | 12 ++++++------ src/particles/qquicktrailemitter.cpp | 2 +- src/quick/doc/src/concepts/effects/particles.qdoc | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/particles/qquickparticlesystem.cpp b/src/particles/qquickparticlesystem.cpp index a048da2..50079c3 100644 --- a/src/particles/qquickparticlesystem.cpp +++ b/src/particles/qquickparticlesystem.cpp @@ -157,7 +157,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlParticlesDebug, QML_PARTICLES_DEBUG) */ /*! - \qmlmethod QtQuick.Particles2::ParticleSystem::pause + \qmlmethod QtQuick.Particles2::ParticleSystem::pause() Pauses the simulation if it is running. @@ -165,7 +165,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlParticlesDebug, QML_PARTICLES_DEBUG) */ /*! - \qmlmethod QtQuick.Particles2::ParticleSystem::resume + \qmlmethod QtQuick.Particles2::ParticleSystem::resume() Resumes the simulation if it is paused. @@ -173,7 +173,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlParticlesDebug, QML_PARTICLES_DEBUG) */ /*! - \qmlmethod QtQuick.Particles2::ParticleSystem::start + \qmlmethod QtQuick.Particles2::ParticleSystem::start() Starts the simulation if it has not already running. @@ -181,7 +181,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlParticlesDebug, QML_PARTICLES_DEBUG) */ /*! - \qmlmethod QtQuick.Particles2::ParticleSystem::stop + \qmlmethod QtQuick.Particles2::ParticleSystem::stop() Stops the simulation if it is running. @@ -189,14 +189,14 @@ DEFINE_BOOL_CONFIG_OPTION(qmlParticlesDebug, QML_PARTICLES_DEBUG) */ /*! - \qmlmethod QtQuick.Particles2::ParticleSystem::restart + \qmlmethod QtQuick.Particles2::ParticleSystem::restart() Stops the simulation if it is running, and then starts it. \sa stop, restart, running */ /*! - \qmlmethod QtQuick.Particles2::ParticleSystem::reset + \qmlmethod QtQuick.Particles2::ParticleSystem::reset() Discards all currently existing particles. diff --git a/src/particles/qquicktrailemitter.cpp b/src/particles/qquicktrailemitter.cpp index 919bae6..2371a5e 100644 --- a/src/particles/qquicktrailemitter.cpp +++ b/src/particles/qquicktrailemitter.cpp @@ -119,7 +119,7 @@ QQuickTrailEmitter::QQuickTrailEmitter(QQuickItem *parent) : \qmlproperty real QtQuick.Particles2::TrailEmitter::emitRatePerParticle */ /*! - \qmlsignal QtQuick.Particles2::TrailEmitter::emitFollowParticles(Array particles, QtQuick.Particles2::Particle followed) + \qmlsignal QtQuick.Particles2::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. diff --git a/src/quick/doc/src/concepts/effects/particles.qdoc b/src/quick/doc/src/concepts/effects/particles.qdoc index c47501b..1b9cc1b 100644 --- a/src/quick/doc/src/concepts/effects/particles.qdoc +++ b/src/quick/doc/src/concepts/effects/particles.qdoc @@ -47,7 +47,7 @@ \inqmlmodule QtQuick.Particles 2.0 \title Using the Qt Quick Particle System - Documentation for all Particle System elements can be found on the \l{QML Module QtQuick.Particles 2}{QtQuick.Particles} module page. + Documentation for all Particle System elements can be found on the \l{QtQuick.Particles 2}{QtQuick.Particles} module page. Note that to use elements from the particles module, you will need to import the types with the following line: \code -- 2.7.4