From ca6d49e6b4096f5a9737c6aee04e9b22a781aba2 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Mon, 28 May 2012 19:40:02 +0200 Subject: [PATCH] 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 Reviewed-by: Alan Alpert --- .../folderlistmodel/qquickfolderlistmodel.cpp | 2 +- src/imports/testlib/signalspy.qdoc | 1 + src/imports/testlib/testcase.qdoc | 1 + src/imports/xmllistmodel/qqmlxmllistmodel.cpp | 4 +- src/particles/qquickage.cpp | 1 + src/particles/qquickangledirection.cpp | 1 + src/particles/qquickcumulativedirection.cpp | 1 + src/particles/qquickcustomparticle.cpp | 1 + src/particles/qquickdirection.cpp | 2 + src/particles/qquickellipseextruder.cpp | 1 + src/particles/qquickfriction.cpp | 1 + src/particles/qquickgravity.cpp | 1 + src/particles/qquickgroupgoal.cpp | 1 + src/particles/qquickimageparticle.cpp | 1 + src/particles/qquickitemparticle.cpp | 1 + src/particles/qquicklineextruder.cpp | 1 + src/particles/qquickmaskextruder.cpp | 1 + src/particles/qquickparticleaffector.cpp | 1 + src/particles/qquickparticleemitter.cpp | 1 + src/particles/qquickparticleextruder.cpp | 1 + src/particles/qquickparticlegroup.cpp | 1 + src/particles/qquickparticlepainter.cpp | 1 + src/particles/qquickparticlesystem.cpp | 1 + src/particles/qquickpointattractor.cpp | 1 + src/particles/qquickpointdirection.cpp | 1 + src/particles/qquickrectangleextruder.cpp | 1 + src/particles/qquickspritegoal.cpp | 1 + src/particles/qquicktargetdirection.cpp | 1 + src/particles/qquicktrailemitter.cpp | 1 + src/particles/qquickturbulence.cpp | 1 + src/particles/qquickv8particledata.cpp | 1 + src/particles/qquickwander.cpp | 1 + src/qml/qml/qquicklistmodel.cpp | 4 +- src/quick/doc/qtquick.qdocconf | 5 + src/quick/doc/src/animation-define.qdoc | 29 ++++ src/quick/doc/src/animation.qdoc | 29 +++- src/quick/doc/src/canvaspainting.qdoc | 14 +- src/quick/doc/src/containers.qdoc | 34 ++++ src/quick/doc/src/images.qdoc | 39 +++++ src/quick/doc/src/interaction.qdoc | 35 +++++ src/quick/doc/src/itemgraphics.qdoc | 35 +++++ src/quick/doc/src/models.qdoc | 35 +++++ src/quick/doc/src/modelview.qdoc | 2 +- src/quick/doc/src/particles/particletypes.qdoc | 35 +++++ src/quick/doc/src/paths.qdoc | 35 +++++ src/quick/doc/src/positioners.qdoc | 9 +- src/quick/doc/src/qtquicktypes.qdoc | 174 +++++++++++++++++++++ src/quick/doc/src/shaders.qdoc | 11 +- src/quick/doc/src/sprites.qdoc | 8 +- src/quick/doc/src/states.qdoc | 16 +- src/quick/doc/src/texthandling.qdoc | 71 +++++++++ src/quick/doc/src/transformations.qdoc | 35 +++++ src/quick/doc/src/uicreation.qdoc | 4 +- src/quick/doc/src/utility.qdoc | 35 +++++ src/quick/doc/src/views.qdoc | 35 +++++ src/quick/doc/src/visualtypes.qdoc | 35 +++++ src/quick/items/context2d/qquickcanvasitem.cpp | 4 +- src/quick/items/context2d/qquickcontext2d.cpp | 5 + src/quick/items/qquickaccessibleattached.cpp | 2 +- src/quick/items/qquickanimatedimage.cpp | 2 +- src/quick/items/qquickanimatedsprite.cpp | 1 + src/quick/items/qquickborderimage.cpp | 2 +- src/quick/items/qquickcanvas.cpp | 1 + src/quick/items/qquickdrag.cpp | 1 + src/quick/items/qquickdroparea.cpp | 2 + src/quick/items/qquickevents.cpp | 6 +- src/quick/items/qquickflickable.cpp | 3 +- src/quick/items/qquickflipable.cpp | 4 +- src/quick/items/qquickfocusscope.cpp | 2 +- src/quick/items/qquickgridview.cpp | 2 +- src/quick/items/qquickimage.cpp | 4 +- src/quick/items/qquickitem.cpp | 15 +- src/quick/items/qquickitemanimation.cpp | 4 +- src/quick/items/qquickitemviewtransition.cpp | 2 +- src/quick/items/qquicklistview.cpp | 2 +- src/quick/items/qquickloader.cpp | 2 +- src/quick/items/qquickmousearea.cpp | 2 +- src/quick/items/qquickmultipointtoucharea.cpp | 6 +- src/quick/items/qquickpathview.cpp | 5 +- src/quick/items/qquickpincharea.cpp | 5 +- src/quick/items/qquickpositioners.cpp | 18 +-- src/quick/items/qquickrectangle.cpp | 8 +- src/quick/items/qquickrepeater.cpp | 2 +- src/quick/items/qquickscreen.cpp | 1 + src/quick/items/qquickshadereffect.cpp | 4 +- src/quick/items/qquickshadereffectmesh.cpp | 2 +- src/quick/items/qquickshadereffectsource.cpp | 4 +- src/quick/items/qquicksprite.cpp | 1 + src/quick/items/qquickspritesequence.cpp | 1 + src/quick/items/qquickstateoperations.cpp | 4 +- src/quick/items/qquicktext.cpp | 4 +- src/quick/items/qquicktextedit.cpp | 4 +- src/quick/items/qquicktextinput.cpp | 8 +- src/quick/items/qquickvisualdatamodel.cpp | 4 +- src/quick/items/qquickvisualitemmodel.cpp | 2 +- src/quick/util/qquickanimation.cpp | 22 +-- src/quick/util/qquickanimationcontroller.cpp | 2 +- src/quick/util/qquickbehavior.cpp | 2 +- src/quick/util/qquickbind.cpp | 2 +- src/quick/util/qquickconnections.cpp | 4 +- src/quick/util/qquickfontloader.cpp | 10 +- src/quick/util/qquickpackage.cpp | 20 +-- src/quick/util/qquickpath.cpp | 24 +-- src/quick/util/qquickpathinterpolator.cpp | 1 + src/quick/util/qquickpropertychanges.cpp | 2 +- src/quick/util/qquicksmoothedanimation.cpp | 2 +- src/quick/util/qquickspringanimation.cpp | 2 +- src/quick/util/qquickstate.cpp | 8 +- src/quick/util/qquickstatechangescript.cpp | 2 +- src/quick/util/qquickstategroup.cpp | 12 +- src/quick/util/qquicksystempalette.cpp | 4 +- src/quick/util/qquicktimer.cpp | 2 +- src/quick/util/qquicktransition.cpp | 2 +- 113 files changed, 903 insertions(+), 172 deletions(-) create mode 100644 src/quick/doc/src/animation-define.qdoc create mode 100644 src/quick/doc/src/containers.qdoc create mode 100644 src/quick/doc/src/images.qdoc create mode 100644 src/quick/doc/src/interaction.qdoc create mode 100644 src/quick/doc/src/itemgraphics.qdoc create mode 100644 src/quick/doc/src/models.qdoc create mode 100644 src/quick/doc/src/particles/particletypes.qdoc create mode 100644 src/quick/doc/src/paths.qdoc create mode 100644 src/quick/doc/src/qtquicktypes.qdoc create mode 100644 src/quick/doc/src/texthandling.qdoc create mode 100644 src/quick/doc/src/transformations.qdoc create mode 100644 src/quick/doc/src/utility.qdoc create mode 100644 src/quick/doc/src/views.qdoc create mode 100644 src/quick/doc/src/visualtypes.qdoc diff --git a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp index de3baf1..aad7072 100644 --- a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp +++ b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp @@ -198,7 +198,7 @@ void QQuickFolderListModelPrivate::_q_sortFinished(const QList &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 743c0e2..c294cf2 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 3f47c23..b7f9a10 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 7ae94bb..41e66b0 100644 --- a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp +++ b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp @@ -71,8 +71,8 @@ typedef QPair 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 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 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 ctx2d_imageData_data(v8::Local, 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 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 c07a60b..0f1565c 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 f93dc4a..97e0f0b 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 724ae75..24f3de2 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 015dca5..355a745 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 7b8d916..619b08d 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 7768d73..6f0e677 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 368ba39..5080fcd 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 3053e1e..b0aeeb7 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 d2fa2f1..a60c6e7 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 c2f487c..56dc20f 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 3a8c1aa..52102a4 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 9325184..3315dea 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 d4a3cd5..493bf08 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 15271d5..d184ba0 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 03ada67..c6e87bb 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 d51d792..3411d7a 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 8ee3625..48cdee8 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 843d0c1..5406016 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 30930c3..6626389 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 fa6bb31..f1b4596 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 393f83b..883edec 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 59cfeaa..90885d1 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 b581613..50af097 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 b4156d9..f912d57 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 fdba3aa..8d034e5 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 2c8bf01..c3d32eb 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 0bf119f..a84b3e1 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 1d3f0d7..a0d5897 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 1864acc..7fbab0d 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 25d77d2..1628ed7 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 69daab7..0e7d998 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 6857e3f..c61dc50 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 ae560b9..409f9a9 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 5134376..4b55ff1 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 7589d1c..477cf1c 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 c0277cb..197a60b 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 1cb595e..2cd9106 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 33c24f3..8162aae 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 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 f81b39c..4cfee6d 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 4aa3d17..0de99d4 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 81377bf..bd57efb 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 bbc7a8d..6a20e31 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 e286377..7e5f3de 100644 --- a/src/quick/util/qquickfontloader.cpp +++ b/src/quick/util/qquickfontloader.cpp @@ -148,19 +148,19 @@ QHash 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 ede1c68..059a55e 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 QQuickPackage::data() { Q_D(QQuickPackage); - return QQmlListProperty(this, &d->dataList, QQuickPackagePrivate::data_append, - QQuickPackagePrivate::data_count, - QQuickPackagePrivate::data_at, + return QQmlListProperty(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 cce412a..b1adfe3 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 62bb9c1..1430f72 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 969c326..b51eefc 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 4bc802c..b4986c0 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 1f6e51e..3e0a1ce 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 da4dde5..f6802b1 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 49db127..19bd21f 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 6e88ec5..2d8ed95 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 cc3a618..1cbde6e 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 fff3e80..84ede7b 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 3f56145..2431642 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. -- 2.7.4