aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc
Commit message (Collapse)AuthorAgeFilesLines
* Adds documentation for the qml_in_kotlin_based_android_projects exampleHEADdevKonsta Alajärvi36 hours1-0/+5
| | | | | | | | | | | | | | 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>
* Fix doc syntax in qt6_deploy_qml_importsNicolas Fella2024-04-181-2/+2
| | | | | | | | | | | This is not a link, we are on the page documenting that command. When marking as a code snippet the extra {qt_deploy_qml_imports()} does not make sense Pick-to: 6.7 Change-Id: Ia50bc2d5bbebf43f9853dc443e6917a38de15f11 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* doc: fix briefs for qmlls documentationSami Shalayel2024-04-172-2/+2
| | | | | | | | Add missing full stop and remove extra "the". Change-Id: I22e0b7153654e735f6c237b021586d93975cdb75 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* doc: use macro for qmlls's product nameSami Shalayel2024-04-173-20/+20
| | | | | | | Replace usages of qmlls's product name with the corresponding macro. Change-Id: I4fe766d6d29696acc8b91753047fe61cfbc8ea08 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* qmltc: Enforce basic required propertiesLuca Di Sera2024-04-091-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Types in QML can expose "required" properties. A required property is a property that should be initialized when an instance of the type is built. Instantiating a type without initializing its required properties is an hard error. Currently, `qmltc` generated types do not respect the semantic of "required" properties. Instead, `qmltc` will generally default-initialize a required property without notifying the user of the error. `qmtlc`, so as to respect the semantic of required properties, will now require the user to pass an initial value for all required properties at construction time. To do so, `qmltc` will now generate a new inner record, `RequiredPropertiesBundle`, for each compiled top-level type, that contains the required amount of data to initialize each top-level required property that is reachable from the compiled type. An instance of `RequiredPropertiesBundle` will be required, as long as the type presents at least one required property, in the user-facing constructor for the generated type. The information stored in the instance will later be used to provide an initial value for each required property during the construction of the component. An intermediate representation for `RequiredPropertiesBundle` was added to "qmltcoutputir.h". `QmltcCodeWriter`, the component responsible for writing the final C++ code, was modified to take into consideration the presence, or lack thereof, of a `RequiredPropertiesBundle` and output the necessary code when required. The code taking care of populating the various IRs was modified to populate a `RequiredPropertiesBundle` for top-level components as necessary. Similarly, the code populating the parameters of the user-facing constructor was modified to require an instance of `RequiredPropertiesBundle` when necessary. The code that populates the body of the user-facing constructor for top-level types was modified to make use of the parameter by tying into the existing structure for setting initial values. `qmltc` uses a user-provided callback to allow the user to set the initial values for properties when constructing a top-level component. The body of the user-facing constructor was modified to compose the user-provided callback with a callable that sets the initial values for top-level required properties based on the bundle of data in the new `RequiredPropertiesBundle` instance. The code that populates the body of the user-facing constructor was moved into its own free-function, `compileRootExternalConstructorBody`, to be slightly more explicit about the structure of the code. A new test was provided to evaluate, some basic cases for the new behavior. Some pre-existing tests, which made use of required properties, were modified to comply with the new generated API. The documentation for `qmltc` was modified with a note about the new behavior. Task-number: QTBUG-120698 Change-Id: I1e916dcd91ae976629dad8adc7eacc6390bce7e9 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
* Modernize "extending QML" tutorialUlf Hermann2024-04-051-12/+12
| | | | | | | | | | | - Use qt_standard_project_setup() - Don't use NO_RESOURCE_TARGET_PATH - Use QQuickView::loadFromModule() Pick-to: 6.7 Change-Id: Ie68fbcaaa8824ca1cfe186bc9ead905e705e97c7 Reviewed-by: Sami Shalayel <sami.shalayel@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Generate qmldir files for extra directories with QML filesUlf Hermann2024-04-032-0/+40
| | | | | | | | | | | | | | | | Those qmldir files contain only a prefer directive for the canonical resource location of the module. This way, any time another component from the implicit import is requested, it will not be located in the extra directory (where it probably doesn't exist), but instead in the canonical location. Since people may have manually written qmldir files with different content in those places, or worse, relied on the other components to be inaccessible, we need a new policy to opt into this. Fixes: QTBUG-111763 Change-Id: If236feb7dd7c8d704b813ea56482ff758799d0a7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Correct license for documentation filesLucie Gérard2024-03-221-1/+1
| | | | | | | | | | | | According to QUIP-18 [1], all documentation files should be LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only [1]: https://contribute.qt-project.org/quips/18 Pick-to: 6.7 6.7.0 Task-number: QTBUG-121787 Change-Id: Iabd17fd759ffe51a2e3500a93b69674ee947119a Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Correct doc snippet licenseLucie Gérard2024-03-224-4/+4
| | | | | | | | | | | | | | All file under doc/snippet should be license as Documentation snippets and according to QUIP-18 [1] thi is LicenseRef-Qt-Commercial OR BSD-3-Clause [1]: https://contribute.qt-project.org/quips/18 Pick-to: 6.7 6.7.0 Task-number: QTBUG-121787 Change-Id: Iee9bc9b8c2a81695c5825a36768b36db2726bd35 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* qmltc: Allow setting initial values when creating a compiled typeLuca Di Sera2024-03-203-5/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | `qmltc`-generated types currently do not allow setting any initial values for the property of a component during creation. For example, some component `Foo` with a property `bar`, will have no way to set `bar` to a specific value from the C++ side of the code before an instance of `Foo` is obtained by the user. This lack of control prohibits the user from interacting with certain processes that are part of the component creation. For example, if a component provides am `onCompleted` binding that depends on some of the values of its properties, the user is inhibited from varying the per-instance values that `onCompleted` depends on, as the user would be able to vary those values only after the component is created and the `onCompleted` signal is emitted. This differs, from example, from the `QQmlComponent` interface, where the user is able to provide some initialization values as part of the creation of an instance of the component. To allow the user to have more control in the initialization of the instance of a component, before it is fully created, `qmltc` generated code now allows the user to provide an initialization callback that is processed as part of the creation cycle of an instance of the component. The callback provides the user with a generated proxy object, `PropertyInitializer`, that only knows how to set the writable, non-private properties of the component. The generated code for the public constructor of a `qmltc`-generated type was modified to provide an optional `initializer` parameter that stores the callback. The private `QML_init` method that `qmltc` generates for each type, that performs the required setup to create an instance of a component, was modified to allow for the same optional parameter, which is passed on by the public constructor. The body of `QML_init` was modified to call the new parameter, after having performed the general set-up for the created instance but before the instance is completed and before setting up "complex bindings" such as an `onPropertyChanged` handler. The callback is called with an instance of the generated proxy object that is built on-site. The proxy-object keeps track of the properties that were actually initialized by the callback. This information is now passed down to `QML_setComplexBindings`, which avoids setting up any unnecessary bindings for the properties that were initialized. A representation for the proxy object was added to the internal IR that is used by `qmltc` when generating code. The representation for a compiled C++ type was modified to store an instance of the proxy object. The newly stored instance is now populated as part of the general compilation of a type, by the `compilePropertyInitializer` free-function in "qmltccompiler.cpp". The component responsible for the final code-generation, `QmltcCodeWriter`, was modified to be able to generate code for the new proxy object representation. The documentation for `QmltcCodeGenerator::generate_initCode`, which sets up the body for `QML_init`, was updated to reflect the new body. A pre-existing issue in the documentation of the method, which failed to enumerate all generated steps for the body, was fixed as part of the change. The preamble that `qmltc` generates for all generated header files was modified to include "QtCore/qxpfunction.h", to have access to `qxp::function_ref`, which is used to store the new callback parameter. A pre-existing snapshot test had its snapshot file, "src/qml/doc/snippets/qmltc/special/HelloWorld.qml.cpp", updated to reflect the changes to the generated code. A new basic, non-exhaustive test case was added to the available corpus of `qmltc` tests to test the basic workflow of providing an initialization callback. The documentation for `qmltc` was modified to mention the new parameter. Task-number: QTBUG-120700 Change-Id: I246c1c3634982580d66b31fd891382559a9cc3ae Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* QML_CONSTRUCTIBLE_VALUE: Fix docsFabian Kosmale2024-03-181-0/+1
| | | | | | | | | | QML rsepects visibility when calling methods, so the constructor needs to be public. Fixes: QTBUG-123421 Pick-to: 6.7 Change-Id: I02d102c169f8791c328333d71975e69f9863fa9a Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Android: Add documentation for QtQuickView classNicholas Bennett2024-03-121-0/+12
| | | | | | | | | | | | 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: add `Articles and Guides` section to qtqml-index.htmlSami Shalayel2024-02-271-7/+18
| | | | | | | | | | Add links to the `QML language reference`, the `Qt Qml Tooling` page and to the guides `Writing Qml Modules` and `Singletons in QML`. Pick-to: 6.7 Fixes: QTBUG-121134 Change-Id: Icc1df6c37c79a3851a1b68909ddb2f9d3756f8a7 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* doc: change names of qmllint and qmlls pagesSami Shalayel2024-02-2713-22/+26
| | | | | | | | | | | | | | | | | Make the names of the qmllint and qmlls pages unique by appending "Reference". This is in-line with what we do in other places of the documentation, see also the `Qt Creator Manual` page that is used to link to `Qt Creator` This fixes the problem of \l{QML Language Server} linking to a subsection instead to linking to the `QML Language Server Reference` page. Task-number: QTBUG-121134 Pick-to: 6.7 Change-Id: I187042d1825d10ea59b5c3af96b8f5fdce10fa9b Reviewed-by: Semih Yavuz <semih.yavuz@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* doc: update qmlls description of features for 6.7Sami Shalayel2024-02-271-8/+50
| | | | | | | | | | | | | | Describe the automatic CMake building feature, and an explanation on how to disable it. Also add a short description of the renaming and autocompletion feature, and update the list of features to be supported yet. Fixes: QTBUG-120024 Pick-to: 6.7 Change-Id: I2a23621c9f17c04c8027b6401969309e1e5e25ee Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Semih Yavuz <semih.yavuz@qt.io>
* doc: emphasize that .qmlls.ini should be ignored by version controlSami Shalayel2024-02-231-4/+6
| | | | | | | | | | | Change the note to a warning so it is harder to miss, and explicitly mention that globbing is required because .qmlls.ini files are generated for each subfolder that defines a QML module. Fixes: QTBUG-122421 Change-Id: I4c2b1d14a163b5c5256d27d62a7e74ab12e97f3f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Doc: Remove confusing and wrong section about aliasesUlf Hermann2024-02-202-23/+2
| | | | | | | | | I cannot figure out what this was supposed to mean. Pick-to: 6.7 6.6 6.5 Fixes: QTBUG-119448 Change-Id: Iac8ede669d5b09c674abf115f13f977f854b7d96 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* QtQml: Re-allow manual calling of signal handlersUlf Hermann2024-02-131-0/+7
| | | | | | | | | | | | | | | The fact that you could do this was due to a mistake in the implementation of QQmlPropertyCache. The cache entry for the signal handler looked like the signal itself. Make it possible to call QmlSignalHandler objects, and output a categorized warning when doing so. Also, align the call code between the interpreter and the JIT. Pick-to: 6.7 Fixes: QTBUG-120573 Change-Id: Ic76d37f587d21b68c55d77a08ac2d30950bec133 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Yifan Zhu <fanzhuyifan@gmail.com> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* QT_QML_GENERATE_QMLLS_INI: improve documentationFabian Kosmale2024-02-042-2/+14
| | | | | | | | | | Address the comments from the API review, and link to it from qt_add_qml_module. Fixes: QTBUG-121703 Pick-to: 6.7 Change-Id: I711c1aa3c081509477798dc94b31826d546c1108 Reviewed-by: Alexey Edelev <alexey.edelev@qt.io>
* Doc: Address qt_generate_deploy_qml_app_script API review issuesJoerg Bornemann2024-02-011-2/+23
| | | | | | | Pick-to: 6.7 Task-number: QTBUG-121708 Change-Id: I7eaba8f516331d0c57885c56256603a5d4c48c45 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Fix documentation for QML_ATTACHED and QML_FOREIGNUlf Hermann2024-01-151-1/+4
| | | | | | | | They can in fact not be combined. Pick-to: 6.7 6.5 6.2 Change-Id: Ic01edf9328d7235511f305ed15114360b79d0a36 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Add doc for gc()Tasuku Suzuki2024-01-111-1/+1
| | | | | Change-Id: I920acf76846bece462b518239fc4c068a0fad8c1 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Fix linking issues and missing QDoc commandsTopi Reinio2024-01-069-24/+25
| | | | | | | | | | | | | | | Fix multiple incorrect \l (link) command arguments that were not captured by documentation testing in CI. Add missing \endqml and \endcode commands to code snippets. Convert \sa commands that are meant to be related to specific \section commands into manual 'See also' paragraphs. Otherwise, they are listed at the bottom of the page. Pick-to: 6.7 Change-Id: Icf2a97f63b8b8cdec2d9398448d28759dabdb06b Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
* doc: add read-only-property warning in qmllint warningsSami Shalayel2023-12-291-8/+20
| | | | | | | | Add description of the warning and an example on how to fix it. Task-number: QTBUG-111137 Change-Id: I7ec0f77ac21d8fb6146a38f43977de0ef604af7c Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* doc: add signal-handler-parameters warning in qmllint warningsSami Shalayel2023-12-291-3/+237
| | | | | | | | Add description of the warnings and examples on how to fix them. Task-number: QTBUG-111137 Change-Id: I7a1423a077929c3036ada8581b7c0a37f496d7ab Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Remove superfluous curly bracketPaul Wicking2023-12-181-1/+1
| | | | | | | Fixes: QTBUG-119640 Pick-to: 6.6 6.7 Change-Id: I88256e47b835154aae3974d3d717e6468b8497ba Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* CMake: Add a way to pass additional arguments to win/macdeployqtJoerg Bornemann2023-12-171-0/+4
| | | | | | | | | | | | | [ChangeLog][CMake] Added the DEPLOY_TOOL_OPTIONS argument to the function qt_generate_deploy_qml_app_script. It doesn't make sense to map every option of the deployment tools to arguments in our CMake deployment API. Allow the user to specify extra arguments to windeployqt or macdeployqt. Task-number: QTBUG-116551 Change-Id: Ib2589548492fdfb4b44ed7241275567c4bd48f2f Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Doc: Fix description on how to load the extending-qml sourcesKai Köhne2023-12-081-10/+11
| | | | | | | | | | | | | The tutorial is not a qdoc 'example' anymore , and therefore also do not show up in the Qt Creator welcome screen. While at it, also remove the version from the QML import snippet. Task-number: QTBUG-119663 Pick-to: 6.6 Change-Id: Ib32b6fc9a4c80001f6ab30d8f38bce129e5209a0 Reviewed-by: Olivier De Cannière <olivier.decanniere@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* QML: Let IDs in outer context override bound components' propertiesUlf Hermann2023-12-041-9/+45
| | | | | | | | | | | | | | | | | | This is necessary to make the usage of such IDs actually safe. If we let local properties override outer IDs, then adding local properties in later versions invalidates the ID lookups. [ChangeLog][QtQml][Important Behavior Changes] In QML documents with bound components, IDs defined in outer contexts override properties defined in inner contexts now. This is how qmlcachegen has always interpreted bound components when generating C++ code, and it is required to make access to outer IDs actually safe. The interpreter and JIT have previously preferred inner properties over outer IDs. Pick-to: 6.6 6.5 Fixes: QTBUG-119162 Change-Id: Ic5d3cc3342b4518d3fde1b800efe1b95d8e8b210 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Doc: Fix linking to Qt Qml moduleTopi Reinio2023-12-017-13/+13
| | | | | | | | | | The module landing page has been renamed in af0539c7bb6f46e89523054c09d5d846ae55f355. The correct link target is 'Qt Qml'. Change-Id: I4a13348948fe1577e7a62edbb49a0d99f9695322 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Use specific data type instead of `var`Paul Wicking2023-11-301-1/+1
| | | | | | | Fixes: QTBUG-119451 Pick-to: 6.6 6.5 Change-Id: If6675b17d52d82054470003348b5811cf3c1d550 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* doc: Create QML Singleton in-depth guideFabian Kosmale2023-11-293-1/+342
| | | | | | | | Fixes: QTBUG-104546 Task-number: QTBUG-117093 Change-Id: Icbf892524500cdad00386441e65d27ea43b10131 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Remove qml locale and dynamicscene examplesLucie Gérard2023-11-281-4/+0
| | | | | | | | | locale example has no documentation dynamicscene example does not promote good behavior Task-number: QTBUG-119117 Change-Id: I782375e2ac50b73535d51a031711222efc15b3ad Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc: Interpolate strings like it's 2023; and some other improvementsIvan Tkachenko2023-11-282-46/+49
| | | | | | | Change-Id: Ie69e463e59ddd8190c68b4d739b7fbaaad2baa3d Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix \fn template arguments for Qt QmlTopi Reinio2023-11-272-9/+9
| | | | | | | | | | | | | Upcoming changes to QDoc require accurate definition for template arguments in \fn commands. Qualify links to qmlRegisterType() with QQmlEngine scope; this is a workaround for a problem in QDoc that will be addressed separately. Task-number: QTBUG-118080 Change-Id: I78dbbc2770e9d2fe9a7c20a5858c412fb1ae0fd8 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add tool for converting SVG to QML using ShapesPaul Olav Tvete2023-11-241-0/+17
| | | | | | | | | | | This tool is in tech preview. Only a subset of SVG Tiny works at the moment. The tool does not even support everything that QtSvg supports. Task-number: QTBUG-116883 Change-Id: Ie33f8bf42a5d37b63b86f6816df21960a1ef1071 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
* Doc: Clarify that QV4_FORCE_INTERPRETER will also not use the compilerOlivier De Cannière2023-11-241-2/+5
| | | | | | | | Change-Id: I987b739ff30a92b06bcd5f4c4b57604a930263b9 Reviewed-by: Semih Yavuz <semih.yavuz@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Olivier De Cannière <olivier.decanniere@qt.io>
* Allow pragma Translator to have a string literal as valueLucie Gérard2023-11-141-0/+4
| | | | | | | | Also add test and update documentation Task-number: QTBUG-114528 Change-Id: I7baa3a3268c4ccd2efe5bd8be7d790e909c430c6 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Warn about slowness of createQmlObject()Ulf Hermann2023-11-041-0/+6
| | | | | | | Pick-to: 6.6 6.5 Change-Id: Ie00d0df9bc8ad6106559ce0a66c91e0aaac81cfd Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* doc: Improve cross-references for value typesFabian Kosmale2023-11-011-3/+6
| | | | | | | | | | | ...and note that other Qt modules might also have value types. The claim that they document those value types is currently slightly optimistic, but that needs to be fixed in separate commits. Task-number: QTBUG-95302 Task-number: QTBUG-118108 Change-Id: If48835cf200f754224f259c9a91976575e604941 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Add documentation for Translator pragmaLucie Gérard2023-10-311-0/+10
| | | | | | | Task-number: QTBUG-114528 Change-Id: I9921589cdc13f897ca34c770f0172c69bc40b942 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* doc: add alias cycle in qmllint warningsSami Shalayel2023-10-231-7/+41
| | | | | | | | Add description of the warning and an example on how to fix it. Task-number: QTBUG-111137 Change-Id: I0743c7700aa2d4d84b687604b5f61a9f01d05f37 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* doc: add duplicate property warning in qmllint warningsSami Shalayel2023-10-231-6/+101
| | | | | | | | Add description of the warning and an example on how to fix it. Task-number: QTBUG-111137 Change-Id: I3cf959b212b85c5081ae67ff031e194f9f1f4545 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* doc: add duplicated-name warning in qmllint warningsSami Shalayel2023-10-231-6/+50
| | | | | | | | Add description of the warning and an example on how to fix it. Task-number: QTBUG-111137 Change-Id: I8ee0d31e9562cdbd963e5bdf25fe75fdce7b3190 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* doc: add non-list property warning in qmllint warningsSami Shalayel2023-10-231-6/+65
| | | | | | | | Add description of the warning and an example on how to fix it. Task-number: QTBUG-111137 Change-Id: Ia1c194bb9e65428b8c5f46b755369f153ab45584 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Add Documentation for versioningUlf Hermann2023-10-191-2/+193
| | | | | | | | | This covers all the aspects of versioning I'm aware of. Pick-to: 6.6 Fixes: QTBUG-93780 Change-Id: I7c2e1becd90cb836db66e7784dd9fe231e56bd47 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* doc: qt_add_qml_module links to qmltc's doc about private headersSami Shalayel2023-10-181-0/+8
| | | | | | | | | | | | Add a note in qt_add_qml_module that qmltc requires private headers in the ENABLE_TYPE_COMPILER section, and link to the part of the documentation of qmltc that explains how to compile QML to C++ using CMake. Fixes: QTBUG-117451 Pick-to: 6.5 6.6 Change-Id: Ie5e6e6c92a10ef4822e5a712bb31e06bdce6bf5e Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* doc: add missing type warning to qmllint warningsSami Shalayel2023-10-181-6/+219
| | | | | | | | Add description of the warning and an example on how to fix it. Task-number: QTBUG-111137 Change-Id: Ib544ea674a1cfc5c6d9b5c9a944cf476cdf51f7d Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* doc: document qml toolSemih Yavuz2023-10-161-0/+97
| | | | | Change-Id: Iff0afe38883d68d9bf72bc5e170cf6e17bc4e05f Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* doc: document qmlpreviewSemih Yavuz2023-10-162-0/+68
| | | | | Change-Id: I6e526c8a6526a2b3da443c310dab6690db9d9b3f Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-05 02:09:06 +0000