diff options
author | Jaishree Vyas <jaishree.vyas@qt.io> | 2023-09-25 14:39:44 +0200 |
---|---|---|
committer | Kai Köhne <kai.koehne@qt.io> | 2023-09-27 12:01:22 +0000 |
commit | dca2d53746adbac60e4d9051f518bd22b16c30c3 (patch) | |
tree | 6295f425eb1626360e074c2779065cdcddbc9f5c | |
parent | a575a94f85db041d4192b2f8ac02006f1d0bfc3d (diff) |
Doc: Add example categories for qtquick
Task-number: QTBUG-116334
Change-Id: I993b6157c3ef8a69e4e218d62596b5219ab4b34b
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
(cherry picked from commit 46fc095ae48456afab360847e0c8cb16f59997c8)
13 files changed, 16 insertions, 0 deletions
diff --git a/examples/quick/layouts/doc/src/qtquicklayouts-examples.qdoc b/examples/quick/layouts/doc/src/qtquicklayouts-examples.qdoc index dcbbaeeed7..a7b021f1f9 100644 --- a/examples/quick/layouts/doc/src/qtquicklayouts-examples.qdoc +++ b/examples/quick/layouts/doc/src/qtquicklayouts-examples.qdoc @@ -6,6 +6,7 @@ \brief Demonstrates how to use layout types to arrange a UI. \image qtquicklayouts-example-layouts.png \ingroup qtquickexamples + \examplecategory {User Interface Components} This example shows how to easily arrange UI components into \l{Qt Quick Layouts}{layouts} with \l{GridLayout}, \l{RowLayout}, and diff --git a/examples/quick/models/abstractitemmodel/doc/src/abstractitemmodel-example.qdoc b/examples/quick/models/abstractitemmodel/doc/src/abstractitemmodel-example.qdoc index 61d63ca417..6f627d050c 100644 --- a/examples/quick/models/abstractitemmodel/doc/src/abstractitemmodel-example.qdoc +++ b/examples/quick/models/abstractitemmodel/doc/src/abstractitemmodel-example.qdoc @@ -5,6 +5,7 @@ \example models/abstractitemmodel \title Models and Views: AbstractItemModel Example \brief Shows how to use a QAbstractItemModel subclass as a model in QML. + \examplecategory {User Interface Components} \image qml-abstractitemmodel-example.png */ diff --git a/examples/quick/models/objectlistmodel/doc/src/objectlistmodel-example.qdoc b/examples/quick/models/objectlistmodel/doc/src/objectlistmodel-example.qdoc index b011b01fdd..2ceec9376d 100644 --- a/examples/quick/models/objectlistmodel/doc/src/objectlistmodel-example.qdoc +++ b/examples/quick/models/objectlistmodel/doc/src/objectlistmodel-example.qdoc @@ -5,6 +5,7 @@ \example models/objectlistmodel \title Models and Views: Object ListModel Example \brief Shows how to use a QList<QObject*> as a model in QML. + \examplecategory {User Interface Components} \image qml-objectlistmodel-example.png */ diff --git a/examples/quick/models/stringlistmodel/doc/src/stringlistmodel-example.qdoc b/examples/quick/models/stringlistmodel/doc/src/stringlistmodel-example.qdoc index 57b24692ae..3b00a0e211 100644 --- a/examples/quick/models/stringlistmodel/doc/src/stringlistmodel-example.qdoc +++ b/examples/quick/models/stringlistmodel/doc/src/stringlistmodel-example.qdoc @@ -5,6 +5,7 @@ \example models/stringlistmodel \title Models and Views: String ListModel Example \brief Shows how to use a QStringList as a model in QML. + \examplecategory {User Interface Components} \image qml-stringlistmodel-example.png */ diff --git a/examples/quick/pointerhandlers/doc/src/pointerhandlers.qdoc b/examples/quick/pointerhandlers/doc/src/pointerhandlers.qdoc index 40d8bf1e7f..d9f2e5f1cc 100644 --- a/examples/quick/pointerhandlers/doc/src/pointerhandlers.qdoc +++ b/examples/quick/pointerhandlers/doc/src/pointerhandlers.qdoc @@ -5,6 +5,7 @@ \example pointerhandlers \title Qt Quick Examples - Pointer Handlers \ingroup qtquickexamples + \examplecategory {User Interface Components} \meta tags {quick, input handlers} \brief Shows how to use \l {Qt Quick Input Handlers} in interactive components. diff --git a/examples/quick/positioners/doc/src/positioners.qdoc b/examples/quick/positioners/doc/src/positioners.qdoc index 3fe8e4ef7e..2b1af4d496 100644 --- a/examples/quick/positioners/doc/src/positioners.qdoc +++ b/examples/quick/positioners/doc/src/positioners.qdoc @@ -6,6 +6,7 @@ \brief This is a collection of QML Positioner examples. \image qml-positioners-example.png \ingroup qtquickexamples + \examplecategory {User Interface Components} \e Positioners is a collection of small QML examples relating to positioners. Each example is a small QML file emphasizing a particular type diff --git a/examples/quick/quickwidgets/qquickwidgetversuswindow_opengl/doc/src/qquickwidgetversuswindow_opengl.qdoc b/examples/quick/quickwidgets/qquickwidgetversuswindow_opengl/doc/src/qquickwidgetversuswindow_opengl.qdoc index 001d19f4e6..ced0eb2d34 100644 --- a/examples/quick/quickwidgets/qquickwidgetversuswindow_opengl/doc/src/qquickwidgetversuswindow_opengl.qdoc +++ b/examples/quick/quickwidgets/qquickwidgetversuswindow_opengl/doc/src/qquickwidgetversuswindow_opengl.qdoc @@ -5,6 +5,7 @@ \title QQuickWidget - QQuickView Comparison Example \example quickwidgets/qquickwidgetversuswindow_opengl \brief Demonstrates the benefits of QQuickWidget over a QQuickView embedded as a native window. + \examplecategory {User Interface Components} \image qquickwidgetversuswindow-opengl-example.jpg The example allows showing the same Qt Quick scene within the same diff --git a/examples/quick/quickwidgets/quickwidget/doc/src/quickwidget.qdoc b/examples/quick/quickwidgets/quickwidget/doc/src/quickwidget.qdoc index 285acc5802..0a80b32c4a 100644 --- a/examples/quick/quickwidgets/quickwidget/doc/src/quickwidget.qdoc +++ b/examples/quick/quickwidgets/quickwidget/doc/src/quickwidget.qdoc @@ -5,6 +5,8 @@ \title Qt Quick Widgets Example \example quickwidgets/quickwidget \brief Demonstrates how to mix QML with a Qt Widgets application using the QQuickWidget class. + \examplecategory {User Interface Components} + \image qtquickwidgets-example.png */ diff --git a/examples/quick/rendercontrol/rendercontrol_d3d11/doc/src/rendercontrol_d3d11.qdoc b/examples/quick/rendercontrol/rendercontrol_d3d11/doc/src/rendercontrol_d3d11.qdoc index ad9189e139..a75092d7e5 100644 --- a/examples/quick/rendercontrol/rendercontrol_d3d11/doc/src/rendercontrol_d3d11.qdoc +++ b/examples/quick/rendercontrol/rendercontrol_d3d11/doc/src/rendercontrol_d3d11.qdoc @@ -5,5 +5,7 @@ \title QQuickRenderControl D3D11 Example \example rendercontrol/rendercontrol_d3d11 \brief Shows how to render a Qt Quick scene into a texture that is then used by a non-Quick based Direct3D 11 renderer. + \examplecategory {Graphics & Multimedia} + \image rendercontrol-d3d11-example.jpg */ diff --git a/examples/quick/rendercontrol/rendercontrol_opengl/doc/src/rendercontrol_opengl.qdoc b/examples/quick/rendercontrol/rendercontrol_opengl/doc/src/rendercontrol_opengl.qdoc index a4f3fb4664..ea8809f637 100644 --- a/examples/quick/rendercontrol/rendercontrol_opengl/doc/src/rendercontrol_opengl.qdoc +++ b/examples/quick/rendercontrol/rendercontrol_opengl/doc/src/rendercontrol_opengl.qdoc @@ -5,6 +5,8 @@ \title QQuickRenderControl OpenGL Example \example rendercontrol/rendercontrol_opengl \brief Shows how to render a Qt Quick scene into a texture that is then used by a non-Quick based OpenGL renderer. + \examplecategory {Graphics & Multimedia} + \image rendercontrol-opengl-example.jpg The Qt Quick scene is managed by a QQuickWindow that is not visible diff --git a/examples/quick/responsivelayouts/doc/src/qtquickresponsiveLayouts-examples.qdoc b/examples/quick/responsivelayouts/doc/src/qtquickresponsiveLayouts-examples.qdoc index bf2af80b19..7c204fc5b4 100644 --- a/examples/quick/responsivelayouts/doc/src/qtquickresponsiveLayouts-examples.qdoc +++ b/examples/quick/responsivelayouts/doc/src/qtquickresponsiveLayouts-examples.qdoc @@ -5,6 +5,7 @@ \example responsivelayouts \brief Demonstrates how to use LayoutItemProxy to make a responsive UI. \ingroup qtquickexamples + \examplecategory {User Interface Components} This example shows how to use LayoutProxyItems in combination with \l{Qt Quick Layouts}{layouts} to create responsive layouts. diff --git a/src/quick/doc/src/advtutorial.qdoc b/src/quick/doc/src/advtutorial.qdoc index dc79abbc1e..86a8b1ddec 100644 --- a/src/quick/doc/src/advtutorial.qdoc +++ b/src/quick/doc/src/advtutorial.qdoc @@ -44,6 +44,7 @@ directory. \nextpage QML Advanced Tutorial 2 - Populating the Game Canvas \example tutorials/samegame/samegame1 +\examplecategory {Application Examples} \section2 Creating the Application Screen diff --git a/src/quick/doc/src/dynamicview-tutorial.qdoc b/src/quick/doc/src/dynamicview-tutorial.qdoc index 3a3f73a533..bb6c18b90c 100644 --- a/src/quick/doc/src/dynamicview-tutorial.qdoc +++ b/src/quick/doc/src/dynamicview-tutorial.qdoc @@ -30,6 +30,7 @@ directory. \nextpage QML Dynamic View Ordering Tutorial 2 - Dragging View Items \example tutorials/dynamicview/dynamicview1 +\examplecategory {User Interface Components} We begin our application by defining a ListView, a model which will provide data to the view, and a delegate which provides a template for constructing items in the view. |