aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/items
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 /src/quick/items
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>
Diffstat (limited to 'src/quick/items')
-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
39 files changed, 85 insertions, 66 deletions
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.