Doc: Sanitized QML types

-modified \brief
-checked QML modules
-added qml directory to the qdocconf file
-added particles directory to the qdocconf file

Change-Id: I589e32d3106cda37c7fa4d55a941afd9876fc2b2
Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>

28 files changed, 29 insertions, 28 deletions

diff --git a/src/particles/qquickage.cpp b/src/particles/qquickage.cpp
index 9f24cba3cc..c69f33acc8 100644
--- a/src/particles/qquickage.cpp
+++ b/src/particles/qquickage.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass Age QQuickAgeAffector
     \inqmlmodule QtQuick.Particles 2
     \inherits Affector
-    \brief The Age affector allows you to prematurely age particles
+    \brief For altering particle ages
 
     The Age affector allows you to alter where the particle is in its lifecycle. Common uses
     are to expire particles prematurely, possibly giving them time to animate out.
diff --git a/src/particles/qquickangledirection.cpp b/src/particles/qquickangledirection.cpp
index e77c47362c..e30984e50f 100644
--- a/src/particles/qquickangledirection.cpp
+++ b/src/particles/qquickangledirection.cpp
@@ -51,7 +51,7 @@ const qreal CONV = 0.017453292519943295;
     \qmlclass AngleDirection QQuickAngleDirection
     \inqmlmodule QtQuick.Particles 2
     \inherits Direction
-    \brief The AngleDirection element allows you to specify a direction that varies in angle
+    \brief For specifying a direction that varies in angle
 
     The AngledDirection element allows both the specification of a direction by angle and magnitude,
     as well as varying the parameters by angle or magnitude.
diff --git a/src/particles/qquickcumulativedirection.cpp b/src/particles/qquickcumulativedirection.cpp
index d7c4094297..c187251343 100644
--- a/src/particles/qquickcumulativedirection.cpp
+++ b/src/particles/qquickcumulativedirection.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass CumulativeDirection QQuickCumulativeDirection
     \inqmlmodule QtQuick.Particles 2
     \inherits Direction
-    \brief The CumulativeDirection element allows you to specify a direction made of other directions
+    \brief For specifying a direction made of other directions
 
     The CumulativeDirection element will act as a direction that sums the directions within it.
 */
