aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc
Commit message (Collapse)AuthorAgeFilesLines
* Add doumentation for nullish coalescingMaximilian Goldstein2020-04-022-0/+6
| | | | | | | Fixes: QTBUG-83145 Task-number: QTBUG-81615 Change-Id: I87a2053aa560b434b6282f5dad852537ac0342cf Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Fix typo in linkPaul Wicking2020-03-261-1/+1
| | | | | | Fixes: QTBUG-83099 Change-Id: I8cbf2680021836a9e43c225211cf9b479445452e Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* qmlRegisterSingletonInstance: show user-friendly signature in documentationFabian Kosmale2020-03-181-1/+1
| | | | | Change-Id: I50ee4c014acf3f95d00a38c6d115776143688c8e Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Merge remote-tracking branch 'origin/5.14' into 5.15Qt Forward Merge Bot2020-03-031-0/+19
|\ | | | | | | | | | | | | | | Conflicts: src/qmlmodels/qqmltableinstancemodel.cpp src/qmlmodels/qqmltableinstancemodel_p.h Change-Id: I89339b1cb41ba27fe30c79530859a1c2bfbecc69
| * Doc: Add section about QVariantList and QVariantMap as C++ propertiesUlf Hermann2020-02-241-0/+19
| | | | | | | | | | | | | | Change-Id: Ie18661274880f45d911baf05797a8b384d72f9f7 Fixes: QTBUG-82249 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Fix QML basic type documentationEdward Welbourne2020-02-201-26/+7
| | | | | | | | | | | | | | | | | | Removed the documentation of some limitations that no longer apply. Fixed up grammar in the process. Fixes: QTBUG-82249 Change-Id: I807cbef10393f11bf864cf44ddd7556aa0eabb92 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* | Doc: Fix documentation warnings for Qt QMLTopi Reinio2020-02-205-16/+18
| | | | | | | | | | | | Fixes: QTBUG-82313 Change-Id: I7c2f30411ab8011254d7c232c87cb12a39761bda Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | Doc: Fix the qmltypes format documentationUlf Hermann2020-02-201-17/+26
| | | | | | | | | | | | | | | | | | | | | | The case of plain element name without URI is highly atypical and should not be advertised to end users. Also, stress that minor versions and revisions should match and that you should use the QML_* macros to register types. Task-number: QTBUG-81615 Change-Id: I1fd89c708ef8c33cbe44bacb3b37f25661eb3d1e Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* | Doc: Fix imports documentationUlf Hermann2020-02-201-6/+6
| | | | | | | | | | | | | | | | We promote QML_ELEMENT and QML_NAMED_ELEMENT() ways to declare types, rather than qmlRegisterType(). Change-Id: I78d64a0ab4412499815da8c0f71bea6dc5dd0b93 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* | Doc: Update documentation for "extending" exampleUlf Hermann2020-02-191-10/+19
| | | | | | | | | | | | | | It referred to qmlRegisterType() even though we don't call it anymore. Change-Id: Ib07e4428d032e789d705156ddc4c9589fd797c65 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* | Doc: Fix extension plugin examples and documentationUlf Hermann2020-02-181-23/+26
| | | | | | | | | | | | | | | | | | | | | | | | We advertise the usage of QQmlEngineExtensionPlugin, as registerTypes() should be avoided if possible. The actual source code of the examples already does this, but some of the includes and the documentation was lagging. Task-number: QTBUG-81615 Change-Id: Ibbee60ad55114bf6dc07875080c963e727f49e6b Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* | Add documentation for the QML_* macrosUlf Hermann2020-02-172-14/+290
| | | | | | | | | | | | Task-number: QTBUG-81615 Change-Id: Ida02001803230d7daed9352e27689b417f3ac15c Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* | Doc: Modernize backend example and adapt C++ integration docsUlf Hermann2020-02-124-13/+28
| | | | | | | | | | | | | | | | We want people to use the static type registration. Change-Id: I98e51af9df1a2f73df10f82458a7b7f5c5e5aad1 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Doc: Modernize the type definition docsUlf Hermann2020-02-121-79/+57
| | | | | | | | | | | | | | | | | | | | Mention the QML_* macros instead of the qmlRegister* functions and adapt the code examples to use them. Task-number: QTBUG-81615 Change-Id: I9e4cf5b3700b7e727b0f2a93035559b75b733adb Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* | Documentation: reflow to limit line lengthFabian Kosmale2020-02-121-14/+63
| | | | | | | | | | Change-Id: I5f2f8383e4e8f6e650dcad1ae7c07e0bacd36136 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Modernize scarceresources snippets and adapt docsUlf Hermann2020-02-114-65/+108
| | | | | | | | | | | | | | Also, make sure we can actually compile and test-run the snippets. Change-Id: I50d2bd85528ddbd8d6ad3f38e716b600df54a571 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Add inline component documentationFabian Kosmale2020-02-065-0/+303
| | | | | | | | | | | | | | Change-Id: Ieff73eba115802722afdbb491b74df5eaad9a4f4 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Pierre-Yves Siret <gr3cko@gmail.com> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* | Add required property documentationFabian Kosmale2020-02-061-5/+47
| | | | | | | | | | Change-Id: I9e2c44ddcbb6c7e3a92b2bd7d2492ece0cd0e62d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Doc: Explain how to specify multiple paths in QML2_IMPORT_PATHUlf Hermann2020-01-131-0/+7
| | | | | | | | | | | | | | | | And why you cannot specify URLs or resource paths that way. Task-number: QTBUG-69435 Change-Id: Ia6aac89239302bcfe625f4cca877b74be065e800 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* | Generate registrations for all examplesUlf Hermann2020-01-132-12/+9
| | | | | | | | | | | | | | | | Now that we can generate all QML type information at build time, we should also use it. Change-Id: I647c72bbe38fdb2deb565b75c86a696af3d15b61 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* | qmldiskcache.qdoc: Add missing \endtableFriedemann Kleint2020-01-031-0/+1
| | | | | | | | | | | | | | | | Amends 2cfa63e1f1b78ef50dfac3716aab9adf868fe151, fixing: qtdeclarative/src/qml/doc/src/qmldiskcache.qdoc:76: (qdoc) warning: Missing '\endtable' Change-Id: I962b640da3125e7515c507cb6751ca1e82cdac7d Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* | doc: Clarify Q_GADGET limitations in Qt 5Shawn Rutledge2019-12-231-0/+8
| | | | | | | | | | | | Fixes: QTBUG-79640 Change-Id: I7c4377312a337ec5f65389dc4998f1df91e5f67c Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* | Doc: Add a section on the QML disk cacheUlf Hermann2019-12-102-0/+78
| | | | | | | | | | | | | | | | In particular this documents how to disable or force the disk cache, and how to specify a custom cache path. Change-Id: I71e288ba2cd5be53a31ca71f7204b22d33b0545e Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* | Document that you can use QJSValue as list typeUlf Hermann2019-12-101-0/+5
| | | | | | | | | | | | Change-Id: I199d92f05f48f58349d5918e6615018e4b759576 Fixes: QTBUG-79028 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* | Merge remote-tracking branch 'origin/5.14' into 5.15Liang Qi2019-11-227-87/+4
|\| | | | | | | | | | | | | | | Conflicts: src/qml/qml/qqmlextensionplugin.cpp tests/auto/quick/qquicktableview/tst_qquicktableview.cpp Change-Id: Ic58d36a8532015bae30f2690063db9829b3bf372
| * Doc: Fix documentation warningsTopi Reinio2019-11-117-87/+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.14' into 5.15Qt Forward Merge Bot2019-10-262-0/+0
|\| | | | | | | Change-Id: Iaa7dbbe9926d25cfb1b1c51e7013e58cb71d86b5
| * Update flowchart to reflect addition of new methodsFabian Kosmale2019-10-242-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Removed reference to setContextProperty, as we want to deprecate them - Added qmlRegisterSingletonInstance as a different way to register a singleton and as a replacement for setContextProperty - Replaced no-argument qmlRegisterType with qmlRegisterAnonymousType - Restructured graph, removing a few choices Task-number: QTBUG-78952 Change-Id: I1882d3fdd281fd15ae9940127d078457f2942edb Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* | Merge remote-tracking branch 'origin/5.14' into 5.15Qt Forward Merge Bot2019-10-241-9/+11
|\| | | | | | | | | | | | | | | Conflicts: src/qml/qml/qqmlpropertyvalidator.cpp tests/auto/qml/qmlmin/tst_qmlmin.cpp Change-Id: I920c133e839d980ed32c179a0bc4fa44c46e2296
| * Document recent change in allowed alias usageFabian Kosmale2019-10-211-9/+11
| | | | | | | | | | | | | | | | This amends e5f3e7149b7e130c375c1419f1f804dfeaf578aa Task-number: QTBUG-48150 Change-Id: I64c7426143c82d6ee45b07a40e961b7b7c1faf16 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* | Merge remote-tracking branch 'origin/5.14' into 5.15Qt Forward Merge Bot2019-10-111-2/+5
|\| | | | | | | Change-Id: I1359574c7d89aaf3328958e2f667ba1e599ff7f1
| * Merge remote-tracking branch 'origin/5.13' into 5.14Liang Qi2019-10-101-2/+5
| |\ | | | | | | | | | | | | | | | | | | | | | Conflicts: src/plugins/scenegraph/openvg/qsgopenvgcontext.cpp tests/auto/quick/qquickpathview/tst_qquickpathview.cpp Change-Id: I117c8d62b21800329d1035021d312d9924f83a1b
| | * Doc: Add example on how to access types in imported QML from javascriptNico Vertriest2019-10-071-2/+5
| | | | | | | | | | | | | | | | | | Task-number: QTBUG-66194 Change-Id: Ifd81db18a344557f610e45d7c2d4208f014e94b9 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | | Merge remote-tracking branch 'origin/5.14' into 5.15Qt Forward Merge Bot2019-10-081-2/+1
|\| | | | | | | | | | | Change-Id: Ib381f350ada365747ce20b989bfdc368d75f2219
| * | qmlRegisterSingletonInstance: Do not crash if instance gets deletedFabian Kosmale2019-10-071-2/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Use a QPointer, so that we notice if the object has been deleted. Also ensure that in the documentation the function is in a single line, as qdoc will otherwise silently omit it. Change-Id: Idecd370d00089997cd18b3247ad2290a561b2b69 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* | | Merge remote-tracking branch 'origin/5.14' into 5.15Qt Forward Merge Bot2019-10-0419-1386/+32
|\| | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/imports/qtquick2/plugins.qmltypes src/quick/items/qquickitemsmodule.cpp Change-Id: I841c65c9c131354788b4f3fcfe3d7ed27be316d5
| * | doc: Fix several qdoc warningsMartin Smith2019-09-231-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | This update repares several "Can't link to...," "No such parameter...," and "Undocumented parameter..." warnings. Change-Id: I3649cf35f766e5a87ca5df48301e8063a31d7904 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
| * | Fix documentation for qmlRegisterType and qmlRegisterAnonymousTypeUlf Hermann2019-09-191-20/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Plain qmlRegisterType() is deprecated and qmlRegisterAnonymousType() was added in 5.14 as replacement. Also, qmlRegisterAnonymousType() does take an import URI and a major version. The point about non-anonymous type registration is that it also takes an element name. Change-Id: I51fb6f9c63dcf15dc1da10c25ea6c6d3b88fd31a Reviewed-by: Kavindra Palaraja <kpalaraja@luxoft.com>
| * | Re-add documentation for Qt Qml ModelsUlf Hermann2019-09-1714-1352/+0
| | | | | | | | | | | | | | | | | | | | | It got lost when moving the classes. Change-Id: I7b3a9fec8fe9439c548da570e430d3b82613b816 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
| * | doc: Add missing directories to qdocconf filesMartin Smith2019-09-161-2/+8
| | | | | | | | | | | | | | | | | | | | | | | | These might not be complete yet, but they do fix the qdoc errors. Change-Id: I75b0f0f7709a371149a6f7c82adfff9fe88408ea Reviewed-by: Paul Wicking <paul.wicking@qt.io>
| * | Merge remote-tracking branch 'origin/5.13' into 5.14Liang Qi2019-09-123-11/+3
| |\| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/qml/jsruntime/qv4engine.cpp src/quick/handlers/qquicktaphandler.cpp src/quick/items/qquicktableview.cpp Done-With: Richard Moe Gustavsen <richard.gustavsen@qt.io> Done-With: Ulf Hermann <ulf.hermann@qt.io> Done-With: Shawn Rutledge <shawn.rutledge@qt.io> Change-Id: If9558a33f01693ce96420c094e0b57dfff0626cd
| | * Doc: Fix documentation warnings for qtdeclarativeTopi Reinio2019-08-293-11/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | After recent changes to QDoc, it now correctly warns about missing documentation for QML method parameters - fix all of these and also do some minor language editing. Remove duplicated entries for - \qmlmodule Qt.labs.qmlmodels - \group qtjavascript as they were causing issues. Change-Id: I55cd670cc8a0cc6427cdb7945dbd7c28ea94f796 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* | | Doc: Promote writing arrays as enum descriptions in qmltypes filesUlf Hermann2019-09-301-4/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | We won't be able to auto-generate the old syntax when moving to qmltyperegistrar. qmllint already understands the new syntax. Change-Id: I8f20bddcd750e2b3ecfa9d5643bbf1d4d25dc550 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
* | | Doc: Document the most relevant QV4_* environment variablesUlf Hermann2019-09-132-0/+111
|/ / | | | | | | | | | | Change-Id: I5150b39321967708b682eae70e917ddff7bb6b8b Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Kavindra Palaraja <kpalaraja@luxoft.com>
* | qqml.h: add qmlRegisterAnonymousTypeFabian Kosmale2019-08-211-0/+10
| | | | | | | | | | | | | | | | | | This version behaves for the most part like qmlRegisterType(), but it adds a uri and major version, which qmlplugindump can use to put the tpyes into the correct plugins.qmltyes file. Change-Id: I50f620216439a3edc66ac740cb051c2fbb936e51 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* | Merge remote-tracking branch 'origin/5.13' into devLiang Qi2019-07-262-2/+5
|\| | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/quick/handlers/qquickpointerdevicehandler.cpp src/quick/scenegraph/qsgdefaultglyphnode.cpp src/quick/scenegraph/qsgdefaultglyphnode_p.cpp src/quick/scenegraph/qsgdefaultglyphnode_p_p.h tests/auto/qml/qjsengine/tst_qjsengine.cpp Done-With: Jan Arve Sæther <jan-arve.saether@qt.io> Done-With: Laszlo Agocs <laszlo.agocs@qt.io> Change-Id: I35749152f8dce44b9af8d52b1283629879010f11
| * Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-07-241-2/+2
| |\ | | | | | | | | | Change-Id: I081bcb9cc238e6cff5f8a23b684c5d6f76dba047
| | * Doc: fix code snippetPaul Wicking2019-07-191-1/+1
| | | | | | | | | | | | | | | | | | Task-number: QTBUG-77094 Change-Id: I9058bf7b65e8d390327af0624df611de4965f1e4 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
| | * Doc: Fix typos in code snippetsPaul Wicking2019-07-181-2/+2
| | | | | | | | | | | | | | | | | | Fixes: QTBUG-77094 Change-Id: Ia974c4d8abeab48a206fb868ee5532d4aeae7319 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
| * | Doc: Add comment on evaluation order bindingsNico Vertriest2019-07-191-0/+3
| | | | | | | | | | | | | | | | | | | | | Task-number: QTBUG-73742 Change-Id: I42821823ee0315aa96da30798e35809cf0498f67 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-14 04:00:37 +0000