aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/items
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@nokia.com>2012-05-18 15:19:55 +0200
committerQt by Nokia <qt-info@nokia.com>2012-05-24 15:41:16 +0200
commit6112c0f57177ee813271da54200a2d9f3ef20238 (patch)
treeb0cb10f46fb8c6b2b13516ab8e0e97c675b506a3 /src/quick/items
parentb13827d77e9a3d64a728036b3804638da62bbe40 (diff)
Doc: Sanitized QML types
-modified \brief -checked QML modules -added qml directory to the qdocconf file -added particles directory to the qdocconf file Change-Id: I589e32d3106cda37c7fa4d55a941afd9876fc2b2 Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>
Diffstat (limited to 'src/quick/items')
-rw-r--r--src/quick/items/context2d/qquickcanvasitem.cpp2
-rw-r--r--src/quick/items/context2d/qquickcontext2d.cpp22
-rw-r--r--src/quick/items/qquickaccessibleattached.cpp2
-rw-r--r--src/quick/items/qquickanimatedimage.cpp1
-rw-r--r--src/quick/items/qquickanimatedsprite.cpp2
-rw-r--r--src/quick/items/qquickborderimage.cpp2
-rw-r--r--src/quick/items/qquickcanvas.cpp2
-rw-r--r--src/quick/items/qquickdrag.cpp2
-rw-r--r--src/quick/items/qquickdroparea.cpp4
-rw-r--r--src/quick/items/qquickevents.cpp6
-rw-r--r--src/quick/items/qquickflickable.cpp2
-rw-r--r--src/quick/items/qquickflipable.cpp2
-rw-r--r--src/quick/items/qquickfocusscope.cpp2
-rw-r--r--src/quick/items/qquickgridview.cpp2
-rw-r--r--src/quick/items/qquickimage.cpp2
-rw-r--r--src/quick/items/qquickitem.cpp24
-rw-r--r--src/quick/items/qquickitemanimation.cpp8
-rw-r--r--src/quick/items/qquickitemviewtransition.cpp2
-rw-r--r--src/quick/items/qquicklistview.cpp2
-rw-r--r--src/quick/items/qquickloader.cpp3
-rw-r--r--src/quick/items/qquickmousearea.cpp2
-rw-r--r--src/quick/items/qquickmultipointtoucharea.cpp4
-rw-r--r--src/quick/items/qquickpathview.cpp2
-rw-r--r--src/quick/items/qquickpincharea.cpp4
-rw-r--r--src/quick/items/qquickpositioners.cpp12
-rw-r--r--src/quick/items/qquickrectangle.cpp8
-rw-r--r--src/quick/items/qquickrepeater.cpp3
-rw-r--r--src/quick/items/qquickshadereffect.cpp2
-rw-r--r--src/quick/items/qquickshadereffectmesh.cpp2
-rw-r--r--src/quick/items/qquickshadereffectsource.cpp3
-rw-r--r--src/quick/items/qquicksprite.cpp2
-rw-r--r--src/quick/items/qquickspritesequence.cpp2
-rw-r--r--src/quick/items/qquickstateoperations.cpp4
-rw-r--r--src/quick/items/qquicktext.cpp2
-rw-r--r--src/quick/items/qquicktextedit.cpp2
-rw-r--r--src/quick/items/qquicktextinput.cpp5
-rw-r--r--src/quick/items/qquickvisualdatamodel.cpp4
-rw-r--r--src/quick/items/qquickvisualitemmodel.cpp2
38 files changed, 83 insertions, 76 deletions
diff --git a/src/quick/items/context2d/qquickcanvasitem.cpp b/src/quick/items/context2d/qquickcanvasitem.cpp
index 41f4ff4d1b..7d2a85cb35 100644
--- a/src/quick/items/context2d/qquickcanvasitem.cpp
+++ b/src/quick/items/context2d/qquickcanvasitem.cpp
@@ -138,7 +138,7 @@ QQuickCanvasItemPrivate::~QQuickCanvasItemPrivate()
\qmlclass Canvas QQuickCanvasItem
\inqmlmodule QtQuick 2
\since QtQuick 2.0
- \brief The Canvas item provides a 2D canvas element which enables drawing via Javascript.
+ \brief For specifying a 2D canvas element which enables drawing via Javascript
\inherits Item
\ingroup qml-basic-visual-elements
diff --git a/src/quick/items/context2d/qquickcontext2d.cpp b/src/quick/items/context2d/qquickcontext2d.cpp
index 0e29492d5b..ec457fa242 100644
--- a/src/quick/items/context2d/qquickcontext2d.cpp
+++ b/src/quick/items/context2d/qquickcontext2d.cpp
@@ -71,8 +71,7 @@ QT_BEGIN_NAMESPACE
\qmlclass Context2D QQuickContext2D
\inqmlmodule QtQuick 2
\since QtQuick 2.0
- \brief The Context2D API allows you to draw 2d graphic shapes on the \c
- Canvas item.
+ \brief Provides 2D context for shapes on a Canvas item
The Context2D object can be created by \c Canvas item's \c getContext()
method:
@@ -2188,10 +2187,11 @@ static v8::Handle<v8::Value> ctx2d_strokeText(const v8::Arguments &args)
return args.This();
}
/*!
- \qmlclass QtQuick2::TextMetrics
+ \qmlclass TextMetrics
\inqmlmodule QtQuick 2
\since QtQuick 2.0
- \brief The Context2D TextMetrics interface.
+ \brief Provides a Context2D TextMetrics interface
+
The TextMetrics object can be created by QtQuick2::Context2D::measureText method.
See {http://www.w3.org/TR/2dcontext/#textmetrics}{W3C 2d context TexMetrics} for more details.
@@ -2380,7 +2380,10 @@ static v8::Handle<v8::Value> ctx2d_drawImage(const v8::Arguments &args)
// pixel manipulation
/*!
- \qmlclass QtQuick2::CanvasImageData
+ \qmlclass CanvasImageData
+ \inqmlmodule QtQuick 2
+ \brief Contains image pixel data in RGBA order
+
The \a QtQuick2::CanvasImageData object holds the image pixel data.
The \a QtQuick2::CanvasImageData object has the actual dimensions of the data stored in
@@ -2429,7 +2432,10 @@ v8::Handle<v8::Value> ctx2d_imageData_data(v8::Local<v8::String>, const v8::Acce
}
/*!
- \qmlclass QtQuick2::CanvasPixelArray
+ \qmlclass CanvasPixelArray
+ \inqmlmodule QtQuick 2
+ \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.
The CanvasPixelArray can be accessed as normal Javascript array.
\sa QtQuick2::CanvasImageData
@@ -2664,10 +2670,10 @@ static v8::Handle<v8::Value> ctx2d_putImageData(const v8::Arguments &args)
}
/*!
- \qmlclass QtQuick2::CanvasGradient
+ \qmlclass CanvasGradient
\inqmlmodule QtQuick 2
\since QtQuick 2.0
- \brief The Context2D opaque CanvasGradient interface.
+ \brief Provides an opaque CanvasGradient interface
*/
/*!
diff --git a/src/quick/items/qquickaccessibleattached.cpp b/src/quick/items/qquickaccessibleattached.cpp
index 27efebca0c..0ab96c184b 100644
--- a/src/quick/items/qquickaccessibleattached.cpp
+++ b/src/quick/items/qquickaccessibleattached.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Accessible QQuickAccessibleAttached
- \brief Attached property to enable accessibility of QML items.
+ \brief Enables accessibility of QML items
\inqmlmodule QtQuick 2
\ingroup qml-basic-interaction-elements
diff --git a/src/quick/items/qquickanimatedimage.cpp b/src/quick/items/qquickanimatedimage.cpp
index 1c1c253513..4fd7b99190 100644
--- a/src/quick/items/qquickanimatedimage.cpp
+++ b/src/quick/items/qquickanimatedimage.cpp
@@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtQuick 2
\inherits Image
\ingroup basic-visual-elements
+ \brief Plays animations stored as a series of 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 8d89c22fa6..0e370202cf 100644
--- a/src/quick/items/qquickanimatedsprite.cpp
+++ b/src/quick/items/qquickanimatedsprite.cpp
@@ -210,7 +210,7 @@ struct AnimatedSpriteVertices {
\qmlclass AnimatedSprite QQuickAnimatedSprite
\inqmlmodule QtQuick 2
\inherits Item
- \brief The AnimatedSprite element draws a sprite animation
+ \brief Draws a sprite animation
AnimatedSprite provides rendering and control over animations which are provided
as multiple frames in the same image file. You can play it at a fixed speed, at the
diff --git a/src/quick/items/qquickborderimage.cpp b/src/quick/items/qquickborderimage.cpp
index 5b48a6fc85..9c3992792e 100644
--- a/src/quick/items/qquickborderimage.cpp
+++ b/src/quick/items/qquickborderimage.cpp
@@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass BorderImage QQuickBorderImage
\inqmlmodule QtQuick 2
- \brief The BorderImage element provides an image that can be used as a border.
+ \brief For specifying an image that can be used as a border
\inherits Item
\ingroup qml-basic-visual-elements
diff --git a/src/quick/items/qquickcanvas.cpp b/src/quick/items/qquickcanvas.cpp
index c3aecce372..b538dba99a 100644
--- a/src/quick/items/qquickcanvas.cpp
+++ b/src/quick/items/qquickcanvas.cpp
@@ -746,7 +746,7 @@ void QQuickCanvasPrivate::cleanup(QSGNode *n)
/*!
\qmlclass Window QQuickCanvas
\inqmlmodule QtQuick.Window 2
- \brief The Window object creates a new top-level window.
+ \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
window for use with QtQuick 2.0 graphical elements.
diff --git a/src/quick/items/qquickdrag.cpp b/src/quick/items/qquickdrag.cpp
index 0aee026533..ca7b716ef2 100644
--- a/src/quick/items/qquickdrag.cpp
+++ b/src/quick/items/qquickdrag.cpp
@@ -92,7 +92,7 @@ public:
/*!
\qmlclass Drag QQuickDrag
\inqmlmodule QtQuick 2
- \brief The Drag attached property provides drag and drop events for moved Items.
+ \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
events within a scene.
diff --git a/src/quick/items/qquickdroparea.cpp b/src/quick/items/qquickdroparea.cpp
index 053a133609..368ba39a98 100644
--- a/src/quick/items/qquickdroparea.cpp
+++ b/src/quick/items/qquickdroparea.cpp
@@ -91,7 +91,7 @@ QQuickDropAreaPrivate::~QQuickDropAreaPrivate()
/*!
\qmlclass DropArea QQuickDropArea
\inqmlmodule QtQuick 2
- \brief The DropArea item provides drag and drop handling.
+ \brief For specifying drag and drop handling in an area
A DropArea is an invisible item which receives events when other items are
dragged over it.
@@ -326,7 +326,7 @@ void QQuickDropArea::dropEvent(QDropEvent *event)
/*!
\qmlclass DragEvent QQuickDragEvent
\inqmlmodule QtQuick 2
- \brief The DragEvent object provides information about a drag event.
+ \brief Provides information about a drag event
The position of the drag event can be obtained from the \l x and \l y
properties, and the \l keys property identifies the drag keys of the event
diff --git a/src/quick/items/qquickevents.cpp b/src/quick/items/qquickevents.cpp
index bf58e4411d..3053e1e280 100644
--- a/src/quick/items/qquickevents.cpp
+++ b/src/quick/items/qquickevents.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtQuick 2
\ingroup qml-event-elements
- \brief The KeyEvent object provides information about a key event.
+ \brief Provides information about a key event
For example, the following changes the Item's state property when the Enter
key is pressed:
@@ -143,7 +143,7 @@ Item {
\inqmlmodule QtQuick 2
\ingroup qml-event-elements
- \brief The MouseEvent object provides information about a mouse event.
+ \brief Provides information about a mouse event
The position of the mouse can be found via the \l x and \l y properties.
The button that caused the event is available via the \l button property.
@@ -241,7 +241,7 @@ Item {
\inqmlmodule QtQuick 2
\ingroup qml-event-elements
- \brief The WheelEvent object provides information about a mouse wheel event.
+ \brief Provides information about a mouse wheel event
The position of the mouse can be found via the \l x and \l y properties.
diff --git a/src/quick/items/qquickflickable.cpp b/src/quick/items/qquickflickable.cpp
index e4e0799d89..ba61ca4972 100644
--- a/src/quick/items/qquickflickable.cpp
+++ b/src/quick/items/qquickflickable.cpp
@@ -506,7 +506,7 @@ is finished.
\inqmlmodule QtQuick 2
\ingroup qml-basic-interaction-elements
- \brief The Flickable item provides a surface that can be "flicked".
+ \brief For specifying a surface that can be "flicked"
\inherits Item
The Flickable item places its children on a surface that can be dragged
diff --git a/src/quick/items/qquickflipable.cpp b/src/quick/items/qquickflipable.cpp
index 39e5765a7a..0231e84cf7 100644
--- a/src/quick/items/qquickflipable.cpp
+++ b/src/quick/items/qquickflipable.cpp
@@ -91,7 +91,7 @@ public:
\qmlclass Flipable QQuickFlipable
\inqmlmodule QtQuick 2
\ingroup qml-basic-interaction-elements
- \brief The Flipable item provides a surface that can be flipped.
+ \brief For specifying a surface that can be flipped
\inherits Item
Flipable is an item that can be visibly "flipped" between its front and
diff --git a/src/quick/items/qquickfocusscope.cpp b/src/quick/items/qquickfocusscope.cpp
index 7ef2476b30..3a8c1aaae1 100644
--- a/src/quick/items/qquickfocusscope.cpp
+++ b/src/quick/items/qquickfocusscope.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtQuick 2
\ingroup qml-basic-interaction-elements
- \brief The FocusScope object explicitly creates a focus scope.
+ \brief Explicitly creates a focus scope
\inherits Item
Focus scopes assist in keyboard focus handling when building reusable QML
diff --git a/src/quick/items/qquickgridview.cpp b/src/quick/items/qquickgridview.cpp
index 1be285bcf6..d7fa0ed5d4 100644
--- a/src/quick/items/qquickgridview.cpp
+++ b/src/quick/items/qquickgridview.cpp
@@ -1153,7 +1153,7 @@ void QQuickGridViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte
\ingroup qml-view-elements
\inherits Flickable
- \brief The GridView item provides a grid view of items provided by a model.
+ \brief For specifying a grid view of items provided by a model
A GridView 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/qquickimage.cpp b/src/quick/items/qquickimage.cpp
index cc4a95ddde..8331d14d0a 100644
--- a/src/quick/items/qquickimage.cpp
+++ b/src/quick/items/qquickimage.cpp
@@ -99,7 +99,7 @@ QQuickImagePrivate::QQuickImagePrivate()
\qmlclass Image QQuickImage
\inqmlmodule QtQuick 2
\ingroup qml-basic-visual-elements
- \brief The Image element displays an image in a declarative user interface
+ \brief Displays an image in a declarative user interface
\inherits Item
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 e83fee3583..47bfc98b13 100644
--- a/src/quick/items/qquickitem.cpp
+++ b/src/quick/items/qquickitem.cpp
@@ -130,7 +130,7 @@ void QQuickItemPrivate::registerAccessorProperties()
\qmlclass Transform QQuickTransform
\inqmlmodule QtQuick 2
\ingroup qml-transform-elements
- \brief The Transform elements provide a way of building advanced transformations on Items.
+ \brief For specifying advanced transformations on Items
The Transform element is a base type which cannot be instantiated directly.
The following concrete Transform types are available:
@@ -152,7 +152,7 @@ void QQuickItemPrivate::registerAccessorProperties()
\qmlclass Translate QQuickTranslate
\inqmlmodule QtQuick 2
\ingroup qml-transform-elements
- \brief The Translate object provides a way to move an Item without changing its x or y properties.
+ \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.
@@ -194,7 +194,7 @@ void QQuickItemPrivate::registerAccessorProperties()
\qmlclass Scale QQuickScale
\inqmlmodule QtQuick 2
\ingroup qml-transform-elements
- \brief The Scale element provides a way to scale an Item.
+ \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,
it allows a different scale for the x and y axes, and allows the scale to be relative to an
@@ -236,7 +236,7 @@ void QQuickItemPrivate::registerAccessorProperties()
\qmlclass Rotation QQuickRotation
\inqmlmodule QtQuick 2
\ingroup qml-transform-elements
- \brief The Rotation object provides a way to rotate an Item.
+ \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.
Specifically, it allows (z axis) rotation to be relative to an arbitrary point.
@@ -504,7 +504,7 @@ void QQuickItemKeyFilter::componentComplete()
\qmlclass KeyNavigation QQuickKeyNavigationAttached
\inqmlmodule QtQuick 2
\ingroup qml-basic-interaction-elements
- \brief The KeyNavigation attached property supports key navigation by arrow keys.
+ \brief Supports key navigation by arrow keys
Key-based user interfaces commonly allow the use of arrow keys to navigate between
focusable items. The KeyNavigation attached property enables this behavior by providing a
@@ -920,7 +920,7 @@ bool QQuickKeysAttached::isConnected(const char *signalName)
\qmlclass Keys QQuickKeysAttached
\inqmlmodule QtQuick 2
\ingroup qml-basic-interaction-elements
- \brief The Keys attached property provides key handling to Items.
+ \brief Provides key handling to Items
All visual primitives support key handling via the Keys
attached property. Keys can be handled via the onPressed
@@ -1466,7 +1466,7 @@ QQuickKeysAttached *QQuickKeysAttached::qmlAttachedProperties(QObject *obj)
\qmlclass LayoutMirroring QQuickLayoutMirroringAttached
\inqmlmodule QtQuick 2
\ingroup qml-utility-elements
- \brief The LayoutMirroring attached property is used to mirror layout behavior.
+ \brief Property used to mirror layout behavior
The LayoutMirroring attached property is used to horizontally mirror \l {anchor-layout}{Item anchors},
\l{Using QML Positioner and Repeater Items}{positioner} elements (such as \l Row and \l Grid)
@@ -1674,7 +1674,7 @@ void QQuickItemPrivate::updateSubFocusItem(QQuickItem *scope, bool focus)
/*!
\class QQuickItem
- \brief The QQuickItem class provides the most basic of all visual items in QML.
+ \brief Provides the most basic of all visual items in QML
\inmodule QtQuick
@@ -1724,7 +1724,7 @@ void QQuickItemPrivate::updateSubFocusItem(QQuickItem *scope, bool focus)
\inherits QtObject
\inqmlmodule QtQuick 2
\ingroup qml-basic-visual-elements
- \brief The Item is the most basic of all visual items in QML.
+ \brief A basic visual QML type
All visual items in Qt Quick inherit from Item. Although Item
has no visual appearance, it defines all the properties that are
@@ -2742,7 +2742,7 @@ void QQuickItemPrivate::transform_clear(QQmlListProperty<QQuickTransform> *prop)
/*!
\property QQuickItem::childrenRect
- \brief The geometry of an item's children.
+ \brief Specifies the geometry of an item's children
This property holds the (collective) position and size of the item's children.
*/
@@ -2961,7 +2961,7 @@ void QQuickItemPrivate::transform_clear(QQmlListProperty<QQuickTransform> *prop)
/*!
\property QQuickItem::baselineOffset
- \brief The position of the item's baseline in local coordinates.
+ \brief Speciifies the position of the item's baseline in local coordinates
The baseline of a \l Text item is the imaginary line on which the text
sits. Controls containing text usually set their baseline to the
@@ -4468,7 +4468,7 @@ void QQuickItemPrivate::itemChange(QQuickItem::ItemChange change, const QQuickIt
/*!
\property QQuickItem::smooth
- \brief whether the item is smoothed or not.
+ \brief Specifies whether the item is smoothed or not
Primarily used in image based elements to decide if the item should use smooth
sampling or not. Smooth sampling is performed using linear interpolation, while
diff --git a/src/quick/items/qquickitemanimation.cpp b/src/quick/items/qquickitemanimation.cpp
index dec8e1151e..35a46eee96 100644
--- a/src/quick/items/qquickitemanimation.cpp
+++ b/src/quick/items/qquickitemanimation.cpp
@@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE
\ingroup qml-animation-transition
\since QtQuick 2.0
\inherits Animation
- \brief The ParentAnimation element animates changes in parent values.
+ \brief Animates changes in parent values
ParentAnimation is used to animate a parent change for an \l Item.
@@ -418,7 +418,7 @@ QAbstractAnimationJob* QQuickParentAnimation::transition(QQuickStateActions &act
\inqmlmodule QtQuick 2
\ingroup qml-animation-transition
\inherits Animation
- \brief The AnchorAnimation element animates changes in anchor values.
+ \brief Animates changes in anchor values
AnchorAnimation is used to animate an anchor change.
@@ -491,7 +491,7 @@ void QQuickAnchorAnimation::setDuration(int duration)
\qmlproperty real QtQuick2::AnchorAnimation::easing.amplitude
\qmlproperty real QtQuick2::AnchorAnimation::easing.overshoot
\qmlproperty real QtQuick2::AnchorAnimation::easing.period
- \brief the easing curve used for the animation.
+ \brief Specifies the easing curve used for the animation
To specify an easing curve you need to specify at least the type. For some curves you can also specify
amplitude, period and/or overshoot. The default easing curve is
@@ -562,7 +562,7 @@ QAbstractAnimationJob* QQuickAnchorAnimation::transition(QQuickStateActions &act
\ingroup qml-animation-transition
\inherits Animation
\since QtQuick 2.0
- \brief The PathAnimation element animates an item along a path.
+ \brief Animates an item along a path
When used in a transition, the path can be specified without start
or end points, for example:
diff --git a/src/quick/items/qquickitemviewtransition.cpp b/src/quick/items/qquickitemviewtransition.cpp
index 954a0f6dfa..aec4de43b6 100644
--- a/src/quick/items/qquickitemviewtransition.cpp
+++ b/src/quick/items/qquickitemviewtransition.cpp
@@ -569,7 +569,7 @@ QQuickViewTransitionAttached::QQuickViewTransitionAttached(QObject *parent)
\qmlclass ViewTransition QQuickViewTransitionAttached
\inqmlmodule QtQuick 2
\ingroup qml-view-elements
- \brief The ViewTransition attached property provides details on items under transition in a view.
+ \brief Specifies items under transition in a view
With ListView and GridView, it is possible to specify transitions that should be applied whenever
the items in the view change as a result of modifications to the view's model. They both have the
diff --git a/src/quick/items/qquicklistview.cpp b/src/quick/items/qquicklistview.cpp
index a7f267a969..09abd63830 100644
--- a/src/quick/items/qquicklistview.cpp
+++ b/src/quick/items/qquicklistview.cpp
@@ -1645,7 +1645,7 @@ void QQuickListViewPrivate::flick(AxisData &data, qreal minExtent, qreal maxExte
\inqmlmodule QtQuick 2
\ingroup qml-view-elements
\inherits Flickable
- \brief The ListView item provides a list view of items provided by a model.
+ \brief Provides a list view of items provided by a model
A ListView 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/qquickloader.cpp b/src/quick/items/qquickloader.cpp
index fdc3db9fb7..2cde9effdc 100644
--- a/src/quick/items/qquickloader.cpp
+++ b/src/quick/items/qquickloader.cpp
@@ -158,8 +158,7 @@ qreal QQuickLoaderPrivate::getImplicitHeight() const
\ingroup qml-utility-elements
\inherits Item
- \brief The Loader item allows dynamically loading an Item-based
- subtree from a URL or Component.
+ \brief Allows dynamical loading of an item-based subtree from a URL or Component
Loader is used to dynamically load visual QML components. For loading non-visual
components, see \l {Dynamic Object Management in QML}.
diff --git a/src/quick/items/qquickmousearea.cpp b/src/quick/items/qquickmousearea.cpp
index 1d768a531a..0ef19633df 100644
--- a/src/quick/items/qquickmousearea.cpp
+++ b/src/quick/items/qquickmousearea.cpp
@@ -312,7 +312,7 @@ bool QQuickMouseAreaPrivate::propagateHelper(QQuickMouseEvent *ev, QQuickItem *i
\qmlclass MouseArea QQuickMouseArea
\inqmlmodule QtQuick 2
\ingroup qml-basic-interaction-elements
- \brief The MouseArea item enables simple mouse handling.
+ \brief Enables simple mouse handling
\inherits Item
A MouseArea is an invisible item that is typically used in conjunction with
diff --git a/src/quick/items/qquickmultipointtoucharea.cpp b/src/quick/items/qquickmultipointtoucharea.cpp
index b35ca83423..369a0691ba 100644
--- a/src/quick/items/qquickmultipointtoucharea.cpp
+++ b/src/quick/items/qquickmultipointtoucharea.cpp
@@ -56,7 +56,7 @@ DEFINE_BOOL_CONFIG_OPTION(qmlVisualTouchDebugging, QML_VISUAL_TOUCH_DEBUGGING)
\qmlclass TouchPoint QQuickTouchPoint
\inqmlmodule QtQuick 2
\ingroup qml-event-elements
- \brief The TouchPoint element describes a touch point in a MultiPointTouchArea.
+ \brief Describes a touch point in a MultiPointTouchArea
The TouchPoint element contains information about a touch point, such as the current
position, pressure, and area.
@@ -224,7 +224,7 @@ void QQuickTouchPoint::setSceneY(qreal sceneY)
/*!
\qmlclass MultiPointTouchArea QQuickMultiPointTouchArea
\inqmlmodule QtQuick 2
- \brief The MultiPointTouchArea item enables handling of multiple touch points.
+ \brief Enables handling of multiple touch points
\inherits Item
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 18c8cee349..fa281cb245 100644
--- a/src/quick/items/qquickpathview.cpp
+++ b/src/quick/items/qquickpathview.cpp
@@ -441,7 +441,7 @@ void QQuickPathViewPrivate::regenerate()
\qmlclass PathView QQuickPathView
\inqmlmodule QtQuick 2
\ingroup qml-view-elements
- \brief The PathView element lays out model-provided items on a path.
+ \brief Lays out model-provided items on a path
\inherits Item
A PathView displays data from models created from built-in QML elements like ListModel
diff --git a/src/quick/items/qquickpincharea.cpp b/src/quick/items/qquickpincharea.cpp
index ba0a429c87..59cfeaaad1 100644
--- a/src/quick/items/qquickpincharea.cpp
+++ b/src/quick/items/qquickpincharea.cpp
@@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE
\qmlclass PinchEvent QQuickPinchEvent
\inqmlmodule QtQuick 2
\ingroup qml-event-elements
- \brief The PinchEvent object provides information about a pinch event.
+ \brief For specifying information about a pinch event
\b {The PinchEvent element was added in QtQuick 1.1}
@@ -163,7 +163,7 @@ QQuickPinchAreaPrivate::~QQuickPinchAreaPrivate()
/*!
\qmlclass PinchArea QQuickPinchArea
\inqmlmodule QtQuick 2
- \brief The PinchArea item enables simple pinch gesture handling.
+ \brief Enables simple pinch gesture handling
\inherits Item
\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 a51cb86c29..52450b181d 100644
--- a/src/quick/items/qquickpositioners.cpp
+++ b/src/quick/items/qquickpositioners.cpp
@@ -135,7 +135,7 @@ QQuickBasePositioner::QQuickBasePositioner(PositionerType at, QQuickItem *parent
/*!
\internal
\class QQuickBasePositioner
- \brief The QQuickBasePositioner class provides a base for QQuickGraphics layouts.
+ \brief For specifying a base for QQuickGraphics layouts
To create a QQuickGraphics Positioner, simply subclass QQuickBasePositioner and implement
doLayout(), which is automatically called when the layout might need
@@ -496,7 +496,7 @@ void QQuickBasePositioner::updateAttachedProperties(QQuickPositionerAttached *sp
\qmlclass Positioner QQuickPositionerAttached
\inqmlmodule QtQuick 2
\ingroup qml-positioning-elements
- \brief The Positioner type provides attached properties that contain details on where an item exists in a positioner.
+ \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
Column, Row, Flow or Grid. It provides properties that allow a child item to determine
@@ -578,7 +578,7 @@ void QQuickPositionerAttached::setIsLastItem(bool isLastItem)
\qmlclass Column QQuickColumn
\inqmlmodule QtQuick 2
\ingroup qml-positioning-elements
- \brief The Column element positions its children in a column.
+ \brief Positions its children in a column
\inherits Item
Column is an element that positions its child items along a single column.
@@ -746,7 +746,7 @@ void QQuickColumn::reportConflictingAnchors()
\qmlclass Row QQuickRow
\inqmlmodule QtQuick 2
\ingroup qml-positioning-elements
- \brief The Row element positions its children in a row.
+ \brief Positions its children in a row
\inherits Item
Row is an element that positions its child items along a single row.
@@ -977,7 +977,7 @@ void QQuickRow::reportConflictingAnchors()
\qmlclass Grid QQuickGrid
\inqmlmodule QtQuick 2
\ingroup qml-positioning-elements
- \brief The Grid element positions its children in grid formation.
+ \brief Positions its children in grid formation
\inherits Item
Grid is an element that positions its child items in grid formation.
@@ -1418,7 +1418,7 @@ void QQuickGrid::reportConflictingAnchors()
\qmlclass Flow QQuickFlow
\inqmlmodule QtQuick 2
\ingroup qml-positioning-elements
- \brief The Flow element positions its children side by side, wrapping as necessary.
+ \brief Positions its children side by side, wrapping as necessary
\inherits Item
The Flow item positions its child items like words on a page, wrapping them
diff --git a/src/quick/items/qquickrectangle.cpp b/src/quick/items/qquickrectangle.cpp
index a3948f1041..b5a03e88af 100644
--- a/src/quick/items/qquickrectangle.cpp
+++ b/src/quick/items/qquickrectangle.cpp
@@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE
/*!
\internal
\class QQuickPen
- \brief The QQuickPen class provides a pen used for drawing rectangle borders on a QQuickView.
+ \brief For specifying a pen used for drawing rectangle borders on a QQuickView
By default, the pen is invalid and nothing is drawn. You must either set a color (then the default
width is 1) or a width (then the default color is black).
@@ -130,7 +130,7 @@ bool QQuickPen::isValid() const
\qmlclass GradientStop QQuickGradientStop
\inqmlmodule QtQuick 2
\ingroup qml-basic-visual-elements
- \brief The GradientStop item defines the color at a position in a Gradient.
+ \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
- \brief The Gradient item defines a gradient fill.
+ \brief Defines a gradient fill
A gradient is defined by two or more colors, which will be blended seamlessly.
@@ -280,7 +280,7 @@ int QQuickRectanglePrivate::doUpdateSlotIdx = -1;
\qmlclass Rectangle QQuickRectangle
\inqmlmodule QtQuick 2
\ingroup qml-basic-visual-elements
- \brief The Rectangle item provides a filled rectangle with an optional border.
+ \brief Describes a filled rectangle with an optional border
\inherits Item
Rectangle items are used to fill areas with solid color or gradients, and are
diff --git a/src/quick/items/qquickrepeater.cpp b/src/quick/items/qquickrepeater.cpp
index 97ab386841..ec8dc9d231 100644
--- a/src/quick/items/qquickrepeater.cpp
+++ b/src/quick/items/qquickrepeater.cpp
@@ -66,8 +66,7 @@ QQuickRepeaterPrivate::~QQuickRepeaterPrivate()
\inqmlmodule QtQuick 2
\ingroup qml-utility-elements
\inherits Item
-
- \brief The Repeater element allows you to repeat an Item-based component using a model.
+ \brief Specifies how to repeately create an Item-based component using a model
The Repeater element is used to create a large number of
similar items. Like other view elements, a Repeater has a \l model and a \l delegate:
diff --git a/src/quick/items/qquickshadereffect.cpp b/src/quick/items/qquickshadereffect.cpp
index 952ecef75f..0bf119f28e 100644
--- a/src/quick/items/qquickshadereffect.cpp
+++ b/src/quick/items/qquickshadereffect.cpp
@@ -534,7 +534,7 @@ void QQuickShaderEffectCommon::propertyChanged(QQuickItem *item, int mappedId,
\qmlclass ShaderEffect QQuickShaderEffect
\inqmlmodule QtQuick 2
\ingroup qml-basic-visual-elements
- \brief The ShaderEffect element applies custom shaders to a rectangle.
+ \brief Applies custom shaders to a rectangle
\inherits Item
The ShaderEffect element applies a custom OpenGL
diff --git a/src/quick/items/qquickshadereffectmesh.cpp b/src/quick/items/qquickshadereffectmesh.cpp
index 582e1ce92f..1d3f0d7bc2 100644
--- a/src/quick/items/qquickshadereffectmesh.cpp
+++ b/src/quick/items/qquickshadereffectmesh.cpp
@@ -54,7 +54,7 @@ QQuickShaderEffectMesh::QQuickShaderEffectMesh(QObject *parent)
\qmlclass GridMesh QQuickGridMesh
\inqmlmodule QtQuick 2
\ingroup qml-utility-elements
- \brief GridMesh defines a mesh with vertices arranged in a grid.
+ \brief Defines a mesh with vertices arranged in a grid
GridMesh defines a rectangular mesh consisting of vertices arranged in an
evenly spaced grid. It is used to generate \l{QSGGeometry}{geometry}.
diff --git a/src/quick/items/qquickshadereffectsource.cpp b/src/quick/items/qquickshadereffectsource.cpp
index 4513263ed3..1864acc2da 100644
--- a/src/quick/items/qquickshadereffectsource.cpp
+++ b/src/quick/items/qquickshadereffectsource.cpp
@@ -456,8 +456,7 @@ QImage QQuickShaderEffectTexture::toImage() const
\qmlclass ShaderEffectSource QQuickShaderEffectSource
\since 5.0
\ingroup qml-basic-visual-elements
- \brief The ShaderEffectSource element renders a QML element into a texture
- and displays it.
+ \brief Renders a QML element into a texture and displays it
\inherits Item
The ShaderEffectSource element renders \l sourceItem into a texture and
diff --git a/src/quick/items/qquicksprite.cpp b/src/quick/items/qquicksprite.cpp
index 8b77d23270..25d77d2e29 100644
--- a/src/quick/items/qquicksprite.cpp
+++ b/src/quick/items/qquicksprite.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlclass Sprite QQuickSprite
\inqmlmodule QtQuick 2
- \brief The Sprite element represents a sprite animation
+ \brief Specifies sprite animations
QQuickSprite renders sprites of one or more frames and animates them. The sprites
can be in the middle of an image file, or split along multiple rows, as long as they form
diff --git a/src/quick/items/qquickspritesequence.cpp b/src/quick/items/qquickspritesequence.cpp
index 28849ac82c..1e31735b0d 100644
--- a/src/quick/items/qquickspritesequence.cpp
+++ b/src/quick/items/qquickspritesequence.cpp
@@ -209,7 +209,7 @@ struct SpriteVertices {
\qmlclass SpriteSequence QQuickSpriteSequence
\inqmlmodule QtQuick 2
\inherits Item
- \brief The SpriteSequence element draws a sprite animation
+ \brief Draws a sprite animation
SpriteSequence renders and controls a list of animations defined
by \l Sprite elements.
diff --git a/src/quick/items/qquickstateoperations.cpp b/src/quick/items/qquickstateoperations.cpp
index 1985da8deb..b6b055c359 100644
--- a/src/quick/items/qquickstateoperations.cpp
+++ b/src/quick/items/qquickstateoperations.cpp
@@ -150,7 +150,7 @@ void QQuickParentChangePrivate::doChange(QQuickItem *targetParent, QQuickItem *s
\qmlclass ParentChange QQuickParentChange
\inqmlmodule QtQuick 2
\ingroup qml-state-elements
- \brief The ParentChange element allows you to reparent an Item in a state change.
+ \brief Specifies how to reparent an Item in a state change
ParentChange reparents an item while preserving its visual appearance (position, size,
rotation, and scale) on screen. You can then specify a transition to move/resize/rotate/scale
@@ -561,7 +561,7 @@ void QQuickParentChange::rewind()
\qmlclass AnchorChanges QQuickAnchorChanges
\inqmlmodule QtQuick 2
\ingroup qml-state-elements
- \brief The AnchorChanges element allows you to change the anchors of an item in a state.
+ \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 b61d329e5f..642409e84a 100644
--- a/src/quick/items/qquicktext.cpp
+++ b/src/quick/items/qquicktext.cpp
@@ -1140,7 +1140,7 @@ void QQuickTextPrivate::ensureDoc()
\qmlclass Text QQuickText
\inqmlmodule QtQuick 2
\ingroup qml-basic-visual-elements
- \brief The Text item allows you to add formatted text to a scene.
+ \brief Specifies how to add formatted text to a scene
\inherits Item
Text items can display both plain and rich text. For example, red text with
diff --git a/src/quick/items/qquicktextedit.cpp b/src/quick/items/qquicktextedit.cpp
index a3dd772718..de5cff217d 100644
--- a/src/quick/items/qquicktextedit.cpp
+++ b/src/quick/items/qquicktextedit.cpp
@@ -68,7 +68,7 @@ QT_BEGIN_NAMESPACE
\qmlclass TextEdit QQuickTextEdit
\inqmlmodule QtQuick 2
\ingroup qml-basic-visual-elements
- \brief The TextEdit item displays multiple lines of editable formatted text.
+ \brief Displays multiple lines of editable formatted text
\inherits Item
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 3e92568db3..06a572681a 100644
--- a/src/quick/items/qquicktextinput.cpp
+++ b/src/quick/items/qquicktextinput.cpp
@@ -69,8 +69,8 @@ DEFINE_BOOL_CONFIG_OPTION(qmlDisableDistanceField, QML_DISABLE_DISTANCEFIELD)
\qmlclass TextInput QQuickTextInput
\inqmlmodule QtQuick 2
\ingroup qml-basic-visual-elements
- \brief The TextInput item displays an editable line of text.
\inherits Item
+ \brief Displays an editable line of text
The TextInput element displays a single line of editable plain text.
@@ -845,6 +845,7 @@ void QQuickTextInput::setAutoScroll(bool b)
\qmlclass IntValidator QIntValidator
\inqmlmodule QtQuick 2
\ingroup qml-basic-visual-elements
+ \brief Defines a validator for integer values
This element provides a validator for integer values.
@@ -907,6 +908,7 @@ void QQuickIntValidator::resetLocaleName()
\qmlclass DoubleValidator QDoubleValidator
\inqmlmodule QtQuick 2
\ingroup qml-basic-visual-elements
+ \brief Defines a validator for non-integer numbers
This element provides a validator for non-integer numbers.
@@ -999,6 +1001,7 @@ void QQuickDoubleValidator::resetLocaleName()
\qmlclass RegExpValidator QRegExpValidator
\inqmlmodule QtQuick 2
\ingroup qml-basic-visual-elements
+ \brief Provides a string validator
This element provides a validator, which counts as valid any string which
matches a specified regular expression.
diff --git a/src/quick/items/qquickvisualdatamodel.cpp b/src/quick/items/qquickvisualdatamodel.cpp
index d202c61112..0b0dbf0afb 100644
--- a/src/quick/items/qquickvisualdatamodel.cpp
+++ b/src/quick/items/qquickvisualdatamodel.cpp
@@ -81,7 +81,7 @@ QQuickVisualDataModelParts::QQuickVisualDataModelParts(QQuickVisualDataModel *pa
\qmlclass VisualDataModel QQuickVisualDataModel
\inqmlmodule QtQuick 2
\ingroup qml-working-with-data
- \brief The VisualDataModel encapsulates a model and delegate
+ \brief Encapsulates a model and delegate
A VisualDataModel encapsulates a model and the delegate that will
be instantiated for items in the model.
@@ -2026,7 +2026,7 @@ void QQuickVisualDataGroupPrivate::destroyingPackage(QQuickPackage *package)
\qmlclass VisualDataGroup QQuickVisualDataGroup
\inqmlmodule QtQuick 2
\ingroup qml-working-with-data
- \brief The VisualDataGroup encapsulates a filtered set of visual data items.
+ \brief Encapsulates a filtered set of visual data items
*/
diff --git a/src/quick/items/qquickvisualitemmodel.cpp b/src/quick/items/qquickvisualitemmodel.cpp
index b1fce55d7d..df274e1d42 100644
--- a/src/quick/items/qquickvisualitemmodel.cpp
+++ b/src/quick/items/qquickvisualitemmodel.cpp
@@ -120,7 +120,7 @@ public:
\qmlclass VisualItemModel QQuickVisualItemModel
\inqmlmodule QtQuick 2
\ingroup qml-working-with-data
- \brief The VisualItemModel allows items to be provided to a view.
+ \brief Defines items to be used added to a view
A VisualItemModel contains the visual items to be used in a view.
When a VisualItemModel is used in a view, the view does not require