diff --git a/src/particles/qquickcustomparticle.cpp b/src/particles/qquickcustomparticle.cpp
index 7d27e48c6b..798a00c54d 100644
--- a/src/particles/qquickcustomparticle.cpp
+++ b/src/particles/qquickcustomparticle.cpp
@@ -124,7 +124,7 @@ struct PlainVertices {
     \qmlclass CustomParticle QQuickCustomParticle
     \inqmlmodule QtQuick.Particles 2
     \inherits ParticlePainter
-    \brief The CustomParticle element allows you to specify your own shader to paint particles.
+    \brief For specifying shaders to paint particles
 
 */
 
diff --git a/src/particles/qquickdirection.cpp b/src/particles/qquickdirection.cpp
index 4127d06be0..aa45c12c88 100644
--- a/src/particles/qquickdirection.cpp
+++ b/src/particles/qquickdirection.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlclass Direction QQuickDirection
     \inqmlmodule QtQuick.Particles 2
-    \brief The Direction elements allow you to specify a vector space.
+    \brief For specifying a vector space
 
 */
 
diff --git a/src/particles/qquickellipseextruder.cpp b/src/particles/qquickellipseextruder.cpp
index 083564e5cb..d7feccba4a 100644
--- a/src/particles/qquickellipseextruder.cpp
+++ b/src/particles/qquickellipseextruder.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass EllipseShape QQuickEllipseExtruder
     \inqmlmodule QtQuick.Particles 2
     \inherits Shape
-    \brief The EllipseShape represents an ellipse to other particle system elements
+    \brief Represents an ellipse to other particle system elements
 
     This shape can be used by Emitter subclasses and Affector subclasses to have
     them act upon an ellipse shaped area.
diff --git a/src/particles/qquickfriction.cpp b/src/particles/qquickfriction.cpp
index d37d109f48..465c70ae1e 100644
--- a/src/particles/qquickfriction.cpp
+++ b/src/particles/qquickfriction.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass Friction QQuickFrictionAffector
     \inqmlmodule QtQuick.Particles 2
     \inherits Affector
-    \brief The Friction affector slows down movement proportional to the particle's current speed.
+    \brief For applying friction proportional to the particle's current speed
 
 */
 
diff --git a/src/particles/qquickgravity.cpp b/src/particles/qquickgravity.cpp
index cf4f35eb72..ae68f32f7d 100644
--- a/src/particles/qquickgravity.cpp
+++ b/src/particles/qquickgravity.cpp
@@ -47,7 +47,7 @@ const qreal CONV = 0.017453292520444443;
     \qmlclass Gravity QQuickGravityAffector
     \inqmlmodule QtQuick.Particles 2
     \inherits Affector
-    \brief The Gravity element allows you to set an accleration in an angle
+    \brief For applying accleration in an angle
 
     This element will accelerate all affected particles to a vector of
     the specified magnitude in the specified angle. If the angle and acceleration do
diff --git a/src/particles/qquickgroupgoal.cpp b/src/particles/qquickgroupgoal.cpp
index 0d7f15a9e1..614a2f8c64 100644
--- a/src/particles/qquickgroupgoal.cpp
+++ b/src/particles/qquickgroupgoal.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass GroupGoal QQuickGroupGoalAffector
     \inqmlmodule QtQuick.Particles 2
     \inherits Affector
-    \brief The GroupGoal Affector allows you to change the state of a group of a particle.
+    \brief For changing the state of a group of a particle
 
 */
 /*!
diff --git a/src/particles/qquickimageparticle.cpp b/src/particles/qquickimageparticle.cpp
index 80420ee4c2..d83d2f8d60 100644
--- a/src/particles/qquickimageparticle.cpp
+++ b/src/particles/qquickimageparticle.cpp
@@ -587,7 +587,7 @@ void fillUniformArrayFromImage(float* array, const QImage& img, int size)
     \qmlclass ImageParticle QQuickImageParticle
     \inqmlmodule QtQuick.Particles 2
     \inherits ParticlePainter
-    \brief The ImageParticle element visualizes logical particles using an image
+    \brief For visualizing logical particles using an image
 
     This element renders a logical particle as an image. The image can be
     \list
diff --git a/src/particles/qquickitemparticle.cpp b/src/particles/qquickitemparticle.cpp
index 91ef06fcb2..d347ca07f1 100644
--- a/src/particles/qquickitemparticle.cpp
+++ b/src/particles/qquickitemparticle.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass ItemParticle QQuickItemParticle
     \inqmlmodule QtQuick.Particles 2
     \inherits ParticlePainter
-    \brief The ItemParticle element allows you to specify your own delegate to paint particles.
+    \brief For specifying a delegate to paint particles
 
 */
 
diff --git a/src/particles/qquicklineextruder.cpp b/src/particles/qquicklineextruder.cpp
index f555de3f72..4cefa386bd 100644
--- a/src/particles/qquicklineextruder.cpp
+++ b/src/particles/qquicklineextruder.cpp
@@ -46,7 +46,7 @@
     \qmlclass LineShape QQuickLineExtruder
     \inqmlmodule QtQuick.Particles 2
     \inherits Shape
-    \brief The LineShape represents a line to Affectors and Emitter
+    \brief Represents a line for affectors and emitters
 
 */
 
diff --git a/src/particles/qquickmaskextruder.cpp b/src/particles/qquickmaskextruder.cpp
index 161a60ca8f..d294c6d04b 100644
--- a/src/particles/qquickmaskextruder.cpp
+++ b/src/particles/qquickmaskextruder.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass MaskShape QQuickMaskExtruder
     \inqmlmodule QtQuick.Particles 2
     \inherits Shape
-    \brief The MaskShape element allows you to represent an image as a shape to affectors and emitters.
+    \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 e2be8771d4..f0a4874b5d 100644
--- a/src/particles/qquickparticleaffector.cpp
+++ b/src/particles/qquickparticleaffector.cpp
@@ -47,7 +47,8 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlclass Affector QQuickParticleAffector
     \inqmlmodule QtQuick.Particles 2
-    \brief Affector elements can alter the attributes of logical particles at any point in their lifetime.
+    \brief Applies alterations to the attributes of logical particles at any
+    point in their lifetime
 
     The base Affector does not alter any attributes, but can be used to emit a signal
     when a particle meets certain conditions.
diff --git a/src/particles/qquickparticleemitter.cpp b/src/particles/qquickparticleemitter.cpp
index 8181e8b4f1..23364a2c25 100644
--- a/src/particles/qquickparticleemitter.cpp
+++ b/src/particles/qquickparticleemitter.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlclass Emitter QQuickParticleEmitter
     \inqmlmodule QtQuick.Particles 2
-    \brief The Emitter element allows you to emit logical particles.
+    \brief Emits logical particles
 
     This element emits logical particles into the ParticleSystem, with the
     given starting attributes.
diff --git a/src/particles/qquickparticleextruder.cpp b/src/particles/qquickparticleextruder.cpp
index 279f7c05f3..6a28a3ddd5 100644
--- a/src/particles/qquickparticleextruder.cpp
+++ b/src/particles/qquickparticleextruder.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlclass Shape QQuickParticleExtruder
     \inqmlmodule QtQuick.Particles 2
-    \brief The Shape element allows you to specify an area for affectors and emitter.
+    \brief For specifying an area for affectors and emitters
 
     The base class is just a rectangle.
 */
diff --git a/src/particles/qquickparticlegroup.cpp b/src/particles/qquickparticlegroup.cpp
index 9a165074a1..e6e217982a 100644
--- a/src/particles/qquickparticlegroup.cpp
+++ b/src/particles/qquickparticlegroup.cpp
@@ -44,7 +44,7 @@
 /*!
     \qmlclass ParticleGroup QQuickParticleGroup
     \inqmlmodule QtQuick.Particles 2
-    \brief ParticleGroup elements allow you to set attributes on a logical particle group.
+    \brief For setting attributes on a logical particle group
 
     This element allows you to set timed transitions on particle groups.
 
diff --git a/src/particles/qquickparticlepainter.cpp b/src/particles/qquickparticlepainter.cpp
index e490b70240..3c4d5982ca 100644
--- a/src/particles/qquickparticlepainter.cpp
+++ b/src/particles/qquickparticlepainter.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass ParticlePainter QQuickParticlePainter
     \inqmlmodule QtQuick.Particles 2
     \inherits ParticlePainter
-    \brief ParticlePainter elements allow you to specify how to paint particles.
+    \brief For specifying how to paint particles
 
     The default implementation paints nothing. See the subclasses if you want to
     paint something visible.
diff --git a/src/particles/qquickparticlesystem.cpp b/src/particles/qquickparticlesystem.cpp
index 4fd6108f2f..f5a25ffbee 100644
--- a/src/particles/qquickparticlesystem.cpp
+++ b/src/particles/qquickparticlesystem.cpp
@@ -103,7 +103,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlParticlesDebug, QML_PARTICLES_DEBUG)
 /*!
     \qmlclass ParticleSystem QQuickParticleSystem
     \inqmlmodule QtQuick.Particles 2
-    \brief The ParticleSystem brings together ParticlePainter, Emitter and Affector elements.
+    \brief A system which includes particle painter, emitter, and affector types
 
 */
 
diff --git a/src/particles/qquickpointattractor.cpp b/src/particles/qquickpointattractor.cpp
index a54ee41c1e..ce6fb1887c 100644
--- a/src/particles/qquickpointattractor.cpp
+++ b/src/particles/qquickpointattractor.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass Attractor QQuickAttractorAffector
     \inqmlmodule QtQuick.Particles 2
     \inherits Affector
-    \brief The Attractor allows you to attract particles towards a specific point.
+    \brief For attracting particles towards a specific point
 
     Note that the size and position of this element affects which particles it affects.
     The size of the point attracted to is always 0x0, and the location of that point
diff --git a/src/particles/qquickpointdirection.cpp b/src/particles/qquickpointdirection.cpp
index e35eb4854c..8106a6445d 100644
--- a/src/particles/qquickpointdirection.cpp
+++ b/src/particles/qquickpointdirection.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass PointDirection QQuickPointDirection
     \inqmlmodule QtQuick.Particles 2
     \inherits Direction
-    \brief The PointDirection element allows you to specify a direction that varies in x and y components
+    \brief For specifying a direction that varies in x and y components
 
     The PointDirection element allows both the specification of a direction by x and y components,
     as well as varying the parameters by x or y component.
diff --git a/src/particles/qquickrectangleextruder.cpp b/src/particles/qquickrectangleextruder.cpp
index ad2207ca9a..9d95dcce63 100644
--- a/src/particles/qquickrectangleextruder.cpp
+++ b/src/particles/qquickrectangleextruder.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlclass RectangleShape QQuickRectangleExtruder
     \inqmlmodule QtQuick.Particles 2
-    \brief The RectangleShape element allows you to specify an area for affectors and emitter.
+    \brief For specifying an area for affectors and emitter
 
     Just a rectangle.
 */
diff --git a/src/particles/qquickspritegoal.cpp b/src/particles/qquickspritegoal.cpp
index 95d913cafa..7b58bece76 100644
--- a/src/particles/qquickspritegoal.cpp
+++ b/src/particles/qquickspritegoal.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass SpriteGoal QQuickSpriteGoalAffector
     \inqmlmodule QtQuick.Particles 2
     \inherits Affector
-    \brief The SpriteGoal Affector allows you to change the state of a sprite particle.
+    \brief For changing the the state of a sprite particle
 
 */
 /*!
diff --git a/src/particles/qquicktargetdirection.cpp b/src/particles/qquicktargetdirection.cpp
index 695684dfde..086149191e 100644
--- a/src/particles/qquicktargetdirection.cpp
+++ b/src/particles/qquicktargetdirection.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass TargetDirection QQuickTargetDirection
     \inqmlmodule QtQuick.Particles 2
     \inherits Direction
-    \brief The TargetDirection element allows you to specify a direction towards the target point
+    \brief For specifying a direction towards the target point
 
 */
 /*!
diff --git a/src/particles/qquicktrailemitter.cpp b/src/particles/qquicktrailemitter.cpp
index 3ea68ce681..cd202f6ed9 100644
--- a/src/particles/qquicktrailemitter.cpp
+++ b/src/particles/qquicktrailemitter.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass TrailEmitter QQuickTrailEmitter
     \inqmlmodule QtQuick.Particles 2
     \inherits QQuickParticleEmitter
-    \brief The TrailEmitter element allows you to emit logical particles from other logical particles.
+    \brief Emits logical particles from other logical particles
 
     This element emits logical particles into the ParticleSystem, with the
     starting positions based on those of other logical particles.
diff --git a/src/particles/qquickturbulence.cpp b/src/particles/qquickturbulence.cpp
index 18ecc6a4cd..dac67df031 100644
--- a/src/particles/qquickturbulence.cpp
+++ b/src/particles/qquickturbulence.cpp
@@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass Turbulence QQuickTurbulenceAffector
     \inqmlmodule QtQuick.Particles 2
     \inherits Affector
-    \brief Turbulence provides fluid like forces based on a noise image.
+    \brief Provides fluid-like forces from a noise image
 
     The Turbulence Element scales the noise source over the area it affects,
     and uses the curl of that source to generate force vectors.
diff --git a/src/particles/qquickv8particledata.cpp b/src/particles/qquickv8particledata.cpp
index 8e50e41091..8cbbcabf3a 100644
--- a/src/particles/qquickv8particledata.cpp
+++ b/src/particles/qquickv8particledata.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \qmlclass Particle
     \inqmlmodule QtQuick.Particles 2
-    \brief Particle elements can be manipulated in custom emitters and affectors.
+    \brief Represents particles manipulated by emitters and affectors
 
     Particle elements are always managed internally by the ParticleSystem and cannot be created in QML.
     However, sometimes they are exposed via signals so as to allow arbitrary changes to the particle state
diff --git a/src/particles/qquickwander.cpp b/src/particles/qquickwander.cpp
index 0f9a5f069b..8d2556d4b1 100644
--- a/src/particles/qquickwander.cpp
+++ b/src/particles/qquickwander.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
     \qmlclass Wander QQuickWanderAffector
     \inqmlmodule QtQuick.Particles 2
     \inherits Affector
-    \brief The Wander affector allows particles to randomly vary their trajectory.
+    \brief For applying random particle trajectory
 
 */
 /*!