aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@nokia.com>2012-05-28 19:40:02 +0200
committerQt by Nokia <qt-info@nokia.com>2012-06-06 06:27:41 +0200
commitca6d49e6b4096f5a9737c6aee04e9b22a781aba2 (patch)
tree5fabb7125253062e4f36490e151a6fad064f82b5
parent2896a434715d70c73409042d78ecc2e92b8b093b (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>
-rw-r--r--src/imports/folderlistmodel/qquickfolderlistmodel.cpp2
-rw-r--r--src/imports/testlib/signalspy.qdoc1
-rw-r--r--src/imports/testlib/testcase.qdoc1
-rw-r--r--src/imports/xmllistmodel/qqmlxmllistmodel.cpp4
-rw-r--r--src/particles/qquickage.cpp1
-rw-r--r--src/particles/qquickangledirection.cpp1
-rw-r--r--src/particles/qquickcumulativedirection.cpp1
-rw-r--r--src/particles/qquickcustomparticle.cpp1
-rw-r--r--src/particles/qquickdirection.cpp2
-rw-r--r--src/particles/qquickellipseextruder.cpp1
-rw-r--r--src/particles/qquickfriction.cpp1
-rw-r--r--src/particles/qquickgravity.cpp1
-rw-r--r--src/particles/qquickgroupgoal.cpp1
-rw-r--r--src/particles/qquickimageparticle.cpp1
-rw-r--r--src/particles/qquickitemparticle.cpp1
-rw-r--r--src/particles/qquicklineextruder.cpp1
-rw-r--r--src/particles/qquickmaskextruder.cpp1
-rw-r--r--src/particles/qquickparticleaffector.cpp1
-rw-r--r--src/particles/qquickparticleemitter.cpp1
-rw-r--r--src/particles/qquickparticleextruder.cpp1
-rw-r--r--src/particles/qquickparticlegroup.cpp1
-rw-r--r--src/particles/qquickparticlepainter.cpp1
-rw-r--r--src/particles/qquickparticlesystem.cpp1
-rw-r--r--src/particles/qquickpointattractor.cpp1
-rw-r--r--src/particles/qquickpointdirection.cpp1
-rw-r--r--src/particles/qquickrectangleextruder.cpp1
-rw-r--r--src/particles/qquickspritegoal.cpp1
-rw-r--r--src/particles/qquicktargetdirection.cpp1
-rw-r--r--src/particles/qquicktrailemitter.cpp1
-rw-r--r--src/particles/qquickturbulence.cpp1
-rw-r--r--src/particles/qquickv8particledata.cpp1
-rw-r--r--src/particles/qquickwander.cpp1
-rw-r--r--src/qml/qml/qquicklistmodel.cpp4
-rw-r--r--src/quick/doc/qtquick.qdocconf5
-rw-r--r--src/quick/doc/src/animation-define.qdoc29
-rw-r--r--src/quick/doc/src/animation.qdoc29
-rw-r--r--src/quick/doc/src/canvaspainting.qdoc14
-rw-r--r--src/quick/doc/src/containers.qdoc34
-rw-r--r--src/quick/doc/src/images.qdoc39
-rw-r--r--src/quick/doc/src/interaction.qdoc35
-rw-r--r--src/quick/doc/src/itemgraphics.qdoc35
-rw-r--r--src/quick/doc/src/models.qdoc35
-rw-r--r--src/quick/doc/src/modelview.qdoc2
-rw-r--r--src/quick/doc/src/particles/particletypes.qdoc35
-rw-r--r--src/quick/doc/src/paths.qdoc35
-rw-r--r--src/quick/doc/src/positioners.qdoc9
-rw-r--r--src/quick/doc/src/qtquicktypes.qdoc174
-rw-r--r--src/quick/doc/src/shaders.qdoc11
-rw-r--r--src/quick/doc/src/sprites.qdoc8
-rw-r--r--src/quick/doc/src/states.qdoc16
-rw-r--r--src/quick/doc/src/texthandling.qdoc71
-rw-r--r--src/quick/doc/src/transformations.qdoc35
-rw-r--r--src/quick/doc/src/uicreation.qdoc4
-rw-r--r--src/quick/doc/src/utility.qdoc35
-rw-r--r--src/quick/doc/src/views.qdoc35
-rw-r--r--src/quick/doc/src/visualtypes.qdoc35
-rw-r--r--src/quick/items/context2d/qquickcanvasitem.cpp4
-rw-r--r--src/quick/items/context2d/qquickcontext2d.cpp5
-rw-r--r--src/quick/items/qquickaccessibleattached.cpp2
-rw-r--r--src/quick/items/qquickanimatedimage.cpp2
-rw-r--r--src/quick/items/qquickanimatedsprite.cpp1
-rw-r--r--src/quick/items/qquickborderimage.cpp2
-rw-r--r--src/quick/items/qquickcanvas.cpp1
-rw-r--r--src/quick/items/qquickdrag.cpp1
-rw-r--r--src/quick/items/qquickdroparea.cpp2
-rw-r--r--src/quick/items/qquickevents.cpp6
-rw-r--r--src/quick/items/qquickflickable.cpp3
-rw-r--r--src/quick/items/qquickflipable.cpp4
-rw-r--r--src/quick/items/qquickfocusscope.cpp2
-rw-r--r--src/quick/items/qquickgridview.cpp2
-rw-r--r--src/quick/items/qquickimage.cpp4
-rw-r--r--src/quick/items/qquickitem.cpp15
-rw-r--r--src/quick/items/qquickitemanimation.cpp4
-rw-r--r--src/quick/items/qquickitemviewtransition.cpp2
-rw-r--r--src/quick/items/qquicklistview.cpp2
-rw-r--r--src/quick/items/qquickloader.cpp2
-rw-r--r--src/quick/items/qquickmousearea.cpp2
-rw-r--r--src/quick/items/qquickmultipointtoucharea.cpp6
-rw-r--r--src/quick/items/qquickpathview.cpp5
-rw-r--r--src/quick/items/qquickpincharea.cpp5
-rw-r--r--src/quick/items/qquickpositioners.cpp18
-rw-r--r--src/quick/items/qquickrectangle.cpp8
-rw-r--r--src/quick/items/qquickrepeater.cpp2
-rw-r--r--src/quick/items/qquickscreen.cpp1
-rw-r--r--src/quick/items/qquickshadereffect.cpp4
-rw-r--r--src/quick/items/qquickshadereffectmesh.cpp2
-rw-r--r--src/quick/items/qquickshadereffectsource.cpp4
-rw-r--r--src/quick/items/qquicksprite.cpp1
-rw-r--r--src/quick/items/qquickspritesequence.cpp1
-rw-r--r--src/quick/items/qquickstateoperations.cpp4
-rw-r--r--src/quick/items/qquicktext.cpp4
-rw-r--r--src/quick/items/qquicktextedit.cpp4
-rw-r--r--src/quick/items/qquicktextinput.cpp8
-rw-r--r--src/quick/items/qquickvisualdatamodel.cpp4
-rw-r--r--src/quick/items/qquickvisualitemmodel.cpp2
-rw-r--r--src/quick/util/qquickanimation.cpp22
-rw-r--r--src/quick/util/qquickanimationcontroller.cpp2
-rw-r--r--src/quick/util/qquickbehavior.cpp2
-rw-r--r--src/quick/util/qquickbind.cpp2
-rw-r--r--src/quick/util/qquickconnections.cpp4
-rw-r--r--src/quick/util/qquickfontloader.cpp10
-rw-r--r--src/quick/util/qquickpackage.cpp20
-rw-r--r--src/quick/util/qquickpath.cpp24
-rw-r--r--src/quick/util/qquickpathinterpolator.cpp1
-rw-r--r--src/quick/util/qquickpropertychanges.cpp2
-rw-r--r--src/quick/util/qquicksmoothedanimation.cpp2
-rw-r--r--src/quick/util/qquickspringanimation.cpp2
-rw-r--r--src/quick/util/qquickstate.cpp8
-rw-r--r--src/quick/util/qquickstatechangescript.cpp2
-rw-r--r--src/quick/util/qquickstategroup.cpp12
-rw-r--r--src/quick/util/qquicksystempalette.cpp4
-rw-r--r--src/quick/util/qquicktimer.cpp2
-rw-r--r--src/quick/util/qquicktransition.cpp2
113 files changed, 903 insertions, 172 deletions
diff --git a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp
index de3baf1d17..aad7072a19 100644
--- a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp
+++ b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp
@@ -198,7 +198,7 @@ void QQuickFolderListModelPrivate::_q_sortFinished(const QList<FileProperty> &li
/*!
\qmlclass FolderListModel QQuickFolderListModel
- \ingroup qml-working-with-data
+ \ingroup qtquick-models
\brief The FolderListModel provides a model of the contents of a file system folder.
FolderListModel provides access to information about the contents of a folder
diff --git a/src/imports/testlib/signalspy.qdoc b/src/imports/testlib/signalspy.qdoc
index 743c0e2aed..c294cf266b 100644
--- a/src/imports/testlib/signalspy.qdoc
+++ b/src/imports/testlib/signalspy.qdoc
@@ -42,6 +42,7 @@
/*!
\qmlclass SignalSpy SignalSpy
\brief Enables introspection of signal emission
+ \ingroup qtquick-utility
\since 4.8
\ingroup qtest::qml
diff --git a/src/imports/testlib/testcase.qdoc b/src/imports/testlib/testcase.qdoc
index 3f47c237e2..b7f9a10703 100644
--- a/src/imports/testlib/testcase.qdoc
+++ b/src/imports/testlib/testcase.qdoc
@@ -42,6 +42,7 @@
/*!
\qmlclass TestCase TestCase
\brief Represents a unit test case
+ \ingroup qtquick-utility
\since 4.8
\ingroup qtest::qml
diff --git a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp
index 7ae94bb5af..41e66b0406 100644
--- a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp
+++ b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp
@@ -71,8 +71,8 @@ typedef QPair<int, int> QQuickXmlListRange;
/*!
\qmlclass XmlRole QQuickXmlListModelRole
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
\brief For specifying a role to an XmlListModel
+ \ingroup qtquick-models
\sa {QtQml}
*/
@@ -596,8 +596,8 @@ void QQuickXmlListModelPrivate::clear_role(QQmlListProperty<QQuickXmlListModelRo
/*!
\qmlclass XmlListModel QQuickXmlListModel
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
\brief For specifying a read-only model using XPath expressions
+ \ingroup qtquick-models
To use this element, you will need to import the module with the following line:
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
diff --git a/src/qml/qml/qquicklistmodel.cpp b/src/qml/qml/qquicklistmodel.cpp
index 8e1155bae8..461d4d8610 100644
--- a/src/qml/qml/qquicklistmodel.cpp
+++ b/src/qml/qml/qquicklistmodel.cpp
@@ -1356,8 +1356,8 @@ QQuickListModelParser::ListInstruction *QQuickListModelParser::ListModelData::in
/*!
\qmlclass ListModel QQuickListModel
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
\brief Defines a free-form list data source
+ \ingroup qtquick-models
The ListModel is a simple container of ListElement definitions, each containing data roles.
The contents can be defined dynamically, or explicitly in QML.
@@ -2427,8 +2427,8 @@ bool QQuickListModelParser::definesEmptyList(const QString &s)
/*!
\qmlclass ListElement QQuickListElement
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
\brief Defines a data item in a ListModel
+ \ingroup qtquick-models
List elements are defined inside ListModel definitions, and represent items in a
list that will be displayed using ListView or \l Repeater items.
diff --git a/src/quick/doc/qtquick.qdocconf b/src/quick/doc/qtquick.qdocconf
index 452fe46ffc..423627819b 100644
--- a/src/quick/doc/qtquick.qdocconf
+++ b/src/quick/doc/qtquick.qdocconf
@@ -98,3 +98,8 @@ imagedirs += ../../qml
#add particles sources
headerdirs += ../../particles
sourcedirs += ../../particles
+
+#add imports directory because of dependencies
+headerdirs += ../../imports
+sourcedirs += ../../imports
+
diff --git a/src/quick/doc/src/animation-define.qdoc b/src/quick/doc/src/animation-define.qdoc
new file mode 100644
index 0000000000..f3f3cec1e9
--- /dev/null
+++ b/src/quick/doc/src/animation-define.qdoc
@@ -0,0 +1,29 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-animation-define
diff --git a/src/quick/doc/src/animation.qdoc b/src/quick/doc/src/animation.qdoc
index 6644e794f5..f406948040 100644
--- a/src/quick/doc/src/animation.qdoc
+++ b/src/quick/doc/src/animation.qdoc
@@ -26,11 +26,12 @@
****************************************************************************/
/*!
-\page qtquick-animation.html
+\group qtquick-animation-define
\title Animation and Transitions
\brief the animation system in Qt Quick
\section1 Animation and Transitions Elements
+\generatelist{related}
\list
\li \l {Transition} - Animates transitions during state changes
\li \l {SequentialAnimation} - Runs animations sequentially
@@ -44,6 +45,8 @@
\endlist
Elements that animate properties based on data types
+\annotatedlist qtquick-property-animation
+
\list
\li \l {PropertyAnimation} - Animates property changes
\li \l {NumberAnimation} - Animates properties of type qreal
@@ -249,3 +252,27 @@ Rectangle {
\endqml
*/
+
+/*!
+\group qtquick-animation-properties
+\title Qt Quick Property Animation
+\brief Animate property changes
+
+\generatelist{related}
+*/
+
+/*!
+\group qtquick-animation-control
+\title Qt Quick Animation Controls
+\brief Control animation sequences
+
+\generatelist{related}
+*/
+
+/*!
+\group qtquick-animation-modifiers
+\title Qt Quick Animation Modifiers
+\brief Modify animation sequences
+
+\generatelist{related}
+*/
diff --git a/src/quick/doc/src/canvaspainting.qdoc b/src/quick/doc/src/canvaspainting.qdoc
index 3b1f742b8f..d99e31ff12 100644
--- a/src/quick/doc/src/canvaspainting.qdoc
+++ b/src/quick/doc/src/canvaspainting.qdoc
@@ -26,17 +26,13 @@
****************************************************************************/
/*!
-\page qtquick-canvaspainting.html
+\group qtquick-canvas
\ingroup qml-features
-\title Painting with Canvas API
-\brief custom graphics with the Canvas API
+\title Canvas API
+\brief Custom graphics with the Canvas API
-\section1 Canvas Element
-
-\list
- \li \l{Canvas}
- \li \l{Context2D}
-\endlist
+\section1 Related Types
+\generatelist{related}
The Canvas and Context2D elements implement the \l{HTML Canvas API 2D Context}
and allows applications to have custom painting routines.
diff --git a/src/quick/doc/src/containers.qdoc b/src/quick/doc/src/containers.qdoc
new file mode 100644
index 0000000000..73e39790f5
--- /dev/null
+++ b/src/quick/doc/src/containers.qdoc
@@ -0,0 +1,34 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-containers
+\title Qt Quick Containers
+\brief Specialized views for handling input and animations
+
+\generatelist{related}
+*/
diff --git a/src/quick/doc/src/images.qdoc b/src/quick/doc/src/images.qdoc
new file mode 100644
index 0000000000..842b56bcd3
--- /dev/null
+++ b/src/quick/doc/src/images.qdoc
@@ -0,0 +1,39 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-images
+\ingroup qml-features
+\title Qt Quick Images
+\brief Displaying images in a QML scene
+
+\section1 Related Types
+
+\generatelist{related}
+
+
+*/
diff --git a/src/quick/doc/src/interaction.qdoc b/src/quick/doc/src/interaction.qdoc
new file mode 100644
index 0000000000..aafad3ab5c
--- /dev/null
+++ b/src/quick/doc/src/interaction.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-interaction
+\title Qt Quick Keys and Focus
+\brief Handling mouse input and interaction
+
+\section1 Related Types
+\generatelist{related}
+*/
diff --git a/src/quick/doc/src/itemgraphics.qdoc b/src/quick/doc/src/itemgraphics.qdoc
new file mode 100644
index 0000000000..3924b34eaa
--- /dev/null
+++ b/src/quick/doc/src/itemgraphics.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-item-graphics
+\title Qt Quick Item Graphics
+\brief Graphics applied onto visual types
+
+\section1 Related Types
+\generatelist{related}
+*/
diff --git a/src/quick/doc/src/models.qdoc b/src/quick/doc/src/models.qdoc
new file mode 100644
index 0000000000..6d4e69b4c9
--- /dev/null
+++ b/src/quick/doc/src/models.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-models
+\title Qt Quick Models
+\brief Structuring data for display.
+
+\section1 Related Types
+\generatelist{related}
+*/
diff --git a/src/quick/doc/src/modelview.qdoc b/src/quick/doc/src/modelview.qdoc
index e9a34b34e4..137703b822 100644
--- a/src/quick/doc/src/modelview.qdoc
+++ b/src/quick/doc/src/modelview.qdoc
@@ -56,7 +56,7 @@ To visualize data, bind the view's \c model property to a model and the
Views are containers for collections of items. They are feature-rich and can be
customizable to meet style or behavior requirements.
- \keyword qml-view-elements
+ \keyword qtquick-views
A set of standard views are provided in the basic set of Qt Quick
graphical elements:
diff --git a/src/quick/doc/src/particles/particletypes.qdoc b/src/quick/doc/src/particles/particletypes.qdoc
new file mode 100644
index 0000000000..740fc0079d
--- /dev/null
+++ b/src/quick/doc/src/particles/particletypes.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-particles
+\title Qt Quick Particle Types
+\brief Types for creating particle effects
+
+\section1 Related Types
+\generatelist{related}
+*/
diff --git a/src/quick/doc/src/paths.qdoc b/src/quick/doc/src/paths.qdoc
new file mode 100644
index 0000000000..4e963487a2
--- /dev/null
+++ b/src/quick/doc/src/paths.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-paths
+\title Qt Quick Paths
+\brief Drawing and setting paths
+
+\section1 Related Types
+\generatelist{related}
+*/
diff --git a/src/quick/doc/src/positioners.qdoc b/src/quick/doc/src/positioners.qdoc
index 4ca87cf910..f423216e15 100644
--- a/src/quick/doc/src/positioners.qdoc
+++ b/src/quick/doc/src/positioners.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
-\page qtquick-positioners.html
+\group qtquick-positioners
\ingroup qml-features
\title Item Layouts
@@ -43,12 +43,7 @@ to be arranged in a regular layout.
A set of standard positioners are provided in the basic set of Qt Quick
graphical elements:
-\list
-\li \l{#Column}{Column} arranges its children in a column
-\li \l{#Row}{Row} arranges its children in a row
-\li \l{#Grid}{Grid} arranges its children in a grid
-\li \l{#Flow}{Flow} arranges its children like words on a page
-\endlist
+\generatelist{related}
\section2 Column
diff --git a/src/quick/doc/src/qtquicktypes.qdoc b/src/quick/doc/src/qtquicktypes.qdoc
new file mode 100644
index 0000000000..d064565714
--- /dev/null
+++ b/src/quick/doc/src/qtquicktypes.qdoc
@@ -0,0 +1,174 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\page qtquick-types.html
+\title Qt Quick Types
+\brief A listing of standard types in Qt Quick
+
+
+
+These are the functionally grouped lists of Qt Quick types as part of
+\l{Qt Quick}. You can also browse the module pages for \l{QtQuick 2} and \l{QtQuick.Particles 2}
+
+\section1 Qt Quick Submodules
+
+ \section2 Particle Effects
+
+ The \l{QtQuick.Particles 2} module provides a set of Particle System types
+ for QtQuick 2. The \l{Using the Qt Quick Particle System} article describes
+ the particle system.
+
+ \section2 Local Storage
+ The \l{Local Storage}{SQL Local Storage} submodule contains a
+ JavaScript interface for an SQLite database.
+
+ \section2 XmlListModel
+
+ The \l{QtQuick.XmlListModel 2.0} submodule contains contains the
+ \l{XmlListModel} type, for using remote XML data as a model.
+
+\section1 Visual Types
+ These types are described in the \l{qtquick-visual-types}{Visual Types}
+ overview.
+ \annotatedlist qtquick-visual-types
+
+\section1 Images
+ These types are described in the
+ \l{qtquick-images}{Images} overview.
+ \annotatedlist qtquick-images
+
+\section2 Sprites
+ These types are described in the
+ \l{qtquick-images-sprites}{Sprite Animations} overview.
+ \annotatedlist qtquick-images-sprites
+
+\section1 Item Graphics
+ These types are described in the \l{qtquick-item-graphics}{Item Graphics}
+ overview.
+ \annotatedlist qtquick-item-graphics
+
+\section1 Shader Effects
+
+ These types are described in the \l{qtquick-shaders}{Shader Effects}
+ overview.
+ \annotatedlist qtquick-shaders
+
+\section1 Canvas API
+
+ These types are described in the \l{qtquick-canvas}{Canvas API} overview.
+ \annotatedlist qtquick-canvas
+\section1 Text Handling
+ These types are described in the
+ \l{Qt Quick Text Handling and Validators}{Text Handling and Validators}
+ overview.
+ \annotatedlist qtquick-text
+
+\section2 Validators
+ These types are described in the
+ \l{Qt Quick Text Handling and Validators}{Text Handling and Validators}
+ overview.
+ \annotatedlist qtquick-text-validator
+
+\section1 User Interaction
+
+ These types are described in the
+ \l{qtquick-interaction}{Interaction} overview.
+ \annotatedlist qtquick-interaction
+
+\section1 Transformations
+
+ These types are described in the \l{qtquick-transformations}{Transformation Types} overview.
+ \annotatedlist qtquick-transformations
+
+\section1 States
+
+ These types are described in the \l{qtquick-states}{States}
+ overview.
+ \annotatedlist qtquick-states
+
+\section1 Animation and Transitions
+ These types are described in the
+ \l{qtquick-animation-define}{Animation and Transitions} overview.
+ \annotatedlist qtquick-animation-define
+
+ \section2 Property Animation
+
+ These types animate property changes and are described in the
+ \l{qtquick-animation-define}{Animation and Transitions} overview.
+ \annotatedlist qtquick-animation-properties
+
+ \section2 Animation Controls
+
+ These types provide lower-level animation control. These types are
+ described in the
+ \l{qtquick-animation-define}{Animation and Transitions} overview.
+ \annotatedlist qtquick-animation-control
+
+ \section2 Animation Modifiers
+
+ These types provide specialized changes during the animation. These
+ types are described in the
+ \l{qtquick-animation-define}{Animation and Transitions} overview.
+ \annotatedlist qtquick-animation-modifiers
+
+\section1 Models
+ These types are described in the \l{qtquick-models}{Qt Quick Models}
+ overview. The \l{Models and Views} overview has information about displaying
+ data with views and delegates.
+ \annotatedlist qtquick-models
+
+\section1 Views, Positioners, and Specialized Containers
+
+ \section2 Views
+ These types are described in the \l{qtquick-views}{Views} overview.
+ The \l{Models and Views} overview has information about displaying data with
+ models and delegates.
+ \annotatedlist qtquick-views
+
+ \section2 Containers
+ These types are described in the \l{qtquick-containters}{Containers}
+ overview.
+ \annotatedlist qtquick-containers
+
+ \section1 Positioners
+ These types are described in the \l{qtquick-positioners}{Positioners}
+ overview.
+ \annotatedlist qtquick-positioners
+
+\section1 Paths
+
+ These types are described in the \l{qtquick-paths}{Paths} overview.
+ \annotatedlist qtquick-paths
+
+\section1 Utility
+
+ These types are described in the \l{qtquick-utility}{Object Utilities}
+ overview.
+ \annotatedlist qtquick-utility
+
+*/
diff --git a/src/quick/doc/src/shaders.qdoc b/src/quick/doc/src/shaders.qdoc
index 825eb29ac1..51b3abb19b 100644
--- a/src/quick/doc/src/shaders.qdoc
+++ b/src/quick/doc/src/shaders.qdoc
@@ -25,13 +25,12 @@
**
****************************************************************************/
/*!
-\page qtquick-shaders.html
-\title Shader Effects in QML
-\brief applying OpenGL vertex and fragment shaders to QML Rectangles
+\group qtquick-shaders
+\title Qt Quick Shader Effects
+\brief For applying OpenGL vertex and fragment shaders to rectangles
-\code
-NOTE: This article is a work in progress.
-\endcode
+\section1 Related Types
+\generatelist{related}
\section1 Shaders
Describe Shaders and where it could be used in UIs or applications
diff --git a/src/quick/doc/src/sprites.qdoc b/src/quick/doc/src/sprites.qdoc
index e59b30855e..377abe86c0 100644
--- a/src/quick/doc/src/sprites.qdoc
+++ b/src/quick/doc/src/sprites.qdoc
@@ -26,11 +26,15 @@
****************************************************************************/
/*!
-\page qtquick-spriteengine.html
+\group qtquick-images-sprites
\ingroup qml-features
\title Sprite Animations
\brief Sprite-based animations with flexible transitioning
+\section1 Related Types
+
+\generatelist{related}
+
\section1 Sprite Engine
The QtQuick sprite engine is a stochastic state machine combined with the ability
@@ -151,7 +155,7 @@ Cmd-line tool:
http://www.imagemagick.org/script/montage.php
-\section2 Elements Using the Sprite Engine
+\section2 QML Types Using the Sprite Engine
Sprites for the sprite engine can be defined using the \l Sprite element. This element includes the input parameters
as well as the length of the animation and weighted transitions to other animations. It is purely a data class, and
diff --git a/src/quick/doc/src/states.qdoc b/src/quick/doc/src/states.qdoc
index cc42adfb82..ac7c45bb3b 100644
--- a/src/quick/doc/src/states.qdoc
+++ b/src/quick/doc/src/states.qdoc
@@ -26,22 +26,14 @@
****************************************************************************/
/*!
-\page qtquick-states.html
+\group qtquick-states
\title Qt Quick States
\brief Creating and setting states
-\target qmlstates
-\section1 States Elements
-\list
-\li \l State
-\li \l PropertyChanges
-\li \l StateGroup
-\li \l StateChangeScript
-\li \l ParentChange
-\li \l AnchorChanges
-\endlist
+\section1 Related Types
+\generatelist{related}
-Many user interface designs are \e state driven; interfaces have configurations
+Many user interface designs are \e{state driven}; interfaces have configurations
that differ depending on the current state. For example, a traffic signal will
configure its flags or lights depending on its state. While in the signal's
\c stop state, a red light will turn on while the yellow and the green lights
diff --git a/src/quick/doc/src/texthandling.qdoc b/src/quick/doc/src/texthandling.qdoc
new file mode 100644
index 0000000000..2628776ca3
--- /dev/null
+++ b/src/quick/doc/src/texthandling.qdoc
@@ -0,0 +1,71 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-text
+\title Qt Quick Text Handling and Validators
+\brief Text display, input, and validation
+
+\section1 Text Visual Types
+
+Qt Quick provides several types to display text onto the screen. The \l Text
+type will display formatted text onto the screen, the \l TextEdit type
+will place a multiline line edit onto the screen, and the \l TextInput will
+place a single editable line field onto the screen.
+
+\generatelist{related}
+
+To learn more about their specific features and properties, visit their
+respective documentation.
+
+\section1 Validating Input Text
+
+The \e validator types enforce the type and format of
+\l TextInput objects.
+
+\annotatedlist qtquick-text-validator
+
+\snippet doc/snippets/qml/texthandling.qml int validator
+The validator types bind to \c {TextInput}'s \c validator property.
+
+\snippet doc/snippets/qml/texthandling.qml regexp validator
+The regular expression in the snippet will only allow the inputted text to be
+\c {fruit basket}.
+
+Note that QML parses JavaScript regular expressions, while Qt's
+\l {QRegExp} class' regular expressions are based on Perl regular expressions.
+
+*/
+
+/*!
+\group qtquick-text-validator
+\title Qt Quick Text Validators
+\brief Types that validate text input
+
+The \l{Qt Quick Text Handling and Validators} page has information about
+validating user text input.
+*/
diff --git a/src/quick/doc/src/transformations.qdoc b/src/quick/doc/src/transformations.qdoc
new file mode 100644
index 0000000000..5bd4d832c0
--- /dev/null
+++ b/src/quick/doc/src/transformations.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-transformations
+\title Qt Quick Transformation Types
+\brief Types for applying transformations to visual types
+
+\section1 Related Types
+\generatelist{related}
+*/
diff --git a/src/quick/doc/src/uicreation.qdoc b/src/quick/doc/src/uicreation.qdoc
index 8757c30c01..51ed521625 100644
--- a/src/quick/doc/src/uicreation.qdoc
+++ b/src/quick/doc/src/uicreation.qdoc
@@ -53,9 +53,9 @@ import QtQuick.XmlListModel 2.0
\section1 Graphics and Special Effects
\list
\li \l{Basic Elements}{Basic Elements}
- \li \l{Painting with Canvas API}
+ \li \l{qtquick-canvas}{Painting with Canvas API}
\li \l{Using the Qt Quick Particle System}{Particle Effects}
- \li \l{Shader Effects in QML}{Shader Effects}
+ \li \l{qtquick-shaders}{Shader Effects}
\endlist
\section1 Anchoring and Layouts
diff --git a/src/quick/doc/src/utility.qdoc b/src/quick/doc/src/utility.qdoc
new file mode 100644
index 0000000000..c43c303994
--- /dev/null
+++ b/src/quick/doc/src/utility.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-utility
+\title Qt Quick Object Utilities
+\brief Types for managing objects
+
+\section1 Related Types
+\generatelist{related}
+*/
diff --git a/src/quick/doc/src/views.qdoc b/src/quick/doc/src/views.qdoc
new file mode 100644
index 0000000000..a27625ec62
--- /dev/null
+++ b/src/quick/doc/src/views.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-views
+\title Qt Quick Views
+\brief Presenting data in a view
+
+\section1 Related Types
+\generatelist{related}
+*/
diff --git a/src/quick/doc/src/visualtypes.qdoc b/src/quick/doc/src/visualtypes.qdoc
new file mode 100644
index 0000000000..a16c0a19c6
--- /dev/null
+++ b/src/quick/doc/src/visualtypes.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-visual-types
+\title Qt Quick Visual Types
+\brief Visible items in a scene
+
+\section1 Related Types
+\generatelist{related}
+*/
diff --git a/src/quick/items/context2d/qquickcanvasitem.cpp b/src/quick/items/context2d/qquickcanvasitem.cpp
index 9b2bc43db5..88f0fd11ca 100644
--- a/src/quick/items/context2d/qquickcanvasitem.cpp
+++ b/src/quick/items/context2d/qquickcanvasitem.cpp
@@ -205,9 +205,9 @@ QQuickCanvasItemPrivate::~QQuickCanvasItemPrivate()
\qmlclass Canvas QQuickCanvasItem
\inqmlmodule QtQuick 2
\since QtQuick 2.0
- \brief For specifying a 2D canvas element which enables drawing via Javascript
\inherits Item
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-canvas
+ \brief For specifying a 2D canvas element which enables drawing via Javascript
The Canvas item allows drawing of straight and curved lines, simple and
complex shapes, graphs, and referenced graphic images. It can also add
diff --git a/src/quick/items/context2d/qquickcontext2d.cpp b/src/quick/items/context2d/qquickcontext2d.cpp
index c171bab50b..b78a799287 100644
--- a/src/quick/items/context2d/qquickcontext2d.cpp
+++ b/src/quick/items/context2d/qquickcontext2d.cpp
@@ -74,6 +74,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Context2D QQuickContext2D
\inqmlmodule QtQuick 2
+ \ingroup qtquick-canvas
\since QtQuick 2.0
\brief Provides 2D context for shapes on a Canvas item
@@ -2205,6 +2206,7 @@ static v8::Handle<v8::Value> ctx2d_strokeText(const v8::Arguments &args)
\qmlclass TextMetrics
\inqmlmodule QtQuick 2
\since QtQuick 2.0
+ \ingroup qtquick-canvas
\brief Provides a Context2D TextMetrics interface
The TextMetrics object can be created by QtQuick2::Context2D::measureText method.
@@ -2406,6 +2408,7 @@ static v8::Handle<v8::Value> ctx2d_drawImage(const v8::Arguments &args)
/*!
\qmlclass CanvasImageData
\inqmlmodule QtQuick 2
+ \ingroup qtquick-canvas
\brief Contains image pixel data in RGBA order
The \a QtQuick2::CanvasImageData object holds the image pixel data.
@@ -2458,6 +2461,7 @@ v8::Handle<v8::Value> ctx2d_imageData_data(v8::Local<v8::String>, const v8::Acce
/*!
\qmlclass CanvasPixelArray
\inqmlmodule QtQuick 2
+ \ingroup qtquick-canvas
\brief Provides ordered and indexed access to the components of each pixel in image data
The CanvasPixelArray object provides ordered, indexed access to the color components of each pixel of the image data.
@@ -2697,6 +2701,7 @@ static v8::Handle<v8::Value> ctx2d_putImageData(const v8::Arguments &args)
\qmlclass CanvasGradient
\inqmlmodule QtQuick 2
\since QtQuick 2.0
+ \ingroup qtquick-canvas
\brief Provides an opaque CanvasGradient interface
*/
diff --git a/src/quick/items/qquickaccessibleattached.cpp b/src/quick/items/qquickaccessibleattached.cpp
index c07a60bd9a..0f1565cfac 100644
--- a/src/quick/items/qquickaccessibleattached.cpp
+++ b/src/quick/items/qquickaccessibleattached.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
\brief Enables accessibility of QML items
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-utility
\ingroup accessibility
This class is part of \l {Accessibility for Qt Quick Applications}.
diff --git a/src/quick/items/qquickanimatedimage.cpp b/src/quick/items/qquickanimatedimage.cpp
index f93dc4aa28..97e0f0b4e1 100644
--- a/src/quick/items/qquickanimatedimage.cpp
+++ b/src/quick/items/qquickanimatedimage.cpp
@@ -56,8 +56,8 @@ QT_BEGIN_NAMESPACE
\qmlclass AnimatedImage QQuickAnimatedImage
\inqmlmodule QtQuick 2
\inherits Image
- \ingroup basic-visual-elements
\brief Plays animations stored as a series of images
+ \ingroup qtquick-images
The AnimatedImage element extends the features of the \l Image element, providing
a way to play animations stored as images containing a series of frames,
diff --git a/src/quick/items/qquickanimatedsprite.cpp b/src/quick/items/qquickanimatedsprite.cpp
index 724ae75d6b..24f3de2491 100644
--- a/src/quick/items/qquickanimatedsprite.cpp
+++ b/src/quick/items/qquickanimatedsprite.cpp
@@ -210,6 +210,7 @@ struct AnimatedSpriteVertices {
\qmlclass AnimatedSprite QQuickAnimatedSprite
\inqmlmodule QtQuick 2
\inherits Item
+ \ingroup qtquick-images-sprites
\brief Draws a sprite animation
AnimatedSprite provides rendering and control over animations which are provided
diff --git a/src/quick/items/qquickborderimage.cpp b/src/quick/items/qquickborderimage.cpp
index 015dca5809..355a745c06 100644
--- a/src/quick/items/qquickborderimage.cpp
+++ b/src/quick/items/qquickborderimage.cpp
@@ -59,7 +59,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtQuick 2
\brief For specifying an image that can be used as a border
\inherits Item
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-item-graphics
The BorderImage element is used to create borders out of images by scaling or tiling
parts of each image.
diff --git a/src/quick/items/qquickcanvas.cpp b/src/quick/items/qquickcanvas.cpp
index 7b8d916a54..619b08d7ae 100644
--- a/src/quick/items/qquickcanvas.cpp
+++ b/src/quick/items/qquickcanvas.cpp
@@ -749,6 +749,7 @@ void QQuickCanvasPrivate::cleanup(QSGNode *n)
/*!
\qmlclass Window QQuickCanvas
\inqmlmodule QtQuick.Window 2
+ \ingroup qtquick-visual-types
\brief Creates a new top-level window
The Window object creates a new top-level window for a QtQuick scene. It automatically sets up the
diff --git a/src/quick/items/qquickdrag.cpp b/src/quick/items/qquickdrag.cpp
index 7768d73dca..6f0e677869 100644
--- a/src/quick/items/qquickdrag.cpp
+++ b/src/quick/items/qquickdrag.cpp
@@ -98,6 +98,7 @@ public:
/*!
\qmlclass Drag QQuickDrag
\inqmlmodule QtQuick 2
+ \ingroup qtquick-interaction
\brief For specifying drag and drop events for moved Items
Using the Drag attached property any Item can made a source of drag and drop
diff --git a/src/quick/items/qquickdroparea.cpp b/src/quick/items/qquickdroparea.cpp
index 368ba39a98..5080fcdd41 100644
--- a/src/quick/items/qquickdroparea.cpp
+++ b/src/quick/items/qquickdroparea.cpp
@@ -91,6 +91,7 @@ QQuickDropAreaPrivate::~QQuickDropAreaPrivate()
/*!
\qmlclass DropArea QQuickDropArea
\inqmlmodule QtQuick 2
+ \ingroup qtquick-interaction
\brief For specifying drag and drop handling in an area
A DropArea is an invisible item which receives events when other items are
@@ -326,6 +327,7 @@ void QQuickDropArea::dropEvent(QDropEvent *event)
/*!
\qmlclass DragEvent QQuickDragEvent
\inqmlmodule QtQuick 2
+ \ingroup qtquick-interaction
\brief Provides information about a drag event
The position of the drag event can be obtained from the \l x and \l y
diff --git a/src/quick/items/qquickevents.cpp b/src/quick/items/qquickevents.cpp
index 3053e1e280..b0aeeb79d3 100644
--- a/src/quick/items/qquickevents.cpp
+++ b/src/quick/items/qquickevents.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass KeyEvent QQuickKeyEvent
\inqmlmodule QtQuick 2
- \ingroup qml-event-elements
+ \ingroup qtquick-interaction
\brief Provides information about a key event
@@ -141,7 +141,7 @@ Item {
/*!
\qmlclass MouseEvent QQuickMouseEvent
\inqmlmodule QtQuick 2
- \ingroup qml-event-elements
+ \ingroup qtquick-interaction
\brief Provides information about a mouse event
@@ -239,7 +239,7 @@ Item {
/*!
\qmlclass WheelEvent QQuickWheelEvent
\inqmlmodule QtQuick 2
- \ingroup qml-event-elements
+ \ingroup qtquick-interaction
\brief Provides information about a mouse wheel event
diff --git a/src/quick/items/qquickflickable.cpp b/src/quick/items/qquickflickable.cpp
index d2fa2f149f..a60c6e7245 100644
--- a/src/quick/items/qquickflickable.cpp
+++ b/src/quick/items/qquickflickable.cpp
@@ -504,7 +504,8 @@ is finished.
/*!
\qmlclass Flickable QQuickFlickable
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-interaction
+ \ingroup qtquick-containers
\brief For specifying a surface that can be "flicked"
\inherits Item
diff --git a/src/quick/items/qquickflipable.cpp b/src/quick/items/qquickflipable.cpp
index c2f487c9f2..56dc20f762 100644
--- a/src/quick/items/qquickflipable.cpp
+++ b/src/quick/items/qquickflipable.cpp
@@ -90,9 +90,9 @@ public:
/*!
\qmlclass Flipable QQuickFlipable
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
- \brief For specifying a surface that can be flipped
\inherits Item
+ \ingroup qtquick-containers
+ \brief For specifying a surface that can be flipped
Flipable is an item that can be visibly "flipped" between its front and
back sides, like a card. It is used together with \l Rotation, \l State
diff --git a/src/quick/items/qquickfocusscope.cpp b/src/quick/items/qquickfocusscope.cpp
index 3a8c1aaae1..52102a4e32 100644
--- a/src/quick/items/qquickfocusscope.cpp
+++ b/src/quick/items/qquickfocusscope.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass FocusScope QQuickFocusScope
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-interaction
\brief Explicitly creates a focus scope
\inherits Item
diff --git a/src/quick/items/qquickgridview.cpp b/src/quick/items/qquickgridview.cpp
index 932518489f..3315deaebf 100644
--- a/src/quick/items/qquickgridview.cpp
+++ b/src/quick/items/qquickgridview.cpp
@@ -1148,7 +1148,7 @@ void QQuickGridViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte
/*!
\qmlclass GridView QQuickGridView
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-views
\inherits Flickable
\brief For specifying a grid view of items provided by a model
diff --git a/src/quick/items/qquickimage.cpp b/src/quick/items/qquickimage.cpp
index d4a3cd5b0d..493bf08a4b 100644
--- a/src/quick/items/qquickimage.cpp
+++ b/src/quick/items/qquickimage.cpp
@@ -98,9 +98,9 @@ QQuickImagePrivate::QQuickImagePrivate()
/*!
\qmlclass Image QQuickImage
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
- \brief Displays an image in a declarative user interface
+ \ingroup qtquick-images
\inherits Item
+ \brief Displays an image in a declarative user interface
The Image element is used to display images in a declarative user interface.
diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp
index 15271d5f8f..d184ba02f8 100644
--- a/src/quick/items/qquickitem.cpp
+++ b/src/quick/items/qquickitem.cpp
@@ -129,7 +129,7 @@ void QQuickItemPrivate::registerAccessorProperties()
/*!
\qmlclass Transform QQuickTransform
\inqmlmodule QtQuick 2
- \ingroup qml-transform-elements
+ \ingroup qtquick-transformations
\brief For specifying advanced transformations on Items
The Transform element is a base type which cannot be instantiated directly.
@@ -151,7 +151,7 @@ void QQuickItemPrivate::registerAccessorProperties()
/*!
\qmlclass Translate QQuickTranslate
\inqmlmodule QtQuick 2
- \ingroup qml-transform-elements
+ \ingroup qtquick-transformations
\brief Provides a way to move an Item without changing its x or y properties
The Translate object provides independent control over position in addition to the Item's x and y properties.
@@ -193,7 +193,7 @@ void QQuickItemPrivate::registerAccessorProperties()
/*!
\qmlclass Scale QQuickScale
\inqmlmodule QtQuick 2
- \ingroup qml-transform-elements
+ \ingroup qtquick-transformations
\brief Provides a way to scale an Item
The Scale element gives more control over scaling than using \l Item's \l{Item::scale}{scale} property. Specifically,
@@ -235,7 +235,7 @@ void QQuickItemPrivate::registerAccessorProperties()
/*!
\qmlclass Rotation QQuickRotation
\inqmlmodule QtQuick 2
- \ingroup qml-transform-elements
+ \ingroup qtquick-transformations
\brief Provides a way to rotate an Item
The Rotation object gives more control over rotation than using \l Item's \l{Item::rotation}{rotation} property.
@@ -503,7 +503,7 @@ void QQuickItemKeyFilter::componentComplete()
/*!
\qmlclass KeyNavigation QQuickKeyNavigationAttached
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-interaction
\brief Supports key navigation by arrow keys
Key-based user interfaces commonly allow the use of arrow keys to navigate between
@@ -919,7 +919,7 @@ bool QQuickKeysAttached::isConnected(const char *signalName)
/*!
\qmlclass Keys QQuickKeysAttached
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-interaction
\brief Provides key handling to Items
All visual primitives support key handling via the Keys
@@ -1465,6 +1465,7 @@ QQuickKeysAttached *QQuickKeysAttached::qmlAttachedProperties(QObject *obj)
/*!
\qmlclass LayoutMirroring QQuickLayoutMirroringAttached
\inqmlmodule QtQuick 2
+ \ingroup qtquick-utility
\ingroup qml-utility-elements
\brief Property used to mirror layout behavior
@@ -1723,7 +1724,7 @@ void QQuickItemPrivate::updateSubFocusItem(QQuickItem *scope, bool focus)
\qmlclass Item QQuickItem
\inherits QtObject
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-visual-types
\brief A basic visual QML type
All visual items in Qt Quick inherit from Item. Although Item
diff --git a/src/quick/items/qquickitemanimation.cpp b/src/quick/items/qquickitemanimation.cpp
index 03ada67c06..c6e87bb72e 100644
--- a/src/quick/items/qquickitemanimation.cpp
+++ b/src/quick/items/qquickitemanimation.cpp
@@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass ParentAnimation QQuickParentAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\since QtQuick 2.0
\inherits Animation
\brief Animates changes in parent values
@@ -417,7 +417,7 @@ QAbstractAnimationJob* QQuickParentAnimation::transition(QQuickStateActions &act
/*!
\qmlclass AnchorAnimation QQuickAnchorAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits Animation
\brief Animates changes in anchor values
diff --git a/src/quick/items/qquickitemviewtransition.cpp b/src/quick/items/qquickitemviewtransition.cpp
index d51d79230a..3411d7a34b 100644
--- a/src/quick/items/qquickitemviewtransition.cpp
+++ b/src/quick/items/qquickitemviewtransition.cpp
@@ -568,7 +568,7 @@ QQuickViewTransitionAttached::QQuickViewTransitionAttached(QObject *parent)
/*!
\qmlclass ViewTransition QQuickViewTransitionAttached
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-animation-properties
\brief Specifies items under transition in a view
With ListView and GridView, it is possible to specify transitions that should be applied whenever
diff --git a/src/quick/items/qquicklistview.cpp b/src/quick/items/qquicklistview.cpp
index 8ee3625775..48cdee8ea2 100644
--- a/src/quick/items/qquicklistview.cpp
+++ b/src/quick/items/qquicklistview.cpp
@@ -1641,7 +1641,7 @@ void QQuickListViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte
/*!
\qmlclass ListView QQuickListView
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-views
\inherits Flickable
\brief Provides a list view of items provided by a model
diff --git a/src/quick/items/qquickloader.cpp b/src/quick/items/qquickloader.cpp
index 843d0c18fd..5406016da8 100644
--- a/src/quick/items/qquickloader.cpp
+++ b/src/quick/items/qquickloader.cpp
@@ -155,7 +155,7 @@ qreal QQuickLoaderPrivate::getImplicitHeight() const
/*!
\qmlclass Loader QQuickLoader
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-utility
\inherits Item
\brief Allows dynamical loading of an item-based subtree from a URL or Component
diff --git a/src/quick/items/qquickmousearea.cpp b/src/quick/items/qquickmousearea.cpp
index 30930c3cd8..662638958a 100644
--- a/src/quick/items/qquickmousearea.cpp
+++ b/src/quick/items/qquickmousearea.cpp
@@ -311,7 +311,7 @@ bool QQuickMouseAreaPrivate::propagateHelper(QQuickMouseEvent *ev, QQuickItem *i
/*!
\qmlclass MouseArea QQuickMouseArea
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-interaction
\brief Enables simple mouse handling
\inherits Item
diff --git a/src/quick/items/qquickmultipointtoucharea.cpp b/src/quick/items/qquickmultipointtoucharea.cpp
index fa6bb31767..f1b4596a14 100644
--- a/src/quick/items/qquickmultipointtoucharea.cpp
+++ b/src/quick/items/qquickmultipointtoucharea.cpp
@@ -55,7 +55,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlVisualTouchDebugging, QML_VISUAL_TOUCH_DEBUGGING)
/*!
\qmlclass TouchPoint QQuickTouchPoint
\inqmlmodule QtQuick 2
- \ingroup qml-event-elements
+ \ingroup qtquick-interaction
\brief Describes a touch point in a MultiPointTouchArea
The TouchPoint element contains information about a touch point, such as the current
@@ -224,8 +224,10 @@ void QQuickTouchPoint::setSceneY(qreal sceneY)
/*!
\qmlclass MultiPointTouchArea QQuickMultiPointTouchArea
\inqmlmodule QtQuick 2
- \brief Enables handling of multiple touch points
\inherits Item
+ \ingroup qtquick-interaction
+ \brief Enables handling of multiple touch points
+
A MultiPointTouchArea is an invisible item that is used to track multiple touch points.
diff --git a/src/quick/items/qquickpathview.cpp b/src/quick/items/qquickpathview.cpp
index 393f83b34a..883edeca48 100644
--- a/src/quick/items/qquickpathview.cpp
+++ b/src/quick/items/qquickpathview.cpp
@@ -438,9 +438,10 @@ void QQuickPathViewPrivate::regenerate()
/*!
\qmlclass PathView QQuickPathView
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
- \brief Lays out model-provided items on a path
+ \ingroup qtquick-paths
+ \ingroup qtquick-views
\inherits Item
+ \brief Lays out model-provided items on a path
A PathView displays data from models created from built-in QML elements like ListModel
and XmlListModel, or custom model classes defined in C++ that inherit from
diff --git a/src/quick/items/qquickpincharea.cpp b/src/quick/items/qquickpincharea.cpp
index 59cfeaaad1..90885d12c9 100644
--- a/src/quick/items/qquickpincharea.cpp
+++ b/src/quick/items/qquickpincharea.cpp
@@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass PinchEvent QQuickPinchEvent
\inqmlmodule QtQuick 2
- \ingroup qml-event-elements
+ \ingroup qtquick-interaction
\brief For specifying information about a pinch event
\b {The PinchEvent element was added in QtQuick 1.1}
@@ -163,8 +163,9 @@ QQuickPinchAreaPrivate::~QQuickPinchAreaPrivate()
/*!
\qmlclass PinchArea QQuickPinchArea
\inqmlmodule QtQuick 2
- \brief Enables simple pinch gesture handling
+ \ingroup qtquick-interaction
\inherits Item
+ \brief Enables simple pinch gesture handling
\b {The PinchArea element was added in QtQuick 1.1}
diff --git a/src/quick/items/qquickpositioners.cpp b/src/quick/items/qquickpositioners.cpp
index b5816136cd..50af0979a8 100644
--- a/src/quick/items/qquickpositioners.cpp
+++ b/src/quick/items/qquickpositioners.cpp
@@ -495,7 +495,7 @@ void QQuickBasePositioner::updateAttachedProperties(QQuickPositionerAttached *sp
/*!
\qmlclass Positioner QQuickPositionerAttached
\inqmlmodule QtQuick 2
- \ingroup qml-positioning-elements
+ \ingroup qtquick-positioners
\brief Provides attached properties that contain details on where an item exists in a positioner
Positioner is an attached property that is attached to the top-level child item within a
@@ -577,9 +577,9 @@ void QQuickPositionerAttached::setIsLastItem(bool isLastItem)
/*!
\qmlclass Column QQuickColumn
\inqmlmodule QtQuick 2
- \ingroup qml-positioning-elements
- \brief Positions its children in a column
\inherits Item
+ \ingroup qtquick-positioners
+ \brief Positions its children in a column
Column is an element that positions its child items along a single column.
It can be used as a convenient way to vertically position a series of items without
@@ -745,9 +745,9 @@ void QQuickColumn::reportConflictingAnchors()
/*!
\qmlclass Row QQuickRow
\inqmlmodule QtQuick 2
- \ingroup qml-positioning-elements
- \brief Positions its children in a row
\inherits Item
+ \ingroup qtquick-positioners
+ \brief Positions its children in a row
Row is an element that positions its child items along a single row.
It can be used as a convenient way to horizontally position a series of items without
@@ -976,9 +976,9 @@ void QQuickRow::reportConflictingAnchors()
/*!
\qmlclass Grid QQuickGrid
\inqmlmodule QtQuick 2
- \ingroup qml-positioning-elements
- \brief Positions its children in grid formation
\inherits Item
+ \ingroup qtquick-positioners
+ \brief Positions its children in grid formation
Grid is an element that positions its child items in grid formation.
@@ -1417,9 +1417,9 @@ void QQuickGrid::reportConflictingAnchors()
/*!
\qmlclass Flow QQuickFlow
\inqmlmodule QtQuick 2
- \ingroup qml-positioning-elements
- \brief Positions its children side by side, wrapping as necessary
\inherits Item
+ \ingroup qtquick-positioners
+ \brief Positions its children side by side, wrapping as necessary
The Flow item positions its child items like words on a page, wrapping them
to create rows or columns of items.
diff --git a/src/quick/items/qquickrectangle.cpp b/src/quick/items/qquickrectangle.cpp
index b4156d9749..f912d57954 100644
--- a/src/quick/items/qquickrectangle.cpp
+++ b/src/quick/items/qquickrectangle.cpp
@@ -130,7 +130,7 @@ bool QQuickPen::isValid() const
/*!
\qmlclass GradientStop QQuickGradientStop
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-item-graphics
\brief Defines the color at a position in a Gradient
\sa Gradient
@@ -181,7 +181,7 @@ void QQuickGradientStop::updateGradient()
/*!
\qmlclass Gradient QQuickGradient
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-item-graphics
\brief Defines a gradient fill
A gradient is defined by two or more colors, which will be blended seamlessly.
@@ -280,9 +280,9 @@ int QQuickRectanglePrivate::doUpdateSlotIdx = -1;
/*!
\qmlclass Rectangle QQuickRectangle
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
- \brief Describes a filled rectangle with an optional border
\inherits Item
+ \ingroup qtquick-visual-types
+ \brief Describes a filled rectangle with an optional border
Rectangle items are used to fill areas with solid color or gradients, and are
often used to hold other items.
diff --git a/src/quick/items/qquickrepeater.cpp b/src/quick/items/qquickrepeater.cpp
index fdba3aa21d..8d034e5839 100644
--- a/src/quick/items/qquickrepeater.cpp
+++ b/src/quick/items/qquickrepeater.cpp
@@ -64,7 +64,7 @@ QQuickRepeaterPrivate::~QQuickRepeaterPrivate()
/*!
\qmlclass Repeater QQuickRepeater
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-models
\inherits Item
\brief Specifies how to repeately create an Item-based component using a model
diff --git a/src/quick/items/qquickscreen.cpp b/src/quick/items/qquickscreen.cpp
index 2c8bf01e4e..c3d32eb1c3 100644
--- a/src/quick/items/qquickscreen.cpp
+++ b/src/quick/items/qquickscreen.cpp
@@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Screen QQuickScreenAttached
\inqmlmodule QtQuick.Window 2
+ \ingroup qtquick-utility
\brief The Screen attached object provides information about the Screen an Item is displayed on.
The Screen attached object is only valid inside Item or Item derived elements, after component completion.
diff --git a/src/quick/items/qquickshadereffect.cpp b/src/quick/items/qquickshadereffect.cpp
index 0bf119f28e..a84b3e10b3 100644
--- a/src/quick/items/qquickshadereffect.cpp
+++ b/src/quick/items/qquickshadereffect.cpp
@@ -533,9 +533,9 @@ void QQuickShaderEffectCommon::propertyChanged(QQuickItem *item, int mappedId,
/*!
\qmlclass ShaderEffect QQuickShaderEffect
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
- \brief Applies custom shaders to a rectangle
\inherits Item
+ \ingroup qtquick-shaders
+ \brief Applies custom shaders to a rectangle
The ShaderEffect element applies a custom OpenGL
\l{vertexShader}{vertex} and \l{fragmentShader}{fragment} shader to a
diff --git a/src/quick/items/qquickshadereffectmesh.cpp b/src/quick/items/qquickshadereffectmesh.cpp
index 1d3f0d7bc2..a0d589780b 100644
--- a/src/quick/items/qquickshadereffectmesh.cpp
+++ b/src/quick/items/qquickshadereffectmesh.cpp
@@ -53,7 +53,7 @@ QQuickShaderEffectMesh::QQuickShaderEffectMesh(QObject *parent)
/*!
\qmlclass GridMesh QQuickGridMesh
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-shaders
\brief Defines a mesh with vertices arranged in a grid
GridMesh defines a rectangular mesh consisting of vertices arranged in an
diff --git a/src/quick/items/qquickshadereffectsource.cpp b/src/quick/items/qquickshadereffectsource.cpp
index 1864acc2da..7fbab0d604 100644
--- a/src/quick/items/qquickshadereffectsource.cpp
+++ b/src/quick/items/qquickshadereffectsource.cpp
@@ -455,9 +455,9 @@ QImage QQuickShaderEffectTexture::toImage() const
/*!
\qmlclass ShaderEffectSource QQuickShaderEffectSource
\since 5.0
- \ingroup qml-basic-visual-elements
- \brief Renders a QML element into a texture and displays it
\inherits Item
+ \ingroup qtquick-shaders
+ \brief Renders a QML element into a texture and displays it
The ShaderEffectSource element renders \l sourceItem into a texture and
displays it in the scene. \l sourceItem is drawn into the texture as though
diff --git a/src/quick/items/qquicksprite.cpp b/src/quick/items/qquicksprite.cpp
index 25d77d2e29..1628ed7633 100644
--- a/src/quick/items/qquicksprite.cpp
+++ b/src/quick/items/qquicksprite.cpp
@@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Sprite QQuickSprite
\inqmlmodule QtQuick 2
+ \ingroup qtquick-images-sprites
\brief Specifies sprite animations
QQuickSprite renders sprites of one or more frames and animates them. The sprites
diff --git a/src/quick/items/qquickspritesequence.cpp b/src/quick/items/qquickspritesequence.cpp
index 69daab7e75..0e7d998fbb 100644
--- a/src/quick/items/qquickspritesequence.cpp
+++ b/src/quick/items/qquickspritesequence.cpp
@@ -209,6 +209,7 @@ struct SpriteVertices {
/*!
\qmlclass SpriteSequence QQuickSpriteSequence
\inqmlmodule QtQuick 2
+ \ingroup qtquick-images-sprites
\inherits Item
\brief Draws a sprite animation
diff --git a/src/quick/items/qquickstateoperations.cpp b/src/quick/items/qquickstateoperations.cpp
index 6857e3f9b6..c61dc50ca5 100644
--- a/src/quick/items/qquickstateoperations.cpp
+++ b/src/quick/items/qquickstateoperations.cpp
@@ -149,7 +149,7 @@ void QQuickParentChangePrivate::doChange(QQuickItem *targetParent, QQuickItem *s
/*!
\qmlclass ParentChange QQuickParentChange
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Specifies how to reparent an Item in a state change
ParentChange reparents an item while preserving its visual appearance (position, size,
@@ -560,7 +560,7 @@ void QQuickParentChange::rewind()
/*!
\qmlclass AnchorChanges QQuickAnchorChanges
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Specifies how to change the anchors of an item in a state
The AnchorChanges element is used to modify the anchors of an item in a \l State.
diff --git a/src/quick/items/qquicktext.cpp b/src/quick/items/qquicktext.cpp
index ae560b958b..409f9a9a3f 100644
--- a/src/quick/items/qquicktext.cpp
+++ b/src/quick/items/qquicktext.cpp
@@ -1139,9 +1139,9 @@ void QQuickTextPrivate::ensureDoc()
/*!
\qmlclass Text QQuickText
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
- \brief Specifies how to add formatted text to a scene
+ \ingroup qtquick-text
\inherits Item
+ \brief Specifies how to add formatted text to a scene
Text items can display both plain and rich text. For example, red text with
a specific font and size can be defined like this:
diff --git a/src/quick/items/qquicktextedit.cpp b/src/quick/items/qquicktextedit.cpp
index 5134376807..4b55ff1bd5 100644
--- a/src/quick/items/qquicktextedit.cpp
+++ b/src/quick/items/qquicktextedit.cpp
@@ -67,9 +67,9 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass TextEdit QQuickTextEdit
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
- \brief Displays multiple lines of editable formatted text
+ \ingroup qtquick-text
\inherits Item
+ \brief Displays multiple lines of editable formatted text
The TextEdit item displays a block of editable, formatted text.
diff --git a/src/quick/items/qquicktextinput.cpp b/src/quick/items/qquicktextinput.cpp
index 7589d1c0bc..477cf1c222 100644
--- a/src/quick/items/qquicktextinput.cpp
+++ b/src/quick/items/qquicktextinput.cpp
@@ -68,7 +68,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlDisableDistanceField, QML_DISABLE_DISTANCEFIELD)
/*!
\qmlclass TextInput QQuickTextInput
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-text
\inherits Item
\brief Displays an editable line of text
@@ -844,7 +844,7 @@ void QQuickTextInput::setAutoScroll(bool b)
/*!
\qmlclass IntValidator QIntValidator
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-text-validator
\brief Defines a validator for integer values
This element provides a validator for integer values.
@@ -907,7 +907,7 @@ void QQuickIntValidator::resetLocaleName()
/*!
\qmlclass DoubleValidator QDoubleValidator
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-text-validator
\brief Defines a validator for non-integer numbers
This element provides a validator for non-integer numbers.
@@ -1000,7 +1000,7 @@ void QQuickDoubleValidator::resetLocaleName()
/*!
\qmlclass RegExpValidator QRegExpValidator
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-text-validator
\brief Provides a string validator
This element provides a validator, which counts as valid any string which
diff --git a/src/quick/items/qquickvisualdatamodel.cpp b/src/quick/items/qquickvisualdatamodel.cpp
index c0277cbb93..197a60b80b 100644
--- a/src/quick/items/qquickvisualdatamodel.cpp
+++ b/src/quick/items/qquickvisualdatamodel.cpp
@@ -122,7 +122,7 @@ QQuickVisualDataModelParts::QQuickVisualDataModelParts(QQuickVisualDataModel *pa
/*!
\qmlclass VisualDataModel QQuickVisualDataModel
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
+ \ingroup qtquick-models
\brief Encapsulates a model and delegate
A VisualDataModel encapsulates a model and the delegate that will
@@ -2057,7 +2057,7 @@ void QQuickVisualDataGroupPrivate::destroyingPackage(QQuickPackage *package)
/*!
\qmlclass VisualDataGroup QQuickVisualDataGroup
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
+ \ingroup qtquick-models
\brief Encapsulates a filtered set of visual data items
*/
diff --git a/src/quick/items/qquickvisualitemmodel.cpp b/src/quick/items/qquickvisualitemmodel.cpp
index 1cb595ec4d..2cd9106c4a 100644
--- a/src/quick/items/qquickvisualitemmodel.cpp
+++ b/src/quick/items/qquickvisualitemmodel.cpp
@@ -118,7 +118,7 @@ public:
/*!
\qmlclass VisualItemModel QQuickVisualItemModel
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
+ \ingroup qtquick-models
\brief Defines items to be used added to a view
A VisualItemModel contains the visual items to be used in a view.
diff --git a/src/quick/util/qquickanimation.cpp b/src/quick/util/qquickanimation.cpp
index 33c24f38d7..8162aaeee3 100644
--- a/src/quick/util/qquickanimation.cpp
+++ b/src/quick/util/qquickanimation.cpp
@@ -72,7 +72,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Animation QQuickAbstractAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\brief Is the base of all QML animations
The Animation element cannot be used directly in a QML file. It exists
@@ -617,7 +617,7 @@ void QQuickAbstractAnimationPrivate::animationFinished(QAbstractAnimationJob*)
/*!
\qmlclass PauseAnimation QQuickPauseAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-modifiers
\inherits Animation
\brief Provides a pause for an animation
@@ -687,7 +687,7 @@ QAbstractAnimationJob* QQuickPauseAnimation::transition(QQuickStateActions &acti
/*!
\qmlclass ColorAnimation QQuickColorAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits PropertyAnimation
\brief Animates changes in color values
@@ -831,7 +831,7 @@ void QActionAnimation::updateState(State newState, State oldState)
/*!
\qmlclass ScriptAction QQuickScriptAction
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-modifiers
\inherits Animation
\brief Defines scripts to be run during an animation
@@ -957,7 +957,7 @@ QAbstractAnimationJob* QQuickScriptAction::transition(QQuickStateActions &action
/*!
\qmlclass PropertyAction QQuickPropertyAction
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-modifiers
\inherits Animation
\brief Specifies immediate property changes during animation
@@ -1209,7 +1209,7 @@ QAbstractAnimationJob* QQuickPropertyAction::transition(QQuickStateActions &acti
/*!
\qmlclass NumberAnimation QQuickNumberAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits PropertyAnimation
\brief Animates changes in qreal-type values
@@ -1321,7 +1321,7 @@ void QQuickNumberAnimation::setTo(qreal t)
/*!
\qmlclass Vector3dAnimation QQuickVector3dAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits PropertyAnimation
\brief Animates changes in QVector3d values
@@ -1397,7 +1397,7 @@ void QQuickVector3dAnimation::setTo(QVector3D t)
/*!
\qmlclass RotationAnimation QQuickRotationAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits PropertyAnimation
\brief Animates changes in rotation values
@@ -1637,7 +1637,7 @@ QQmlListProperty<QQuickAbstractAnimation> QQuickAnimationGroup::animations()
/*!
\qmlclass SequentialAnimation QQuickSequentialAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-define
\inherits Animation
\brief Allows animations to be run sequentially
@@ -1710,7 +1710,7 @@ QAbstractAnimationJob* QQuickSequentialAnimation::transition(QQuickStateActions
/*!
\qmlclass ParallelAnimation QQuickParallelAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-define
\inherits Animation
\brief Enables animations to be run in parallel
@@ -1836,7 +1836,7 @@ void QQuickBulkValueAnimator::topLevelAnimationLoopChanged()
/*!
\qmlclass PropertyAnimation QQuickPropertyAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits Animation
\brief Animates changes in property values
diff --git a/src/quick/util/qquickanimationcontroller.cpp b/src/quick/util/qquickanimationcontroller.cpp
index f81b39c8a8..4cfee6d11f 100644
--- a/src/quick/util/qquickanimationcontroller.cpp
+++ b/src/quick/util/qquickanimationcontroller.cpp
@@ -94,7 +94,7 @@ void QQuickAnimationControllerPrivate::animationCurrentTimeChanged(QAbstractAnim
/*!
\qmlclass AnimationController QQuickAnimationController
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-control
\brief Enables manual control of animations
Normally animations are driven by an internal timer, but the AnimationController
diff --git a/src/quick/util/qquickbehavior.cpp b/src/quick/util/qquickbehavior.cpp
index 4aa3d17c0e..0de99d4db1 100644
--- a/src/quick/util/qquickbehavior.cpp
+++ b/src/quick/util/qquickbehavior.cpp
@@ -75,7 +75,7 @@ public:
/*!
\qmlclass Behavior QQuickBehavior
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-define
\brief Defines a default animation for a property change
A Behavior defines the default animation to be applied whenever a
diff --git a/src/quick/util/qquickbind.cpp b/src/quick/util/qquickbind.cpp
index 81377bf778..bd57efb29b 100644
--- a/src/quick/util/qquickbind.cpp
+++ b/src/quick/util/qquickbind.cpp
@@ -77,7 +77,7 @@ public:
/*!
\qmlclass Binding QQuickBind
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
+ \ingroup qtquick-utility
\brief Enables the arbitrary creation of property bindings
\section1 Binding to an inaccessible property
diff --git a/src/quick/util/qquickconnections.cpp b/src/quick/util/qquickconnections.cpp
index bbc7a8dec8..6a20e31821 100644
--- a/src/quick/util/qquickconnections.cpp
+++ b/src/quick/util/qquickconnections.cpp
@@ -73,7 +73,7 @@ public:
/*!
\qmlclass Connections QQuickConnections
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-utility
\brief Describes generalized connections to signals
A Connections object creates a connection to a QML signal.
@@ -87,7 +87,7 @@ public:
}
\endqml
- However, it is not possible to connect to a signal in this way in some
+ However, it is not possible to connect to a signal in this way in some
cases, such as when:
\list
diff --git a/src/quick/util/qquickfontloader.cpp b/src/quick/util/qquickfontloader.cpp
index e2863776f5..7e5f3de9af 100644
--- a/src/quick/util/qquickfontloader.cpp
+++ b/src/quick/util/qquickfontloader.cpp
@@ -148,19 +148,19 @@ QHash<QUrl, QQuickFontObject*> QQuickFontLoaderPrivate::fonts;
/*!
\qmlclass FontLoader QQuickFontLoader
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-utility
\brief Allows fonts to be loaded by name or URL
- The FontLoader element is used to load fonts by name or URL.
-
- The \l status indicates when the font has been loaded, which is useful
+ The FontLoader element is used to load fonts by name or URL.
+
+ The \l status indicates when the font has been loaded, which is useful
for fonts loaded from remote sources.
For example:
\qml
import QtQuick 2.0
- Column {
+ Column {
FontLoader { id: fixedFont; name: "Courier" }
FontLoader { id: webFont; source: "http://www.mysite.com/myfont.ttf" }
diff --git a/src/quick/util/qquickpackage.cpp b/src/quick/util/qquickpackage.cpp
index ede1c68d02..059a55ea88 100644
--- a/src/quick/util/qquickpackage.cpp
+++ b/src/quick/util/qquickpackage.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Package QQuickPackage
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
+ \ingroup qtquick-views
\brief Specifies a collection of named items
The Package class is used in conjunction with
@@ -128,14 +128,14 @@ QQuickPackageAttached::~QQuickPackageAttached()
attached.remove(parent());
}
-QString QQuickPackageAttached::name() const
-{
- return _name;
+QString QQuickPackageAttached::name() const
+{
+ return _name;
}
-void QQuickPackageAttached::setName(const QString &n)
-{
- _name = n;
+void QQuickPackageAttached::setName(const QString &n)
+{
+ _name = n;
}
QQuickPackage::QQuickPackage(QObject *parent)
@@ -150,9 +150,9 @@ QQuickPackage::~QQuickPackage()
QQmlListProperty<QObject> QQuickPackage::data()
{
Q_D(QQuickPackage);
- return QQmlListProperty<QObject>(this, &d->dataList, QQuickPackagePrivate::data_append,
- QQuickPackagePrivate::data_count,
- QQuickPackagePrivate::data_at,
+ return QQmlListProperty<QObject>(this, &d->dataList, QQuickPackagePrivate::data_append,
+ QQuickPackagePrivate::data_count,
+ QQuickPackagePrivate::data_at,
QQuickPackagePrivate::data_clear);
}
diff --git a/src/quick/util/qquickpath.cpp b/src/quick/util/qquickpath.cpp
index cce412a851..b1adfe3d68 100644
--- a/src/quick/util/qquickpath.cpp
+++ b/src/quick/util/qquickpath.cpp
@@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass PathElement QQuickPathElement
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief PathElement is the base path type
This type is the base for all path types. It cannot
@@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Path QQuickPath
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines a path for use by \l PathView
A Path is composed of one or more path segments - PathLine, PathQuad,
@@ -805,7 +805,7 @@ bool QQuickCurve::hasRelativeY()
/*!
\qmlclass PathAttribute QQuickPathAttribute
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Specifies how to set an attribute at a given position in a Path
The PathAttribute object allows attributes consisting of a name and
@@ -921,7 +921,7 @@ void QQuickPathAttribute::setValue(qreal value)
/*!
\qmlclass PathLine QQuickPathLine
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines a straight line
The example below creates a path consisting of a straight line from
@@ -979,7 +979,7 @@ void QQuickPathLine::addToPath(QPainterPath &path, const QQuickPathData &data)
/*!
\qmlclass PathQuad QQuickPathQuad
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines a quadratic Bezier curve with a control point
The following QML produces the path shown below:
@@ -1128,10 +1128,10 @@ void QQuickPathQuad::addToPath(QPainterPath &path, const QQuickPathData &data)
/****************************************************************************/
/*!
- \qmlclass PathCubic QQuickPathCubic
+ \qmlclass PathCubic QQuickPathCubic
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
- \brief Defines a cubic Bezier curve with two control points
+ \ingroup qtquick-paths
+ \brief Defines a cubic Bezier curve with two control points
The following QML produces the path shown below:
\table
@@ -1353,7 +1353,7 @@ void QQuickPathCubic::addToPath(QPainterPath &path, const QQuickPathData &data)
/*!
\qmlclass PathCurve QQuickPathCurve
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines a point on a Catmull-Rom curve
PathCurve provides an easy way to specify a curve passing directly through a set of points.
@@ -1498,7 +1498,7 @@ void QQuickPathCatmullRomCurve::addToPath(QPainterPath &path, const QQuickPathDa
/*!
\qmlclass PathArc QQuickPathArc
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines an arc with the given radius
PathArc provides a simple way of specifying an arc that ends at a given position
@@ -1668,7 +1668,7 @@ void QQuickPathArc::addToPath(QPainterPath &path, const QQuickPathData &data)
/*!
\qmlclass PathSvg QQuickPathSvg
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines a path using an SVG path data string
The following QML produces the path shown below:
@@ -1720,7 +1720,7 @@ void QQuickPathSvg::addToPath(QPainterPath &path, const QQuickPathData &)
/*!
\qmlclass PathPercent QQuickPathPercent
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Manipulates the way a path is interpreted
PathPercent allows you to manipulate the spacing between items on a
diff --git a/src/quick/util/qquickpathinterpolator.cpp b/src/quick/util/qquickpathinterpolator.cpp
index 62bb9c1a10..1430f72058 100644
--- a/src/quick/util/qquickpathinterpolator.cpp
+++ b/src/quick/util/qquickpathinterpolator.cpp
@@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass PathInterpolator QQuickPathInterpolator
\inqmlmodule QtQuick 2
+ \ingroup qtquick-animation-control
\brief Specifies how to manually animate along a path
PathInterpolator provides \c x, \c y, and \c angle information for a particular \c progress
diff --git a/src/quick/util/qquickpropertychanges.cpp b/src/quick/util/qquickpropertychanges.cpp
index 969c326b97..b51eefcd4e 100644
--- a/src/quick/util/qquickpropertychanges.cpp
+++ b/src/quick/util/qquickpropertychanges.cpp
@@ -66,7 +66,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass PropertyChanges QQuickPropertyChanges
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Describes new property bindings or values for a state
PropertyChanges is used to define the property values or bindings in a
diff --git a/src/quick/util/qquicksmoothedanimation.cpp b/src/quick/util/qquicksmoothedanimation.cpp
index 4bc802cded..b4986c0479 100644
--- a/src/quick/util/qquicksmoothedanimation.cpp
+++ b/src/quick/util/qquicksmoothedanimation.cpp
@@ -309,7 +309,7 @@ void QSmoothedAnimation::init()
/*!
\qmlclass SmoothedAnimation QQuickSmoothedAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits NumberAnimation
\brief Allows a property to smoothly track a value
diff --git a/src/quick/util/qquickspringanimation.cpp b/src/quick/util/qquickspringanimation.cpp
index 1f6e51e2b9..3e0a1ce755 100644
--- a/src/quick/util/qquickspringanimation.cpp
+++ b/src/quick/util/qquickspringanimation.cpp
@@ -342,7 +342,7 @@ void QQuickSpringAnimationPrivate::updateMode()
/*!
\qmlclass SpringAnimation QQuickSpringAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits NumberAnimation
\brief Allows a property to track a value in a spring-like motion
diff --git a/src/quick/util/qquickstate.cpp b/src/quick/util/qquickstate.cpp
index da4dde5af3..f6802b1f43 100644
--- a/src/quick/util/qquickstate.cpp
+++ b/src/quick/util/qquickstate.cpp
@@ -61,7 +61,7 @@ QQuickAction::QQuickAction()
QQuickAction::QQuickAction(QObject *target, const QString &propertyName,
const QVariant &value)
-: restore(true), actionDone(false), reverseEvent(false), deletableToBinding(false),
+: restore(true), actionDone(false), reverseEvent(false), deletableToBinding(false),
property(target, propertyName, qmlEngine(target)), toValue(value),
fromBinding(0), event(0),
specifiedObject(target), specifiedProperty(propertyName)
@@ -122,7 +122,7 @@ QQuickStateOperation::QQuickStateOperation(QObjectPrivate &dd, QObject *parent)
/*!
\qmlclass State QQuickState
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Defines configurations of objects and properties
A \e state is a set of batched changes from the default configuration.
@@ -665,7 +665,7 @@ void QQuickState::apply(QQuickTransition *trans, QQuickState *revert)
}
if (!found) {
QVariant cur = d->revertList.at(ii).property().read();
- QQmlAbstractBinding *delBinding =
+ QQmlAbstractBinding *delBinding =
QQmlPropertyPrivate::setBinding(d->revertList.at(ii).property(), 0);
if (delBinding)
delBinding->destroy();
@@ -700,7 +700,7 @@ void QQuickState::apply(QQuickTransition *trans, QQuickState *revert)
qWarning() << " QQuickAction event:" << action.event->type();
else
qWarning() << " QQuickAction:" << action.property.object()
- << action.property.name() << "From:" << action.fromValue
+ << action.property.name() << "From:" << action.fromValue
<< "To:" << action.toValue;
}
}
diff --git a/src/quick/util/qquickstatechangescript.cpp b/src/quick/util/qquickstatechangescript.cpp
index 49db12740c..19bd21f3d4 100644
--- a/src/quick/util/qquickstatechangescript.cpp
+++ b/src/quick/util/qquickstatechangescript.cpp
@@ -70,7 +70,7 @@ public:
/*!
\qmlclass StateChangeScript QQuickStateChangeScript
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Specifies how to run a script in a state
A StateChangeScript is run upon entering a state. You can optionally use
diff --git a/src/quick/util/qquickstategroup.cpp b/src/quick/util/qquickstategroup.cpp
index 6e88ec55aa..2d8ed951fb 100644
--- a/src/quick/util/qquickstategroup.cpp
+++ b/src/quick/util/qquickstategroup.cpp
@@ -94,7 +94,7 @@ public:
/*!
\qmlclass StateGroup QQuickStateGroup
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Provides built-in state support for non-Item elements
Item (and all derived elements) provides built in support for states and transitions
@@ -339,8 +339,8 @@ bool QQuickStateGroupPrivate::updateAutoState()
if (state->isWhenKnown()) {
if (state->isNamed()) {
if (state->when() && state->when()->evaluate().toBool()) {
- if (stateChangeDebug())
- qWarning() << "Setting auto state due to:"
+ if (stateChangeDebug())
+ qWarning() << "Setting auto state due to:"
<< state->when()->expression();
if (currentState != state->name()) {
q->setState(state->name());
@@ -377,7 +377,7 @@ QQuickTransition *QQuickStateGroupPrivate::findTransition(const QString &from, c
for (int ii = 0; ii < 2; ++ii)
{
if (ii && (!t->reversible() ||
- (t->fromState() == QLatin1String("*") &&
+ (t->fromState() == QLatin1String("*") &&
t->toState() == QLatin1String("*"))))
break;
QStringList fromState;
@@ -428,7 +428,7 @@ QQuickTransition *QQuickStateGroupPrivate::findTransition(const QString &from, c
return highest;
}
-void QQuickStateGroupPrivate::setCurrentStateInternal(const QString &state,
+void QQuickStateGroupPrivate::setCurrentStateInternal(const QString &state,
bool ignoreTrans)
{
Q_Q(QQuickStateGroup);
@@ -448,7 +448,7 @@ void QQuickStateGroupPrivate::setCurrentStateInternal(const QString &state,
if (stateChangeDebug()) {
qWarning() << this << "Changing state. From" << currentState << ". To" << state;
if (transition)
- qWarning() << " using transition" << transition->fromState()
+ qWarning() << " using transition" << transition->fromState()
<< transition->toState();
}
diff --git a/src/quick/util/qquicksystempalette.cpp b/src/quick/util/qquicksystempalette.cpp
index cc3a618faf..1cbde6ef5a 100644
--- a/src/quick/util/qquicksystempalette.cpp
+++ b/src/quick/util/qquicksystempalette.cpp
@@ -59,11 +59,11 @@ public:
/*!
\qmlclass SystemPalette QQuickSystemPalette
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-utility
\brief Provides access to the Qt palettes
The SystemPalette element provides access to the Qt application
- palettes. This provides information about the standard colors used
+ palettes. This provides information about the standard colors used
for application windows, buttons and other features. These colors
are grouped into three \e {color groups}: \c Active, \c Inactive,
and \c Disabled. See the QPalette documentation for details about
diff --git a/src/quick/util/qquicktimer.cpp b/src/quick/util/qquicktimer.cpp
index fff3e80202..84ede7b038 100644
--- a/src/quick/util/qquicktimer.cpp
+++ b/src/quick/util/qquicktimer.cpp
@@ -75,7 +75,7 @@ public:
/*!
\qmlclass Timer QQuickTimer
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-utility
\brief Triggers a handler at a specified interval
A Timer can be used to trigger an action either once, or repeatedly
diff --git a/src/quick/util/qquicktransition.cpp b/src/quick/util/qquicktransition.cpp
index 3f56145566..2431642082 100644
--- a/src/quick/util/qquicktransition.cpp
+++ b/src/quick/util/qquicktransition.cpp
@@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Transition QQuickTransition
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-define
\brief Defines animated transitions that occur on state changes
A Transition defines the animations to be applied when a \l State change occurs.