diff options
author | Jaishree Vyas <[email protected]> | 2023-08-23 16:37:11 +0200 |
---|---|---|
committer | Jaishree Vyas <[email protected]> | 2023-09-05 15:49:33 +0200 |
commit | b16bea02f65dea173eb42208e8750245f334b5e5 (patch) | |
tree | 6695cf53d28eb9a285053fa1fcc7ed164c342de6 | |
parent | 86d9f3285cd02e8856f326dd7a3e891f4519a04e (diff) |
Doc: Add example categories for qtquick
Task-number: QTBUG-116334
Pick-to: 6.5 6.6
Change-Id: Id17a546b9363e5225b8778c629fe9ffe30d2e719
Reviewed-by: Topi Reiniö <[email protected]>
Reviewed-by: Kai Köhne <[email protected]>
23 files changed, 23 insertions, 0 deletions
diff --git a/examples/quick/animation/doc/src/animation.qdoc b/examples/quick/animation/doc/src/animation.qdoc index 5ff4bcbc23..d23235879f 100644 --- a/examples/quick/animation/doc/src/animation.qdoc +++ b/examples/quick/animation/doc/src/animation.qdoc @@ -7,6 +7,7 @@ \brief This is a collection of QML Animation examples. \image qml-animations-example.png \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} \e Animation is a collection of small QML examples relating to animation. Each example is a small QML file emphasizing a particular type or feature. diff --git a/examples/quick/canvas/doc/src/canvas.qdoc b/examples/quick/canvas/doc/src/canvas.qdoc index 862925fc08..2d3bcab73c 100644 --- a/examples/quick/canvas/doc/src/canvas.qdoc +++ b/examples/quick/canvas/doc/src/canvas.qdoc @@ -7,6 +7,7 @@ \brief This is a collection of QML Canvas examples. \image qml-canvas-example.png \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} \e Canvas is a collection of small QML examples relating to the \l Canvas type. Each example is a small QML file emphasizing a particular type or diff --git a/examples/quick/customitems/dialcontrol/doc/src/dialcontrol.qdoc b/examples/quick/customitems/dialcontrol/doc/src/dialcontrol.qdoc index b6cdecf5df..a94d93788d 100644 --- a/examples/quick/customitems/dialcontrol/doc/src/dialcontrol.qdoc +++ b/examples/quick/customitems/dialcontrol/doc/src/dialcontrol.qdoc @@ -6,6 +6,7 @@ \title UI Components: Dial Control Example \example customitems/dialcontrol \brief The Dial Control Example shows how to create a speedometer-type dial. + \examplecategory {Graphics & Multimedia} This example shows how to create a dial-type control. It combines \l Image elements with \l Rotation transforms and \l SpringAnimation behaviors diff --git a/examples/quick/customitems/flipable/doc/src/flipable.qdoc b/examples/quick/customitems/flipable/doc/src/flipable.qdoc index 1870b2743b..e9cd6b75f3 100644 --- a/examples/quick/customitems/flipable/doc/src/flipable.qdoc +++ b/examples/quick/customitems/flipable/doc/src/flipable.qdoc @@ -5,6 +5,7 @@ \title UI Components: Flipable Example \example customitems/flipable \brief The Flipable Example shows an item that flips whenever clicked, rotating around the y-axis. + \examplecategory {Graphics & Multimedia} This example shows how to use the \l Flipable element. diff --git a/examples/quick/customitems/painteditem/doc/src/textballoons.qdoc b/examples/quick/customitems/painteditem/doc/src/textballoons.qdoc index 4d41f6c2a5..307771b36b 100644 --- a/examples/quick/customitems/painteditem/doc/src/textballoons.qdoc +++ b/examples/quick/customitems/painteditem/doc/src/textballoons.qdoc @@ -5,6 +5,7 @@ \brief Shows how to implement QPainter-based custom scenegraph items. \example customitems/painteditem \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} The Painted Item example shows how to use the QML Scene Graph framework to implement custom scenegraph items using QPainter. diff --git a/examples/quick/draganddrop/doc/src/draganddrop.qdoc b/examples/quick/draganddrop/doc/src/draganddrop.qdoc index 23a135b2fa..9cb3f1cd96 100644 --- a/examples/quick/draganddrop/doc/src/draganddrop.qdoc +++ b/examples/quick/draganddrop/doc/src/draganddrop.qdoc @@ -6,6 +6,7 @@ \brief This is a collection of QML drag and drop examples. \image qml-draganddrop-example.png \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} \e{Drag and Drop} is a collection of small QML examples relating to the drag and drop functionality. For more information, visit the \l{Drag and Drop} diff --git a/examples/quick/embeddedinwidgets/doc/src/embeddedinwidgets.qdoc b/examples/quick/embeddedinwidgets/doc/src/embeddedinwidgets.qdoc index eeb4931b3c..8f24ad18ce 100644 --- a/examples/quick/embeddedinwidgets/doc/src/embeddedinwidgets.qdoc +++ b/examples/quick/embeddedinwidgets/doc/src/embeddedinwidgets.qdoc @@ -6,6 +6,7 @@ \image qml-embeddedinwidgets-example.jpg \brief Demonstrates embedding a QQuickWindow into a QWidget UI via QWidget::createWindowContainer(). \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} This example demonstrates one of the approaches to adding Qt Quick content into a QWidget-based application. QQuickView, and its parent class, diff --git a/examples/quick/imageelements/doc/src/imageelements.qdoc b/examples/quick/imageelements/doc/src/imageelements.qdoc index 3caf49201b..0510bdf2ad 100644 --- a/examples/quick/imageelements/doc/src/imageelements.qdoc +++ b/examples/quick/imageelements/doc/src/imageelements.qdoc @@ -6,6 +6,7 @@ \brief This is a collection of QML examples relating to image types. \image qml-imageelements-example.png \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} \e{Image Elements} is a collection of small QML examples relating to image types. For more information, visit \l{Use Case - Visual Elements In QML}. diff --git a/examples/quick/imageprovider/doc/src/imageprovider.qdoc b/examples/quick/imageprovider/doc/src/imageprovider.qdoc index 7a4f64285c..4533065735 100644 --- a/examples/quick/imageprovider/doc/src/imageprovider.qdoc +++ b/examples/quick/imageprovider/doc/src/imageprovider.qdoc @@ -5,6 +5,7 @@ \title C++ Extensions: Image Provider Example \brief How to load images in QML with QQuickImageProvider. \example imageprovider + \examplecategory {Graphics & Multimedia} This examples shows how to use QQuickImageProvider to serve images to QML image elements. diff --git a/examples/quick/imageresponseprovider/doc/src/imageresponseprovider.qdoc b/examples/quick/imageresponseprovider/doc/src/imageresponseprovider.qdoc index f05118abbb..5795542113 100644 --- a/examples/quick/imageresponseprovider/doc/src/imageresponseprovider.qdoc +++ b/examples/quick/imageresponseprovider/doc/src/imageresponseprovider.qdoc @@ -5,6 +5,7 @@ \title C++ Extensions: Image Response Provider Example \example imageresponseprovider \brief How to load images asynchronously in QML. + \examplecategory {Graphics & Multimedia} This examples shows how to use QQuickImageProvider to serve images diff --git a/examples/quick/itemvariablerefreshrate/doc/src/itemvariablerefreshrate.qdoc b/examples/quick/itemvariablerefreshrate/doc/src/itemvariablerefreshrate.qdoc index 5be8cd36eb..afa7539c2c 100644 --- a/examples/quick/itemvariablerefreshrate/doc/src/itemvariablerefreshrate.qdoc +++ b/examples/quick/itemvariablerefreshrate/doc/src/itemvariablerefreshrate.qdoc @@ -7,6 +7,7 @@ \brief A Qt Quick example shows how to setup variable refresh rate for specific parts of the UI. \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} This example demonstrates using the live property of a \l{Item Layers} to get a variable and independent refresh rate for Quick items. This can provide a significant diff --git a/examples/quick/keyinteraction/doc/src/keyinteraction.qdoc b/examples/quick/keyinteraction/doc/src/keyinteraction.qdoc index 1b1cc47138..a0e69a2665 100644 --- a/examples/quick/keyinteraction/doc/src/keyinteraction.qdoc +++ b/examples/quick/keyinteraction/doc/src/keyinteraction.qdoc @@ -6,6 +6,7 @@ \brief This is a collection of QML keyboard interaction examples. \image qml-keyinteraction-example.png \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} \e{Keyboard Focus in Qt Quick} combines various methods of handling keyboard focus. For more information, visit diff --git a/examples/quick/mousearea/doc/src/mousearea.qdoc b/examples/quick/mousearea/doc/src/mousearea.qdoc index 520644907b..12b74c807e 100644 --- a/examples/quick/mousearea/doc/src/mousearea.qdoc +++ b/examples/quick/mousearea/doc/src/mousearea.qdoc @@ -6,6 +6,7 @@ \brief This is an example of the MouseArea type in QML. \image qml-mousearea-example.png \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} \e MouseArea example shows how to respond to clicks and drags with a \l MouseArea. For more information, visit diff --git a/examples/quick/multieffect/itemswitcher/doc/src/itemswitcher.qdoc b/examples/quick/multieffect/itemswitcher/doc/src/itemswitcher.qdoc index 251e50d3e3..c7f604bf7f 100644 --- a/examples/quick/multieffect/itemswitcher/doc/src/itemswitcher.qdoc +++ b/examples/quick/multieffect/itemswitcher/doc/src/itemswitcher.qdoc @@ -6,6 +6,7 @@ \image qml-multieffectitemswitcher-example.jpg \brief Demonstrates MultiEffect usage. \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} This example demonstrates advanced usage of the MultiEffect type, which offers a simple, efficient solution for applying effects such as blur, drop diff --git a/examples/quick/multieffect/testbed/doc/src/testbed.qdoc b/examples/quick/multieffect/testbed/doc/src/testbed.qdoc index 9507f12eb2..b0cfa0dc88 100644 --- a/examples/quick/multieffect/testbed/doc/src/testbed.qdoc +++ b/examples/quick/multieffect/testbed/doc/src/testbed.qdoc @@ -6,6 +6,7 @@ \image qml-multieffecttestbed-example.jpg \brief Demonstrates MultiEffect usage. \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} This example demonstrates the MultiEffect type, which offers a simple, efficient solution for applying effects such as blur, drop shadow, or diff --git a/examples/quick/quick-accessibility/doc/src/accessibility.qdoc b/examples/quick/quick-accessibility/doc/src/accessibility.qdoc index f4b435dc47..d9b525851b 100644 --- a/examples/quick/quick-accessibility/doc/src/accessibility.qdoc +++ b/examples/quick/quick-accessibility/doc/src/accessibility.qdoc @@ -5,6 +5,7 @@ \example quick-accessibility \brief This example demonstrates the implementation of accessible buttons. \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} \e Accessibility demonstrates QML types that are augmented with meta-data for accessibility systems. For more information, visit the diff --git a/examples/quick/shadereffects/doc/src/shadereffects.qdoc b/examples/quick/shadereffects/doc/src/shadereffects.qdoc index b846989cdd..09f7b6a882 100644 --- a/examples/quick/shadereffects/doc/src/shadereffects.qdoc +++ b/examples/quick/shadereffects/doc/src/shadereffects.qdoc @@ -6,6 +6,7 @@ \image qml-shadereffects-example.png \brief A Qt Quick example demonstrating the use of shader effects. \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} This example demonstrates a couple of visual effects that you can perform with shaders in Qt Quick. It applies five different effects on a text and diff --git a/examples/quick/shapes/doc/src/shapes.qdoc b/examples/quick/shapes/doc/src/shapes.qdoc index fd97661b6f..57ab7ea383 100644 --- a/examples/quick/shapes/doc/src/shapes.qdoc +++ b/examples/quick/shapes/doc/src/shapes.qdoc @@ -6,6 +6,7 @@ \image qml-shapes-example.png \brief A Qt Quick example demonstrating the use of shape items. \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} This example demonstrates the usage of the \l Shape type in Qt Quick. Shapes allow efficiently rendering stroked and filled lines, curves, and arcs in Qt diff --git a/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc b/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc index c7fffacecf..9c6477e3c7 100644 --- a/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc +++ b/examples/quick/tableview/gameoflife/doc/src/gameoflife.qdoc @@ -5,6 +5,7 @@ \example tableview/gameoflife \brief The \e{Conway’s Game of Life} example shows how the QML TableView type can be used to display a C++ model that the user can pan around. + \examplecategory {Graphics & Multimedia} \image gameoflife.png \ingroup qtquickexamples diff --git a/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc b/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc index 552b70e198..462b8e2bee 100644 --- a/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc +++ b/examples/quick/tableview/pixelator/doc/src/pixelator.qdoc @@ -5,6 +5,7 @@ \example tableview/pixelator \brief The Pixelator example shows how a QML TableView and a delegate can be used for custom table models. + \examplecategory {Graphics & Multimedia} \image qt-pixelator.png \ingroup qtquickexamples diff --git a/examples/quick/text/doc/src/text.qdoc b/examples/quick/text/doc/src/text.qdoc index 725f8c04bb..325fea4c21 100644 --- a/examples/quick/text/doc/src/text.qdoc +++ b/examples/quick/text/doc/src/text.qdoc @@ -6,6 +6,7 @@ \brief This is a collection of QML examples relating to text. \image qml-text-example.png \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} \e Text is a collection of small QML examples relating to text. Each example is a small QML file, usually containing or emphasizing a particular type or diff --git a/examples/quick/views/doc/src/views.qdoc b/examples/quick/views/doc/src/views.qdoc index 8e6e6c1846..8c1e39aaff 100644 --- a/examples/quick/views/doc/src/views.qdoc +++ b/examples/quick/views/doc/src/views.qdoc @@ -7,6 +7,7 @@ \brief This is a collection of QML model-view examples. \image qml-modelviews-example.png \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} \e Views is a collection of small QML examples relating to model and view functionality. They demonstrate how to show data from a model using the diff --git a/examples/quick/window/doc/src/window.qdoc b/examples/quick/window/doc/src/window.qdoc index 3dfbf1cd0c..914b431f69 100644 --- a/examples/quick/window/doc/src/window.qdoc +++ b/examples/quick/window/doc/src/window.qdoc @@ -6,6 +6,7 @@ \brief This example demonstrates the Window and Screen types in QML. \image qml-window-example.png \ingroup qtquickexamples + \examplecategory {Graphics & Multimedia} \e{Window and Screen} shows how to: |