diff options
author | Jerome Pasion <jerome.pasion@nokia.com> | 2012-05-28 19:40:02 +0200 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-06-06 06:27:41 +0200 |
commit | ca6d49e6b4096f5a9737c6aee04e9b22a781aba2 (patch) | |
tree | 5fabb7125253062e4f36490e151a6fad064f82b5 /src/particles | |
parent | 2896a434715d70c73409042d78ecc2e92b8b093b (diff) |
Doc: Grouped Qt Quick types into several groups
-created new groups and converted some overviews into group pages
-edited type documentation and added \ingroup
-articles still need title fixes and link fixes
Groups:
qtquick-visual-types
qtquick-item-graphics
qtquick-shaders
qtquick-canvas
qtquick-text
qtquick-text-validator
qtquick-interaction
qtquick-positioners
qtquick-transformations
qtquick-states
qtquick-animation-define
qtquick-animation-properties
qtquick-animation-control
qtquick-animation-modifiers
qtquick-images-sprites
qtquick-images
qtquick-models
qtquick-containers
qtquick-views
qtquick-paths
qtquick-utility
Task: QTBUG-25685
Change-Id: I81d4df3320bf5daad5cabb5e42408013fb24f464
Reviewed-by: Bea Lam <bea.lam@nokia.com>
Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
Diffstat (limited to 'src/particles')
28 files changed, 29 insertions, 0 deletions
diff --git a/src/particles/qquickage.cpp b/src/particles/qquickage.cpp index c69f33acc8..6527069913 100644 --- a/src/particles/qquickage.cpp +++ b/src/particles/qquickage.cpp @@ -47,6 +47,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Particles 2 \inherits Affector \brief For altering particle ages + \ingroup qtquick-particles 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 e30984e50f..90631092ae 100644 --- a/src/particles/qquickangledirection.cpp +++ b/src/particles/qquickangledirection.cpp @@ -50,6 +50,7 @@ const qreal CONV = 0.017453292519943295; /*! \qmlclass AngleDirection QQuickAngleDirection \inqmlmodule QtQuick.Particles 2 + \ingroup qtquick-particles \inherits Direction \brief For specifying a direction that varies in angle diff --git a/src/particles/qquickcumulativedirection.cpp b/src/particles/qquickcumulativedirection.cpp index c187251343..705da0103f 100644 --- a/src/particles/qquickcumulativedirection.cpp +++ b/src/particles/qquickcumulativedirection.cpp @@ -47,6 +47,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Particles 2 \inherits Direction \brief For specifying a direction made of other directions + \ingroup qtquick-particles 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 798a00c54d..eeb830cc87 100644 --- a/src/particles/qquickcustomparticle.cpp +++ b/src/particles/qquickcustomparticle.cpp @@ -125,6 +125,7 @@ struct PlainVertices { \inqmlmodule QtQuick.Particles 2 \inherits ParticlePainter \brief For specifying shaders to paint particles + \ingroup qtquick-particles */ diff --git a/src/particles/qquickdirection.cpp b/src/particles/qquickdirection.cpp index aa45c12c88..f5d05ee9bc 100644 --- a/src/particles/qquickdirection.cpp +++ b/src/particles/qquickdirection.cpp @@ -46,6 +46,8 @@ QT_BEGIN_NAMESPACE \qmlclass Direction 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 d7feccba4a..5c11dfb82b 100644 --- a/src/particles/qquickellipseextruder.cpp +++ b/src/particles/qquickellipseextruder.cpp @@ -51,6 +51,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass EllipseShape QQuickEllipseExtruder \inqmlmodule QtQuick.Particles 2 + \ingroup qtquick-particles \inherits Shape \brief Represents an ellipse to other particle system elements diff --git a/src/particles/qquickfriction.cpp b/src/particles/qquickfriction.cpp index 465c70ae1e..ca12cbeec8 100644 --- a/src/particles/qquickfriction.cpp +++ b/src/particles/qquickfriction.cpp @@ -44,6 +44,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Friction QQuickFrictionAffector \inqmlmodule QtQuick.Particles 2 + \ingroup qtquick-particles \inherits Affector \brief For applying friction proportional to the particle's current speed diff --git a/src/particles/qquickgravity.cpp b/src/particles/qquickgravity.cpp index ae68f32f7d..4e3cc52498 100644 --- a/src/particles/qquickgravity.cpp +++ b/src/particles/qquickgravity.cpp @@ -46,6 +46,7 @@ const qreal CONV = 0.017453292520444443; /*! \qmlclass Gravity QQuickGravityAffector \inqmlmodule QtQuick.Particles 2 + \ingroup qtquick-particles \inherits Affector \brief For applying accleration in an angle diff --git a/src/particles/qquickgroupgoal.cpp b/src/particles/qquickgroupgoal.cpp index 614a2f8c64..96f9e1bc57 100644 --- a/src/particles/qquickgroupgoal.cpp +++ b/src/particles/qquickgroupgoal.cpp @@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass GroupGoal QQuickGroupGoalAffector \inqmlmodule QtQuick.Particles 2 + \ingroup qtquick-particles \inherits Affector \brief For changing the state of a group of a particle diff --git a/src/particles/qquickimageparticle.cpp b/src/particles/qquickimageparticle.cpp index d83d2f8d60..06e5c75ed5 100644 --- a/src/particles/qquickimageparticle.cpp +++ b/src/particles/qquickimageparticle.cpp @@ -588,6 +588,7 @@ void fillUniformArrayFromImage(float* array, const QImage& img, int size) \inqmlmodule QtQuick.Particles 2 \inherits ParticlePainter \brief For visualizing logical particles using an image + \ingroup qtquick-particles 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 d347ca07f1..d63ecdcaf0 100644 --- a/src/particles/qquickitemparticle.cpp +++ b/src/particles/qquickitemparticle.cpp @@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Particles 2 \inherits ParticlePainter \brief For specifying a delegate to paint particles + \ingroup qtquick-particles */ diff --git a/src/particles/qquicklineextruder.cpp b/src/particles/qquicklineextruder.cpp index 4cefa386bd..3cf44eabc9 100644 --- a/src/particles/qquicklineextruder.cpp +++ b/src/particles/qquicklineextruder.cpp @@ -47,6 +47,7 @@ \inqmlmodule QtQuick.Particles 2 \inherits Shape \brief Represents a line for affectors and emitters + \ingroup qtquick-particles */ diff --git a/src/particles/qquickmaskextruder.cpp b/src/particles/qquickmaskextruder.cpp index d294c6d04b..0754f03975 100644 --- a/src/particles/qquickmaskextruder.cpp +++ b/src/particles/qquickmaskextruder.cpp @@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Particles 2 \inherits Shape \brief For representing an image as a shape to affectors and emitters + \ingroup qtquick-particles */ /*! diff --git a/src/particles/qquickparticleaffector.cpp b/src/particles/qquickparticleaffector.cpp index f0a4874b5d..471484e287 100644 --- a/src/particles/qquickparticleaffector.cpp +++ b/src/particles/qquickparticleaffector.cpp @@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Particles 2 \brief Applies alterations to the attributes of logical particles at any point in their lifetime + \ingroup qtquick-particles 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 23364a2c25..eb965a7f81 100644 --- a/src/particles/qquickparticleemitter.cpp +++ b/src/particles/qquickparticleemitter.cpp @@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE \qmlclass Emitter QQuickParticleEmitter \inqmlmodule QtQuick.Particles 2 \brief Emits logical particles + \ingroup qtquick-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 6a28a3ddd5..3a54906112 100644 --- a/src/particles/qquickparticleextruder.cpp +++ b/src/particles/qquickparticleextruder.cpp @@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE \qmlclass Shape QQuickParticleExtruder \inqmlmodule QtQuick.Particles 2 \brief For specifying an area for affectors and emitters + \ingroup qtquick-particles The base class is just a rectangle. */ diff --git a/src/particles/qquickparticlegroup.cpp b/src/particles/qquickparticlegroup.cpp index e6e217982a..515f3f04fa 100644 --- a/src/particles/qquickparticlegroup.cpp +++ b/src/particles/qquickparticlegroup.cpp @@ -45,6 +45,7 @@ \qmlclass ParticleGroup QQuickParticleGroup \inqmlmodule QtQuick.Particles 2 \brief For setting attributes on a logical particle group + \ingroup qtquick-particles This element allows you to set timed transitions on particle groups. diff --git a/src/particles/qquickparticlepainter.cpp b/src/particles/qquickparticlepainter.cpp index 3c4d5982ca..dcdbc59fe9 100644 --- a/src/particles/qquickparticlepainter.cpp +++ b/src/particles/qquickparticlepainter.cpp @@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Particles 2 \inherits ParticlePainter \brief For specifying how to paint particles + \ingroup qtquick-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 f5a25ffbee..6b5fbfae0b 100644 --- a/src/particles/qquickparticlesystem.cpp +++ b/src/particles/qquickparticlesystem.cpp @@ -104,6 +104,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlParticlesDebug, QML_PARTICLES_DEBUG) \qmlclass ParticleSystem 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 ce6fb1887c..9d1cb102b9 100644 --- a/src/particles/qquickpointattractor.cpp +++ b/src/particles/qquickpointattractor.cpp @@ -46,6 +46,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Attractor QQuickAttractorAffector \inqmlmodule QtQuick.Particles 2 + \ingroup qtquick-particles \inherits Affector \brief For attracting particles towards a specific point diff --git a/src/particles/qquickpointdirection.cpp b/src/particles/qquickpointdirection.cpp index 8106a6445d..de9b777300 100644 --- a/src/particles/qquickpointdirection.cpp +++ b/src/particles/qquickpointdirection.cpp @@ -47,6 +47,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass PointDirection QQuickPointDirection \inqmlmodule QtQuick.Particles 2 + \ingroup qtquick-particles \inherits Direction \brief For specifying a direction that varies in x and y components diff --git a/src/particles/qquickrectangleextruder.cpp b/src/particles/qquickrectangleextruder.cpp index 9d95dcce63..f527bb9ee3 100644 --- a/src/particles/qquickrectangleextruder.cpp +++ b/src/particles/qquickrectangleextruder.cpp @@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE \qmlclass RectangleShape QQuickRectangleExtruder \inqmlmodule QtQuick.Particles 2 \brief For specifying an area for affectors and emitter + \ingroup qtquick-particles Just a rectangle. */ diff --git a/src/particles/qquickspritegoal.cpp b/src/particles/qquickspritegoal.cpp index 7b58bece76..e051efb20c 100644 --- a/src/particles/qquickspritegoal.cpp +++ b/src/particles/qquickspritegoal.cpp @@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass SpriteGoal QQuickSpriteGoalAffector \inqmlmodule QtQuick.Particles 2 + \ingroup qtquick-images-sprites \inherits Affector \brief For changing the the state of a sprite particle diff --git a/src/particles/qquicktargetdirection.cpp b/src/particles/qquicktargetdirection.cpp index 086149191e..dfbe4c7a99 100644 --- a/src/particles/qquicktargetdirection.cpp +++ b/src/particles/qquicktargetdirection.cpp @@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass TargetDirection QQuickTargetDirection \inqmlmodule QtQuick.Particles 2 + \ingroup qtquick-particles \inherits Direction \brief For specifying a direction towards the target point diff --git a/src/particles/qquicktrailemitter.cpp b/src/particles/qquicktrailemitter.cpp index cd202f6ed9..e9d86118c0 100644 --- a/src/particles/qquicktrailemitter.cpp +++ b/src/particles/qquicktrailemitter.cpp @@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Particles 2 \inherits QQuickParticleEmitter \brief Emits logical particles from other logical particles + \ingroup qtquick-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 dac67df031..b92a2ac1c5 100644 --- a/src/particles/qquickturbulence.cpp +++ b/src/particles/qquickturbulence.cpp @@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Turbulence QQuickTurbulenceAffector \inqmlmodule QtQuick.Particles 2 + \ingroup qtquick-particles \inherits Affector \brief Provides fluid-like forces from a noise image diff --git a/src/particles/qquickv8particledata.cpp b/src/particles/qquickv8particledata.cpp index 8cbbcabf3a..eb9881ee78 100644 --- a/src/particles/qquickv8particledata.cpp +++ b/src/particles/qquickv8particledata.cpp @@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE \qmlclass Particle \inqmlmodule QtQuick.Particles 2 \brief Represents particles manipulated by emitters and affectors + \ingroup qtquick-particles 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 8d2556d4b1..9def03adce 100644 --- a/src/particles/qquickwander.cpp +++ b/src/particles/qquickwander.cpp @@ -45,6 +45,7 @@ QT_BEGIN_NAMESPACE /*! \qmlclass Wander QQuickWanderAffector \inqmlmodule QtQuick.Particles 2 + \ingroup qtquick-particles \inherits Affector \brief For applying random particle trajectory |