diff options
Diffstat (limited to 'src/quick/doc/src')
10 files changed, 22 insertions, 57 deletions
diff --git a/src/quick/doc/src/concepts/effects/sprites.qdoc b/src/quick/doc/src/concepts/effects/sprites.qdoc index edad89b1e5..62d9ea0811 100644 --- a/src/quick/doc/src/concepts/effects/sprites.qdoc +++ b/src/quick/doc/src/concepts/effects/sprites.qdoc @@ -26,13 +26,10 @@ ****************************************************************************/ /*! -\ingroup qtquick-images-sprites \page qtquick-effects-sprites.html \title Sprite Animations \brief Sprite-based animations with flexible transitioning -\generatelist{related} - \section1 Sprite Engine The \l {Qt Quick} sprite engine is a stochastic state machine combined with the ability @@ -167,9 +164,9 @@ Additionally, \l ImageParticle can use \l Sprite types to define sprites for eac sprite engine per type. This works similarly to SpriteSequence, but it also has the parametrized variability provided by the \l ImageParticle type. -\section1 AnimatedSprite +\section1 AnimatedSprite Type -For use-cases which do not need to transition between animations, consider the \l AnimatedSprite type. +For use-cases which do not need to transition between animations, consider the AnimatedSprite type. This type displays sprite animations with the same input format, but only one at a time. It also provides more fine-grained manual control, as there is no sprite engine managing the timing and transitions behind the scenes. diff --git a/src/quick/doc/src/concepts/effects/transformations.qdoc b/src/quick/doc/src/concepts/effects/transformations.qdoc index a5c7b9c208..cfe9d420fa 100644 --- a/src/quick/doc/src/concepts/effects/transformations.qdoc +++ b/src/quick/doc/src/concepts/effects/transformations.qdoc @@ -31,8 +31,6 @@ \title Qt Quick Transformation Types \brief Types for applying transformations to visual types -\generatelist{related} - Transformations are applied to child hierarchies and also will also transform mouse and touch input so coordinates in event handlers behave as expected. diff --git a/src/quick/doc/src/concepts/input/textinput.qdoc b/src/quick/doc/src/concepts/input/textinput.qdoc index 3965c246da..41508caad6 100644 --- a/src/quick/doc/src/concepts/input/textinput.qdoc +++ b/src/quick/doc/src/concepts/input/textinput.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! -\ingroup qtquick-text \page qtquick-input-textinput.html \title Qt Quick Text Input Handling and Validators \brief Text input and validation @@ -38,8 +37,6 @@ type will display formatted text onto the screen, the \l TextEdit type will place a multiline line edit onto the screen, and the \l TextInput will place a single editable line field onto the screen. -\generatelist{related} - To learn more about their specific features and properties, visit their respective documentation. @@ -63,11 +60,11 @@ Note that QML parses JavaScript regular expressions, while Qt's */ /*! +\page qtquick-text-validator.html \ingroup qtquick-text-validator \title Qt Quick Text Validators \brief Types that validate text input -The \l{qtquick-concepts-input-text.html} -{Qt Quick Text Input Handling and Validators} page has information about +The \l {Qt Quick Text Input Handling and Validators} page has information about validating user text input. */ diff --git a/src/quick/doc/src/concepts/modelviewsdata/modelview.qdoc b/src/quick/doc/src/concepts/modelviewsdata/modelview.qdoc index e03b3a9bf8..324fc9750f 100644 --- a/src/quick/doc/src/concepts/modelviewsdata/modelview.qdoc +++ b/src/quick/doc/src/concepts/modelviewsdata/modelview.qdoc @@ -57,7 +57,7 @@ To visualize data, bind the view's \c model property to a model and the Views are containers for collections of items. They are feature-rich and can be customizable to meet style or behavior requirements. - \keyword qtquick-views + \target qtquick-views A set of standard views are provided in the basic set of Qt Quick graphical types: @@ -124,7 +124,7 @@ To visualize data, bind the view's \c model property to a model and the \snippet qml/listview-sections.qml section \image listview-section.png -\keyword qml-view-delegate +\target qml-view-delegate \section1 View Delegates Views need a \e delegate to visually represent an item in a list. A view will @@ -154,7 +154,7 @@ To visualize data, bind the view's \c model property to a model and the \snippet qml/models/views-models-delegates.qml rectangle -\keyword qml-data-models +\target qml-data-models \section1 Models Data is provided to the delegate via named data roles which the delegate may @@ -320,7 +320,7 @@ To visualize data, bind the view's \c model property to a model and the } \endqml - \keyword qml-c++-models + \target qml-c++-models \section2 C++ Data Models Models can be defined in C++ and then made available to QML. This mechanism @@ -371,13 +371,12 @@ or removed from a positioner. Transitions for adding items apply to items that are created as part of a positioner, as well as those that are reparented to become children of a positioner. + Transitions for removing items apply to items within a positioner that are deleted, as well as those that are removed from a positioner and given new parents in a document. -Additionally, changing the opacity of items to zero will cause them to -disappear using the remove transition, and making the opacity non-zero will -cause them to appear using the add transition. - - +\note Changing the opacity of items to zero will not cause them to +disappear from the positioner. They can be removed and re-added by changing +the visible property. */ diff --git a/src/quick/doc/src/concepts/positioning/anchors.qdoc b/src/quick/doc/src/concepts/positioning/anchors.qdoc index 71af38b587..259dcbe671 100644 --- a/src/quick/doc/src/concepts/positioning/anchors.qdoc +++ b/src/quick/doc/src/concepts/positioning/anchors.qdoc @@ -30,7 +30,7 @@ \title Positioning with Anchors \brief placing items with anchor properties -\target anchor-layout +\keyword anchor-layout In addition to the more traditional \l Grid, \l Row, and \l Column, Qt Quick also provides a way to layout items using the concept of \e anchors. Each item can be thought of as having a set of 7 invisible "anchor lines": diff --git a/src/quick/doc/src/concepts/positioning/layouts.qdoc b/src/quick/doc/src/concepts/positioning/layouts.qdoc index de47af6db8..47ed2563f8 100644 --- a/src/quick/doc/src/concepts/positioning/layouts.qdoc +++ b/src/quick/doc/src/concepts/positioning/layouts.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! -\ingroup qtquick-positioners \page qtquick-positioning-layouts.html \title Item Positioners @@ -47,7 +46,7 @@ and are well suited for resizable user interfaces. A set of standard positioners are provided in the basic set of Qt Quick graphical types: -\generatelist{related} +\annotatedlist qtquick-positioners \section2 Column diff --git a/src/quick/doc/src/concepts/statesanimations/animations.qdoc b/src/quick/doc/src/concepts/statesanimations/animations.qdoc index 4e336afa36..1a2cff43f4 100644 --- a/src/quick/doc/src/concepts/statesanimations/animations.qdoc +++ b/src/quick/doc/src/concepts/statesanimations/animations.qdoc @@ -138,7 +138,7 @@ are also automatically applied to this property and do not need to specify values. -\keyword qml-transition-animations +\target qml-transition-animations \section2 Transitions during State Changes \l{State}{Qt Quick States} are property configurations where a property may have different values to reflect different states. State changes introduce @@ -210,7 +210,7 @@ The \l SequentialAnimation type is also useful for playing \l{qml-transition-animations}{transition animations} because animations are played in parallel inside transitions. -\keyword qml-controlling-animations +\target qml-controlling-animations \section1 Controlling Animations There are different methods to control animations. @@ -222,7 +222,7 @@ essential properties and methods for animation types. Animation types have \c{start()}, \c{stop()}, \c{resume()}, \c{pause()}, \c {restart()}, and \c{complete()} -- all of these methods control the execution of animations. -\keyword qml-easing-animation +\target qml-easing-animation \section2 Easing Easing curves define how the animation will interpolate between the start value @@ -295,27 +295,3 @@ Rectangle { \endqml */ - -/*! -\ingroup qtquick-animation-properties -\title Qt Quick Property Animation -\brief Animate property changes - -\generatelist{related} -*/ - -/*! -\ingroup qtquick-animation-control -\title Qt Quick Animation Controls -\brief Control animation sequences - -\generatelist{related} -*/ - -/*! -\ingroup qtquick-animation-modifiers -\title Qt Quick Animation Modifiers -\brief Modify animation sequences - -\generatelist{related} -*/ diff --git a/src/quick/doc/src/concepts/statesanimations/states.qdoc b/src/quick/doc/src/concepts/statesanimations/states.qdoc index d107369e44..b48a051379 100644 --- a/src/quick/doc/src/concepts/statesanimations/states.qdoc +++ b/src/quick/doc/src/concepts/statesanimations/states.qdoc @@ -26,13 +26,12 @@ ****************************************************************************/ /*! -\ingroup qtquick-states \page qtquick-statesanimations-states.html \title Qt Quick States \brief Creating and setting states \section1 Related Types -\generatelist{related} +\annotatedlist qtquick-states Many user interface designs are \e{state driven}; interfaces have configurations that differ depending on the current state. For example, a traffic signal will diff --git a/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc b/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc index 287bdc892e..443d189f58 100644 --- a/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc +++ b/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc @@ -164,9 +164,9 @@ a rectangular geometry with a texture material. \section1 Scene Graph and Rendering The rendering of the scene graph happens internally in the -QQuickWindow class, and there is no public API to access it. There are +QQuickWindow class, and there is no public API to access it. There are, however, a few places in the rendering pipeline where the user can -attach application code. This can be to add custom scene graph +attach application code. This can be used to add custom scene graph content or render raw OpenGL content. The integration points are defined by the render loop. @@ -585,7 +585,7 @@ with multiple windows. \section1 Batch Roots - In addition to mergin compatible primitives into batches, the + In addition to merging compatible primitives into batches, the default renderer also tries to minimize the amount of data that needs to be sent to the GPU for every frame. The default renderer identifies subtrees which belong together and tries to put these diff --git a/src/quick/doc/src/examples.qdoc b/src/quick/doc/src/examples.qdoc index dd21270673..e69c2f6551 100644 --- a/src/quick/doc/src/examples.qdoc +++ b/src/quick/doc/src/examples.qdoc @@ -32,7 +32,7 @@ \brief Building UIs with QML \ingroup all-examples \ingroup qtquick -\target qtquick-samples +\keyword qtquick-samples Qt includes several examples to demonstrate a particular usage. The examples run as applications or as non-GUI examples in Qt Creator. Qt tutorials show |