aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/qtquick.qdocconf
Commit message (Collapse)AuthorAgeFilesLines
* Adds documentation for the qml_in_kotlin_based_android_projects exampleKonsta Alajärvi2024-05-031-1/+2
| | | | | | | | | | | | | | Documented the qml_in_kotlin_based_android_projects example in the same .qdoc file as the qml_in_java_based_projects example. Added snippets tags to MainActivity.kt. Added support for code snippets from .kt files in qtquick.qdocconf. Fixes: QTBUG-123423 Pick-to: 6.7 Change-Id: I5ac4d231bf77a23b4083ca26712949d66c2483c1 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Adds documentation for the qml_in_java_based_android_projects exampleNicholas Bennett2024-04-171-3/+6
| | | | | | | | | | | Added a qdoc file to the top folder and edited the qtquick.qdocconf file to include it as src and for snippets. Task-number: QTBUG-122964 Pick-to: 6.7 Change-Id: I581e369b0682804729a98288164492ac1c604194 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Android: Add documentation for QtQuickView classNicholas Bennett2024-03-121-1/+2
| | | | | | | | | | | | Added Android classes page, since this is a Java class, qdoc doesn't know how to generate its docs automatically, so a custom layout is created manually here. Updated the qdoconf file to include the QtQuickView source folder. Task-number: QTBUG-120718 Pick-to: 6.7 6.7.0 Change-Id: I5e4bc112536b63fae1c79d0035f2d742d0c7c2da Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Doc: Link is looping for Qt Quick Effect MakerJaishree Vyas2024-02-291-1/+4
| | | | | | | | | | | Added the macro in the config file as the name has chaged to QQEM. Fixes: QTBUG-118804 Pick-to: 6.6 6.7 Change-Id: I88a3828b541d9ddb06316386b67c97257030e7db Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Kaj Grönholm <kaj.gronholm@qt.io>
* QQuickVectorImage: Add VectorImage itemHatem ElKharashy2024-02-221-1/+2
| | | | | | | | | | | The VectorImage item will take a vector graphics file like an SVG, and generates a QtQuick representation out of it at runtime. Initially, it will act as the counterpart of svgtoqml tool, and later on it might include other formats than SVG. Task-number: QTBUG-120987 Change-Id: Ie85c5a6309004202b449f7adc6a71d2a772df228 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
* Move Qt Quick Shapes examples back under Qt QuickEskil Abrahamsen Blomfeldt2024-02-011-1/+0
| | | | | | | | | | | | | | In order to be accessible from Qt Creator, the modules either has to have a separate landing page and qdocconf, or we need it under the same subdirectory as everything else. We currently want Qt Quick Shapes to be like Qt Quick Particles and be documented as part of Qt Quick, so the examples move back into a quickshapes/ subdirectory of examples/quick (like with examples/quick/particles/) Pick-to: 6.7 Change-Id: Ib7aaa75da7c4c9eeca6edb5ede7952598f37df89 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
* Add new weatherforecast example for Qt Quick ShapesEskil Abrahamsen Blomfeldt2024-01-151-0/+1
| | | | | | | | | | An example that shows how shapes might be used in an application, as well as the difference between different renderers. Pick-to: 6.7 Change-Id: Ic9d21b3512d61af4d23fd763ccb656238ad565b8 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Eirik Aavitsland <eirik.aavitsland@qt.io>
* Doc: Highlight some examples for the "Graphics & Multimedia"Kai Köhne2023-10-241-1/+5
| | | | | | | Pick-to: 6.5 6.6 Task-number: QTBUG-117211 Change-Id: I7db45e5644236ad4e5597943cb90e08f71675f1b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Highlight some examples for the "User Interface Components" categoryKai Köhne2023-10-091-0/+1
| | | | | | | Task-number: QTBUG-117243 Pick-to: 6.5 6.6 6.6.0 Change-Id: I339bf6ba6998091f57bd40c2296c62d329ac8d48 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Remove tutorial from Application Examples againKai Köhne2023-10-091-2/+0
| | | | | | | | | | | | | | Turns out that there is a 'real' same game example in qtdoc, so no need to list this tutorial page. While at it, also remove the entry for 'QtQuick/Qt Quick Demo - Same Game' from manifestmeta. Since the example got renamed and moved to qtdoc, this didn't have any impact anymore. Pick-to: 6.5 6.6 Task-number: QTBUG-117207 Change-Id: I35d8e1024e58619dc65060a41091021246546885 Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
* Doc: Fix undocumented parameters and broken linksTopi Reinio2023-09-151-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * src/qml/jsapi/qjsengine.cpp: (qdoc) warning: Can't link to 'qvariant_cast()' * src/quick/items/qquickrhiitem.cpp: (qdoc) warning: Undocumented parameter 'item' in QQuickRhiItemRenderer::synchronize() (qdoc) warning: Can't link to 'msaaColorBuffer()' (qdoc) warning: Can't link to 'resolveTexture()' * src/quick/scenegraph/util/qsgtextnode.cpp: (qdoc) warning: No such enum item 'Text.NativeRendering' in QSGTextNode::RenderType (qdoc) warning: Undocumented parameter 'color' in QSGTextNode::setColor() (qdoc) warning: Undocumented parameter 'color' in QSGTextNode::setSelectionColor() (qdoc) warning: Undocumented parameter 'viewport' in QSGTextNode::setViewport() * examples/quick/rendercontrol/rendercontrol_rhi/doc/src/ rendercontrol_rhi.qdoc: (qdoc) warning: Can't link to 'QWidget-based' (qdoc) warning: Can't link to 'QAnimationDriver' Mark all documentation modules in qtdeclarative as free of warnings. Change-Id: I97cc059701c351b53cdeeb5fc2feff923c5a76a8 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix linking to QtCore.Settings QML typeTopi Reinio2023-07-051-0/+1
| | | | | | | | | Fixes QDoc warnings: Can't link to 'QtQmlCore::Settings'. Pick-to: 6.5 6.6 Change-Id: I3e34a5a3f3a360391f3d1fbb00b17f617d02dc72 Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io> Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io>
* convert threading example to manual testsOliver Eftevaag2023-07-041-2/+1
| | | | | | | | | | | | The threading example used a LauncherList to combine two different but related examples into one. I've now separated both into a shared directory called 'threading' Pick-to: 6.6 Change-Id: Iee8898e61adcf69dc67157a1eff5f6ac019a39ca Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: Remove warninglimit .qdocconf variableTopi Reinio2023-06-271-3/+0
| | | | | | | | | | | | | | | | The most common limit for the maximum number of allowed documentation warnings is zero. As all Qt module docs include() a common configuration from qtbase, it's better to control the base warninglimit from a central location in qtbase/doc/global. This allows for a temporary increase of the limit across all modules as needed - for example, when updating the QDoc binary that the CI provisions to a version that introduces new types of documentation warnings. Task-number: QTBUG-113326 Change-Id: I7e5be717195049a6ce1d0a10ccbb1daeb175d714 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add quickcontrols snippets to quick qdoc configurationVolker Hilsheimer2023-05-221-0/+1
| | | | | | | | | Amends f1e7e1c3987b905157a1b9b418ea2649100eb390, which added snippets from source files that qdoc couldn't find. Pick-to: 6.2 6.5 Change-Id: I5166d7860533f396bd04d8aeb09966d0a718ff3f Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Docs: add module dependencies to configurationVolker Hilsheimer2023-04-031-0/+2
| | | | | | | | | | Fixes various warnings when qdoc fails to link to APIs in Network, SVG, or OpenGL modules. Pick-to: 6.5 Change-Id: I4b28ea746094e5d49d6129aa2914f744cda22474 Reviewed-by: Axel Spoerl <axel.spoerl@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add a how-to page for Qt Quick topicsMitch Curtis2023-03-241-1/+2
| | | | | | | | | | | | | | | | | | | | | The goal for this page is to have an easily discoverable, useful reference that shows the simplest and best way of performing specific tasks using Qt Quick. Each task will have its own section title (so they can be linked to) in the form of a question. For example: How do I make a QML Button call C++ code when clicked? Each section will provide QML and/or C++ code snippets, or link to other parts of Qt's documentation where those snippets already exist. The QML-only snippets will be tested by tests/auto/quick/doc/how-tos/qml, and the mixed QML and C++ snippets will be tested by individual auto tests under tests/auto/quick/doc/how-tos. Fixes: QTBUG-109634 Pick-to: 6.5 Change-Id: I512e016db2c914fd9e0241d5e0738af82a98d08b Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Implement DocBook mappings of qdoc macrosThibaut Cuvelier2023-02-221-1/+2
| | | | | | | | | | Modules: Qt Quick Controls 2 and Qt Quick. Also, fix a typo in the definition of \styleproperty Pick-to: 6.5 Change-Id: I3f9b6a0376679437e32a4343466fafd023c5038c Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Fix warnings for undocumented parametersTopi Reinio2023-02-211-1/+1
| | | | | | | | | | | | Fix undocumented parameters for TableView::positionViewAtIndex(), and increase the warning limit by one to address another warning that exists only on the dev branch. Pick-to: 6.5 Fixes: QTBUG-111290 Task-number: QTBUG-111289 Change-Id: I1da384a082163f1fd7fa9dbfa1e2afc3793d5c88 Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
* doc: Make sure QtQuick.Effects module shows in docsEskil Abrahamsen Blomfeldt2023-01-101-2/+3
| | | | | | | This was missing some infrastructure to be generated. Change-Id: I669193af2550bb6274b9f69fc3c852cf59e54f6d Reviewed-by: Kaj Grönholm <kaj.gronholm@qt.io>
* Doc: Avoid duplicated qt.labs.qmlmodels documentationKai Köhne2022-01-261-2/+4
| | | | | | | | | The dir is already part of qtqmlmodels.qdocconf Pick-to: 6.2 6.3 Fixes: QTBUG-99974 Change-Id: I99a97358798fd08bdb95bcc9dad3932511f24dc7 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Enable zero warning limit for documentationVenugopal Shivashankar2022-01-141-0/+3
| | | | | | | Pick-to: 6.3 Fixes: QTBUG-98116 Change-Id: I3d0a2ede380fd60bbe9c4e2852c4da3b737180ec Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Adjust regular expression for suppressing warningsTopi Reinio2022-01-061-1/+1
| | | | | | | | | | | Make the regular expression capture also future uses of \instantiates, and escape the '+' characters when matching the string 'C++'. Pick-to: 6.3 Task-number: QTBUG-98116 Change-Id: Ifecfff540aff28f5fe116240a064a74ea80d09bf Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Fix remaining documentation warningsTopi Reinio2021-12-211-1/+1
| | | | | | | | | * Invalid regular expression(s) in 'spurious' qdocconf variable * Missing comma in '\sa' Pick-to: 6.3 Change-Id: I4f3f37bbcf6b03816d6dacc98849f910f010ff46 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Suppress qdoc warnings for \instantiates entryVenugopal Shivashankar2021-12-171-0/+3
| | | | | | | | | | | | Qdoc warns if the C++ class against the entry is a private implementation or if it is outside the scope of the current module. In this case it is logical to link to those C++ classes from another module, even though the QML types instantiate a private C++ class. Pick-to: 6.3 Change-Id: Ie0772a29d2143e1f5b262f7b398a97aa0466cfc9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Fix documentation warnings in qtdeclarativeTopi Reinio2021-09-031-22/+22
| | | | | | | | | | | | | | | | | | * QtLabsPlatform has its own documentation project, but its source directory was pulled into QtQuick docs, causing duplicate generation and warnings. * Fix \snippet paths for files that were renamed/moved around. * Clean up .qdocconf files, use the {,} syntax to set identical values for multiple variables. * Fix incorrect \sa link. Pick-to: 6.2 Fixes: QTBUG-96125 Change-Id: I4c83787ac23a5b40019c74d46ee87c968a8d4907 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Remove unsupported customFiltersKai Köhne2021-08-311-3/+0
| | | | | | | | | | customFilters defined in .qdocconf are not supported anymore by Qt Assistant since Qt 5.13. Therefore remove them from all .qdocconf files, also to avoid cargo-culting them to new help modules. Task-number: QTBUG-95987 Change-Id: Id17e9c73093aea87d66d13454cbfe9172916fb37 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Include the Qt.labs submodules in the sourcedirs listVenugopal Shivashankar2021-06-231-2/+1
| | | | | | | | | | | The code for these submodules are moved out of imports but the qdocconf was not updated to include the new path. Fixes: QTBUG-92840 Pick-to: 6.1 Change-Id: I8c4677354622c6b601b273c8c96d67c33535c77f Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Doc: Fix more documentation issuesTopi Reinio2021-06-161-0/+1
| | | | | | | | | | | | | | * Screen QML type is moved under the main QtQuick import * XmlListModel types are their own documentation project, add a dependency to qtquick.qdocconf. * Remove QDoc comment identifiers from internal, undocumented class. * Fix linking to Qt Creator manual. * Fix linking to QtQuick3D.Model. Pick-to: 6.2 Change-Id: I3b48165c04ef84288472963e39eafc0868c14c49 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Refactor and update qml CMake APICraig Scott2021-06-041-6/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The existing CMake API for qml modules had a number of shortcomings. Refactor it to achieve the following: - Clearly separate public and internal aspects. - Re-use code from qtbase for adding plugins and module targets rather than reimplementing close variations. - Provide more robust and complete support for qmllint, qmlcachegen and automatic generation of qmldir files. - Reduce the steps needed for more common scenarios. - Encourage the use of separate backing library and plugin targets. - Automatically generate the plugin class .cpp file where possible. - Specify .qml files directly through qml-specific API elements rather than assuming they can be extracted out of a set of resources. [ChangeLog][QtQml] The qml CMake API has changed from 6.1 and is now out of Technical Preview status. The most notable change is that .qml files should no longer be specified as resources, there is dedicated handling for them in the qt6_add_qml_module(). A related change is that the qt6_target_qml_files() command has been replaced by qt6_target_qml_sources(). More complete integration with qmlcachegen, qmllint and qmldir generation is also part of the CMake API. Fixes: QTBUG-91621 Task-number: QTBUG-82598 Task-number: QTBUG-88763 Task-number: QTBUG-89274 Task-number: QTBUG-91444 Change-Id: I25aae1b0e89890394dfe2ba2824008164b2ca8d9 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Generate FolderListModel documentationTopi Reinio2021-05-261-1/+2
| | | | | | | | | | | src/labs/folderlistmodel was not part of any documentation project after the source directories were moved. Pick-to: 6.1 Fixes: QTBUG-94022 Change-Id: I61c31ff0e05f1bafdfe897556ecd167a5bcaba61 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix documentation warnings for Qt QuickTopi Reinio2021-02-011-10/+7
| | | | | | | | | | | - Source code for several QML modules has moved, adjust documentation configuration accordingly. - Comment out \instantiates commands referring to internal/undocumented classes. Task-number: QTBUG-90439 Change-Id: I360c8a5c02c5a03b84c77010f399d1a0e36b1263 Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
* Doc: Fix qdoc link warningNico Vertriest2021-01-271-2/+4
| | | | | | | | Path th qmllocalstorage missing in sourcedirs/headerdirs Task-number: QTBUG-90412 Change-Id: I8971e7c569e2ce3bb2c763178af6f1b546b3dc41 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Document how to use CMake for Qt QuickKai Koehne2020-12-041-1/+3
| | | | | | | Task-number: QTBUG-73058 Pick-to: 6.0 Change-Id: Ie72c1f4331ad05f31d9a646730133c97c4b15790 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add documentation dependency to qtshadertoolsAndreas Buhr2020-12-021-1/+2
| | | | | | | | | Documentation links to qtshadertools. This patch adds qtshadertools to the dependencies so these links can work. Pick-to: 6.0 Change-Id: Icb059fd681e7456f3452aeba60287bfa1cc3539e Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc: Fix documentation dependenciesTopi Reinio2020-11-251-1/+14
| | | | | | | | | | - Add missing dependency to qtquick3d - Remove qtscript, qtquickdialog dependencies - Use multiline formatting to have a clean git history of dependencies Pick-to: 6.0 6.0.0 Change-Id: If79df67ef14cce4156cd24042725e56654da4444 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Remove most examples/demos from highlighted listVolker Hilsheimer2020-11-251-7/+1
| | | | | | | | | There's nothing new in those, leave the space on top to more intersting stuff. Pick-to: 6.0 6.0.0 Change-Id: I9c349393b073e80155db594f6777778f31efdf02 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* doc: Don't overwrite native interface docsTor Arne Vestbø2020-10-151-1/+1
| | | | | | | | It doesn't look like qdoc can document the Quick specific namespace docs. Change-Id: Ic3eca2d0834c0a461f696762070e9f099e3e2641 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Doc: Update the depends listVenugopal Shivashankar2020-09-211-1/+1
| | | | | | | | Some of the modules are not part of the 6.0 release. Change-Id: I1a7ce0fb34b579b2eb08c8e977e67930f561ef44 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Remove qml statemachine plugin from qtdeclarativeKarsten Heimrich2020-08-231-2/+1
| | | | | | Task-number: QTBUG-80316 Change-Id: I584b699a1eec88117f343870bd2cd01075da64f7 Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
* Doc: Drop dependency on qtgraphicaleffectsPaul Wicking2020-08-191-1/+1
| | | | | | | qtgraphicaleffects is not part of 6.0, drop the doc dependency. Change-Id: I5df1cd84608667f58129074b8764a575a4923109 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Remove qtxmlpatterns reference from qdocconfFabian Kosmale2020-05-111-1/+1
| | | | | | | Change-Id: I922a8f2cf777f4da28200f538bc03c60528b57f5 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Simon Hausmann <hausmann@gmail.com> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Fix documentation warningsTopi Reinio2019-11-111-1/+4
| | | | | | | | | | | | | | | | | | There were a lot of documentation warnings introduced by the separation of QtQml.Models and QtQml.WorkerScript modules from the QtQml documentation project into their own sub-projects. Fix the above, and also ensure that the experimental Qt.labs.qmlmodels QML types are listed in the documentation, and add them also on the QML module page for QtQml.Models. A few warnings remain, they may be indicative of issues not in the scope of this commit. Fixes: QTBUG-79812 Change-Id: Idc25c976e4c96feab4aae893519d6c9245f57a64 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Merge remote-tracking branch 'origin/5.13' into 5.14Liang Qi2019-10-101-1/+1
|\ | | | | | | | | | | | | | | Conflicts: src/plugins/scenegraph/openvg/qsgopenvgcontext.cpp tests/auto/quick/qquickpathview/tst_qquickpathview.cpp Change-Id: I117c8d62b21800329d1035021d312d9924f83a1b
| * Doc: Correct reference to StackViewNico Vertriest2019-10-021-1/+1
| | | | | | | | | | | | | | | | | | - erroneous link to Controls1 - put qtquickcontrols before qtquickcontrols1 in depends statement Task-number: QTBUG-78799 Change-Id: I8107d9f23660e37c742a588b0efc38ac336babeb Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | doc: Add missing directories to qdocconf filesMartin Smith2019-09-161-0/+2
|/ | | | | | | | These might not be complete yet, but they do fix the qdoc errors. Change-Id: I75b0f0f7709a371149a6f7c82adfff9fe88408ea Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Replace example file lists with links to code.qt.ioTopi Reinio2019-07-091-0/+1
| | | | | | Task-number: QTBUG-74391 Change-Id: I8cd8371e820efbe90d486aef4a68e17c92fd93ea Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Remove testlib sources from Qt Quick documentation configTopi Reinio2019-04-101-1/+0
| | | | | | | | Qt Quick Test is now its own documentation module; including the path in both modules resulted in the duplication of QML types. Change-Id: Ib947bb1fa136cc81328dcb46832f616adb1cefce Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Merge 5.12 into 5.12.1Kari Oikarinen2019-01-081-1/+1
|\ | | | | | | Change-Id: Ic746fbce93430867e2eda4bc7155d34e20a4aa2b
| * Doc: Fix link issuesNico Vertriest2019-01-031-1/+1
| | | | | | | | | | Change-Id: I738b9da5335afb048d2eda2edf2be5095a91d7e5 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>