aboutsummaryrefslogtreecommitdiffstats
path: root/src/particles
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@nokia.com>2012-07-27 17:18:12 +0200
committerQt by Nokia <qt-info@nokia.com>2012-07-30 11:11:56 +0200
commit2d3584ff21b8ddd8186972d52ecf189d0963febc (patch)
tree689f7770a5d49b9a39a3ef9ac03aa67bdb37f52b /src/particles
parente7b90ea3107996fb4a1b410631e0650d2d704912 (diff)
Doc: Changed \qmlclass to \qmltype and added \instantiates.
-To simplify QDoc, \qmlclass is now \qmltype. -'\instantiates <C+++ class>' is for the types that are defined in C++. Change-Id: I29242d33daf7b972d8b86a356b9689638866b950 Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Bea Lam <bea.lam@nokia.com> Reviewed-by: Martin Smith <martin.smith@nokia.com>
Diffstat (limited to 'src/particles')
-rw-r--r--src/particles/qquickage.cpp3
-rw-r--r--src/particles/qquickangledirection.cpp3
-rw-r--r--src/particles/qquickcumulativedirection.cpp3
-rw-r--r--src/particles/qquickcustomparticle.cpp3
-rw-r--r--src/particles/qquickdirection.cpp3
-rw-r--r--src/particles/qquickellipseextruder.cpp3
-rw-r--r--src/particles/qquickfriction.cpp3
-rw-r--r--src/particles/qquickgravity.cpp3
-rw-r--r--src/particles/qquickgroupgoal.cpp3
-rw-r--r--src/particles/qquickimageparticle.cpp3
-rw-r--r--src/particles/qquickitemparticle.cpp3
-rw-r--r--src/particles/qquicklineextruder.cpp3
-rw-r--r--src/particles/qquickmaskextruder.cpp3
-rw-r--r--src/particles/qquickparticleaffector.cpp3
-rw-r--r--src/particles/qquickparticleemitter.cpp3
-rw-r--r--src/particles/qquickparticleextruder.cpp3
-rw-r--r--src/particles/qquickparticlegroup.cpp3
-rw-r--r--src/particles/qquickparticlepainter.cpp3
-rw-r--r--src/particles/qquickparticlesystem.cpp3
-rw-r--r--src/particles/qquickpointattractor.cpp3
-rw-r--r--src/particles/qquickpointdirection.cpp3
-rw-r--r--src/particles/qquickrectangleextruder.cpp3
-rw-r--r--src/particles/qquickspritegoal.cpp3
-rw-r--r--src/particles/qquicktargetdirection.cpp3
-rw-r--r--src/particles/qquicktrailemitter.cpp3
-rw-r--r--src/particles/qquickturbulence.cpp3
-rw-r--r--src/particles/qquickv8particledata.cpp2
-rw-r--r--src/particles/qquickwander.cpp3
28 files changed, 55 insertions, 28 deletions
diff --git a/src/particles/qquickage.cpp b/src/particles/qquickage.cpp
index daccec9418..68719dd0b6 100644
--- a/src/particles/qquickage.cpp
+++ b/src/particles/qquickage.cpp
@@ -43,7 +43,8 @@
#include "qquickparticleemitter_p.h"
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Age QQuickAgeAffector
+ \qmltype Age
+ \instantiates QQuickAgeAffector
\inqmlmodule QtQuick.Particles 2
\inherits Affector
\brief For altering particle ages
diff --git a/src/particles/qquickangledirection.cpp b/src/particles/qquickangledirection.cpp
index 90631092ae..e4ce0c4fcf 100644
--- a/src/particles/qquickangledirection.cpp
+++ b/src/particles/qquickangledirection.cpp
@@ -48,7 +48,8 @@
QT_BEGIN_NAMESPACE
const qreal CONV = 0.017453292519943295;
/*!
- \qmlclass AngleDirection QQuickAngleDirection
+ \qmltype AngleDirection
+ \instantiates QQuickAngleDirection
\inqmlmodule QtQuick.Particles 2
\ingroup qtquick-particles
\inherits Direction
diff --git a/src/particles/qquickcumulativedirection.cpp b/src/particles/qquickcumulativedirection.cpp
index 705da0103f..72ca7ef5ca 100644
--- a/src/particles/qquickcumulativedirection.cpp
+++ b/src/particles/qquickcumulativedirection.cpp
@@ -43,7 +43,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass CumulativeDirection QQuickCumulativeDirection
+ \qmltype CumulativeDirection
+ \instantiates QQuickCumulativeDirection
\inqmlmodule QtQuick.Particles 2
\inherits Direction
\brief For specifying a direction made of other directions
diff --git a/src/particles/qquickcustomparticle.cpp b/src/particles/qquickcustomparticle.cpp
index 31b95c41fe..272864e3b4 100644
--- a/src/particles/qquickcustomparticle.cpp
+++ b/src/particles/qquickcustomparticle.cpp
@@ -121,7 +121,8 @@ struct PlainVertices {
};
/*!
- \qmlclass CustomParticle QQuickCustomParticle
+ \qmltype CustomParticle
+ \instantiates QQuickCustomParticle
\inqmlmodule QtQuick.Particles 2
\inherits ParticlePainter
\brief For specifying shaders to paint particles
diff --git a/src/particles/qquickdirection.cpp b/src/particles/qquickdirection.cpp
index f5d05ee9bc..44155efe04 100644
--- a/src/particles/qquickdirection.cpp
+++ b/src/particles/qquickdirection.cpp
@@ -43,7 +43,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Direction QQuickDirection
+ \qmltype Direction
+ \instantiates QQuickDirection
\inqmlmodule QtQuick.Particles 2
\brief For specifying a vector space
\ingroup qtquick-particles
diff --git a/src/particles/qquickellipseextruder.cpp b/src/particles/qquickellipseextruder.cpp
index 5c11dfb82b..3a3e1f5f25 100644
--- a/src/particles/qquickellipseextruder.cpp
+++ b/src/particles/qquickellipseextruder.cpp
@@ -49,7 +49,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass EllipseShape QQuickEllipseExtruder
+ \qmltype EllipseShape
+ \instantiates QQuickEllipseExtruder
\inqmlmodule QtQuick.Particles 2
\ingroup qtquick-particles
\inherits Shape
diff --git a/src/particles/qquickfriction.cpp b/src/particles/qquickfriction.cpp
index 6a54ea7cc7..3b31b0bdb9 100644
--- a/src/particles/qquickfriction.cpp
+++ b/src/particles/qquickfriction.cpp
@@ -42,7 +42,8 @@
#include "qquickfriction_p.h"
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Friction QQuickFrictionAffector
+ \qmltype Friction
+ \instantiates QQuickFrictionAffector
\inqmlmodule QtQuick.Particles 2
\ingroup qtquick-particles
\inherits Affector
diff --git a/src/particles/qquickgravity.cpp b/src/particles/qquickgravity.cpp
index 4e3cc52498..f11681e53f 100644
--- a/src/particles/qquickgravity.cpp
+++ b/src/particles/qquickgravity.cpp
@@ -44,7 +44,8 @@
QT_BEGIN_NAMESPACE
const qreal CONV = 0.017453292520444443;
/*!
- \qmlclass Gravity QQuickGravityAffector
+ \qmltype Gravity
+ \instantiates QQuickGravityAffector
\inqmlmodule QtQuick.Particles 2
\ingroup qtquick-particles
\inherits Affector
diff --git a/src/particles/qquickgroupgoal.cpp b/src/particles/qquickgroupgoal.cpp
index 96f9e1bc57..5b8e43339a 100644
--- a/src/particles/qquickgroupgoal.cpp
+++ b/src/particles/qquickgroupgoal.cpp
@@ -48,7 +48,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass GroupGoal QQuickGroupGoalAffector
+ \qmltype GroupGoal
+ \instantiates QQuickGroupGoalAffector
\inqmlmodule QtQuick.Particles 2
\ingroup qtquick-particles
\inherits Affector
diff --git a/src/particles/qquickimageparticle.cpp b/src/particles/qquickimageparticle.cpp
index 5803c4b703..b55589e3eb 100644
--- a/src/particles/qquickimageparticle.cpp
+++ b/src/particles/qquickimageparticle.cpp
@@ -584,7 +584,8 @@ void fillUniformArrayFromImage(float* array, const QImage& img, int size)
}
/*!
- \qmlclass ImageParticle QQuickImageParticle
+ \qmltype ImageParticle
+ \instantiates QQuickImageParticle
\inqmlmodule QtQuick.Particles 2
\inherits ParticlePainter
\brief For visualizing logical particles using an image
diff --git a/src/particles/qquickitemparticle.cpp b/src/particles/qquickitemparticle.cpp
index d63ecdcaf0..bd4168eac3 100644
--- a/src/particles/qquickitemparticle.cpp
+++ b/src/particles/qquickitemparticle.cpp
@@ -49,7 +49,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass ItemParticle QQuickItemParticle
+ \qmltype ItemParticle
+ \instantiates QQuickItemParticle
\inqmlmodule QtQuick.Particles 2
\inherits ParticlePainter
\brief For specifying a delegate to paint particles
diff --git a/src/particles/qquicklineextruder.cpp b/src/particles/qquicklineextruder.cpp
index 3cf44eabc9..1abe0f0bde 100644
--- a/src/particles/qquicklineextruder.cpp
+++ b/src/particles/qquicklineextruder.cpp
@@ -43,7 +43,8 @@
#include <cmath>
/*!
- \qmlclass LineShape QQuickLineExtruder
+ \qmltype LineShape
+ \instantiates QQuickLineExtruder
\inqmlmodule QtQuick.Particles 2
\inherits Shape
\brief Represents a line for affectors and emitters
diff --git a/src/particles/qquickmaskextruder.cpp b/src/particles/qquickmaskextruder.cpp
index 0754f03975..b3112d73da 100644
--- a/src/particles/qquickmaskextruder.cpp
+++ b/src/particles/qquickmaskextruder.cpp
@@ -46,7 +46,8 @@
#include <QDebug>
QT_BEGIN_NAMESPACE
/*!
- \qmlclass MaskShape QQuickMaskExtruder
+ \qmltype MaskShape
+ \instantiates QQuickMaskExtruder
\inqmlmodule QtQuick.Particles 2
\inherits Shape
\brief For representing an image as a shape to affectors and emitters
diff --git a/src/particles/qquickparticleaffector.cpp b/src/particles/qquickparticleaffector.cpp
index 61396b1579..0ad00cebc3 100644
--- a/src/particles/qquickparticleaffector.cpp
+++ b/src/particles/qquickparticleaffector.cpp
@@ -45,7 +45,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Affector QQuickParticleAffector
+ \qmltype Affector
+ \instantiates QQuickParticleAffector
\inqmlmodule QtQuick.Particles 2
\brief Applies alterations to the attributes of logical particles at any
point in their lifetime
diff --git a/src/particles/qquickparticleemitter.cpp b/src/particles/qquickparticleemitter.cpp
index 72aa0a6909..de5f3d9310 100644
--- a/src/particles/qquickparticleemitter.cpp
+++ b/src/particles/qquickparticleemitter.cpp
@@ -46,7 +46,8 @@ QT_BEGIN_NAMESPACE
/*!
- \qmlclass Emitter QQuickParticleEmitter
+ \qmltype Emitter
+ \instantiates QQuickParticleEmitter
\inqmlmodule QtQuick.Particles 2
\brief Emits logical particles
\ingroup qtquick-particles
diff --git a/src/particles/qquickparticleextruder.cpp b/src/particles/qquickparticleextruder.cpp
index 3a54906112..6d220d4d81 100644
--- a/src/particles/qquickparticleextruder.cpp
+++ b/src/particles/qquickparticleextruder.cpp
@@ -45,7 +45,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Shape QQuickParticleExtruder
+ \qmltype Shape
+ \instantiates QQuickParticleExtruder
\inqmlmodule QtQuick.Particles 2
\brief For specifying an area for affectors and emitters
\ingroup qtquick-particles
diff --git a/src/particles/qquickparticlegroup.cpp b/src/particles/qquickparticlegroup.cpp
index 515f3f04fa..fe6d0873e9 100644
--- a/src/particles/qquickparticlegroup.cpp
+++ b/src/particles/qquickparticlegroup.cpp
@@ -42,7 +42,8 @@
#include "qquickparticlegroup_p.h"
/*!
- \qmlclass ParticleGroup QQuickParticleGroup
+ \qmltype ParticleGroup
+ \instantiates QQuickParticleGroup
\inqmlmodule QtQuick.Particles 2
\brief For setting attributes on a logical particle group
\ingroup qtquick-particles
diff --git a/src/particles/qquickparticlepainter.cpp b/src/particles/qquickparticlepainter.cpp
index c27500c2d6..5088a871f9 100644
--- a/src/particles/qquickparticlepainter.cpp
+++ b/src/particles/qquickparticlepainter.cpp
@@ -44,7 +44,8 @@
#include <QDebug>
QT_BEGIN_NAMESPACE
/*!
- \qmlclass ParticlePainter QQuickParticlePainter
+ \qmltype ParticlePainter
+ \instantiates QQuickParticlePainter
\inqmlmodule QtQuick.Particles 2
\inherits ParticlePainter
\brief For specifying how to paint particles
diff --git a/src/particles/qquickparticlesystem.cpp b/src/particles/qquickparticlesystem.cpp
index 891c50ed44..14694e7b1f 100644
--- a/src/particles/qquickparticlesystem.cpp
+++ b/src/particles/qquickparticlesystem.cpp
@@ -101,7 +101,8 @@ DEFINE_BOOL_CONFIG_OPTION(qmlParticlesDebug, QML_PARTICLES_DEBUG)
*/
/*!
- \qmlclass ParticleSystem QQuickParticleSystem
+ \qmltype ParticleSystem
+ \instantiates QQuickParticleSystem
\inqmlmodule QtQuick.Particles 2
\brief A system which includes particle painter, emitter, and affector types
\ingroup qtquick-particles
diff --git a/src/particles/qquickpointattractor.cpp b/src/particles/qquickpointattractor.cpp
index 9d1cb102b9..88f1f9eded 100644
--- a/src/particles/qquickpointattractor.cpp
+++ b/src/particles/qquickpointattractor.cpp
@@ -44,7 +44,8 @@
#include <QDebug>
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Attractor QQuickAttractorAffector
+ \qmltype Attractor
+ \instantiates QQuickAttractorAffector
\inqmlmodule QtQuick.Particles 2
\ingroup qtquick-particles
\inherits Affector
diff --git a/src/particles/qquickpointdirection.cpp b/src/particles/qquickpointdirection.cpp
index de9b777300..c7c37993ac 100644
--- a/src/particles/qquickpointdirection.cpp
+++ b/src/particles/qquickpointdirection.cpp
@@ -45,7 +45,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass PointDirection QQuickPointDirection
+ \qmltype PointDirection
+ \instantiates QQuickPointDirection
\inqmlmodule QtQuick.Particles 2
\ingroup qtquick-particles
\inherits Direction
diff --git a/src/particles/qquickrectangleextruder.cpp b/src/particles/qquickrectangleextruder.cpp
index f527bb9ee3..692906b13a 100644
--- a/src/particles/qquickrectangleextruder.cpp
+++ b/src/particles/qquickrectangleextruder.cpp
@@ -45,7 +45,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass RectangleShape QQuickRectangleExtruder
+ \qmltype RectangleShape
+ \instantiates QQuickRectangleExtruder
\inqmlmodule QtQuick.Particles 2
\brief For specifying an area for affectors and emitter
\ingroup qtquick-particles
diff --git a/src/particles/qquickspritegoal.cpp b/src/particles/qquickspritegoal.cpp
index e051efb20c..f40b4d18c9 100644
--- a/src/particles/qquickspritegoal.cpp
+++ b/src/particles/qquickspritegoal.cpp
@@ -48,7 +48,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass SpriteGoal QQuickSpriteGoalAffector
+ \qmltype SpriteGoal
+ \instantiates QQuickSpriteGoalAffector
\inqmlmodule QtQuick.Particles 2
\ingroup qtquick-images-sprites
\inherits Affector
diff --git a/src/particles/qquicktargetdirection.cpp b/src/particles/qquicktargetdirection.cpp
index dfbe4c7a99..85bfde0fbe 100644
--- a/src/particles/qquicktargetdirection.cpp
+++ b/src/particles/qquicktargetdirection.cpp
@@ -46,7 +46,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass TargetDirection QQuickTargetDirection
+ \qmltype TargetDirection
+ \instantiates QQuickTargetDirection
\inqmlmodule QtQuick.Particles 2
\ingroup qtquick-particles
\inherits Direction
diff --git a/src/particles/qquicktrailemitter.cpp b/src/particles/qquicktrailemitter.cpp
index 86d0c16b8b..919bae6fbb 100644
--- a/src/particles/qquicktrailemitter.cpp
+++ b/src/particles/qquicktrailemitter.cpp
@@ -46,7 +46,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass TrailEmitter QQuickTrailEmitter
+ \qmltype TrailEmitter
+ \instantiates QQuickTrailEmitter
\inqmlmodule QtQuick.Particles 2
\inherits QQuickParticleEmitter
\brief Emits logical particles from other logical particles
diff --git a/src/particles/qquickturbulence.cpp b/src/particles/qquickturbulence.cpp
index b92a2ac1c5..982b11b6ff 100644
--- a/src/particles/qquickturbulence.cpp
+++ b/src/particles/qquickturbulence.cpp
@@ -47,7 +47,8 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Turbulence QQuickTurbulenceAffector
+ \qmltype Turbulence
+ \instantiates QQuickTurbulenceAffector
\inqmlmodule QtQuick.Particles 2
\ingroup qtquick-particles
\inherits Affector
diff --git a/src/particles/qquickv8particledata.cpp b/src/particles/qquickv8particledata.cpp
index 296797f606..80dec6848c 100644
--- a/src/particles/qquickv8particledata.cpp
+++ b/src/particles/qquickv8particledata.cpp
@@ -46,7 +46,7 @@
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Particle
+ \qmltype Particle
\inqmlmodule QtQuick.Particles 2
\brief Represents particles manipulated by emitters and affectors
\ingroup qtquick-particles
diff --git a/src/particles/qquickwander.cpp b/src/particles/qquickwander.cpp
index a7e6c8db04..e8e810dcf7 100644
--- a/src/particles/qquickwander.cpp
+++ b/src/particles/qquickwander.cpp
@@ -43,7 +43,8 @@
#include "qquickparticlesystem_p.h"//for ParticlesVertices
QT_BEGIN_NAMESPACE
/*!
- \qmlclass Wander QQuickWanderAffector
+ \qmltype Wander
+ \instantiates QQuickWanderAffector
\inqmlmodule QtQuick.Particles 2
\ingroup qtquick-particles
\inherits Affector