aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src
Commit message (Collapse)AuthorAgeFilesLines
* Remove extra colonZhang Hao2021-04-241-1/+1
| | | | | | | | | | | JavaScript Grammatical errors, There should be no colon after the function brackets Fixes: QTBUG-93048 Change-Id: I902d490bf810fa60e3b3d2a76de7902345289cfe Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> (cherry picked from commit df8e6136834326e363db49829d227a303e5425ed) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Document that QML_SINGLETON only works with QObjectsMitch Curtis2021-04-201-10/+11
| | | | | | | Change-Id: I18c38037cd635fa3300c761b16038b67ac3b0d74 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> (cherry picked from commit 03a2e51063de99f85b3b801c7ccd6663163a61b0) Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Fix broken QDoc markupPaul Wicking2021-01-051-2/+2
| | | | | | | | | | \code must be closed with \endcode. Fixes: QTBUG-89738 Change-Id: I0cadb14b6726a6fdc6c3fb773155066d30490e74 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> (cherry picked from commit 357e426d9849a048d3063030f2a1355f22c259e0) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Fix qdoc warning, document macro parameterVolker Hilsheimer2020-12-041-1/+1
| | | | | | | | Change-Id: I60c3d9cc34bc658d5317da951cc1975990f27a9b Reviewed-by: Andreas Buhr <andreas.buhr@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Maximilian Goldstein <max.goldstein@qt.io> (cherry picked from commit e070e571d184b4f6eb1f065009aac0779d004f29)
* qmlfunctions.qdoc: Add QML_IMPLEMENTS_INTERFACESMaximilian Goldstein2020-12-041-1/+16
| | | | | | | Change-Id: I4ff76b49bd5f40eb58c9f44669bb4836dd9e48be Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> (cherry picked from commit 7b89ae6ef4158dcbd1940e088c84eba747c166bc) Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Fix usage of oldcode and newcode in qt6-changes.qdocAndreas Buhr2020-12-021-2/+2
| | | | | | | | | | | There was wrong usage of \begincode and similar commands. This patch fixes it. Task-number: QTBUG-88533 Change-Id: I70b3d0104ba1dc8eb44556f35fc552e259317f88 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> (cherry picked from commit ed098189d5809259378dc9a427a6fe6e303582ba) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Porting guide: Document URL resolution changeFabian Kosmale2020-11-301-0/+22
| | | | | | | | Task-number: QTBUG-88965 Change-Id: Ib62082935ddba7bf5b359a32712e6799b3242091 Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit e2a74579850d89d229dad918404a8d8ecebb80b3) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Remove version numbers for import statementJerome Pasion2020-11-263-22/+21
| | | | | | | | | | | | -recommend using the import statement without versions for Qt 6.0 -update use of \qml snippet without \QtMinorVersion -some language change to be neutral about versions Task-number: QTBUG-87155 Change-Id: I3ac44f93aab3086c1a49de79ecc677beb4ef9180 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> (cherry picked from commit 72746ef0ad69d589de91f43aa2043d6e47745d68) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: Remove version numbers for import statementJerome Pasion2020-11-241-2/+2
| | | | | | | | | | | -recommend using the import statement without versions for Qt 6.0 -update use of \qml Task-number: QTBUG-87155 Change-Id: I555d582a13006c5abb6dc1e0266d2987ba79c6d8 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> (cherry picked from commit 370fe537badd2b98c2da7f8918a15411d5aa67ad) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* qmlfunctions.qdoc: Add clarification to QML_FOREIGNMaximilian Goldstein2020-11-231-0/+4
| | | | | | | | Fixes: QTBUG-87150 Change-Id: If99a06a07892bdfef7b6b1e8fa737480750992fe Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> (cherry picked from commit 56f428c360191230b571969a2651e85380030afa) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Doc: mention that INCLUDEPATH must be set in some casesMitch Curtis2020-11-211-0/+8
| | | | | | | | | | Otherwise the generated type registrations .cpp file will not be able to include the sources. Change-Id: I7821c7674b4341546da2fc49e584bf10cc60b46f Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> (cherry picked from commit 06c31f386f8664343debd219a522a8897df0f3ec) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
* Porting guide: mention qmlDebug/Info/WarningFabian Kosmale2020-11-191-3/+3
| | | | | | | | Also don't mention qmlExecuteDeferred: That one is internal anyway (albeit not explicitly marked as such yet). Change-Id: Icef5fb4092b6a109613ae1f2e90fcff93d7c0b4b Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Porting Guide: Mention QQmlListProperty changeFabian Kosmale2020-11-171-1/+25
| | | | | Change-Id: I173e2ff05b3fc3bbe56df423abcbfc84bdc2a17a Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Rename "Porting" pages to "Changes"Jerome Pasion2020-11-091-2/+2
| | | | | | | | | | | | | | The content in the porting guides are closer to a changelog than a porting guide. At this point, it is easier for maintainers and contributors to write in a changelog than a guide. This change should help with readability and is closer to the usage of "Changes" in documentation. Part of a rename in other submodules. Task-number: QTBUG-87156 Change-Id: Ibb58a3cba5394962a5709aeb08e3701e16c7775d Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
* Doc:: Fix documentation warnings for Qt QMLTopi Reinio2020-11-053-12/+11
| | | | | | Task-number: QTBUG-88156 Change-Id: Ic6127c6128b4c7736cb4b5ab8ce51629388b59ca Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* QML: Fix typo in documentationUlf Hermann2020-11-021-1/+1
| | | | | Change-Id: I6018e1585c6f9b778d8f8559b3f1fb9486411bff Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* QML: Allow singletons to be created with a factory functionUlf Hermann2020-11-021-6/+8
| | | | | | | | | | This is in line with what we do on qmlRegisterSingletonType(), and it allows us to return singleton objects created independently of the instantiation mechanism. Change-Id: Ia6a077f5d22241593acd8cc87b3f65ae20f95667 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io> Reviewed-by: Maximilian Goldstein <max.goldstein@qt.io>
* QML: Allow namespaces as extensions to typesUlf Hermann2020-11-022-5/+22
| | | | | | | | | | | | | | | | | This way we can access the enums of namespaces as properties of the primary type. This is achieved by: 1. Making enums of extended types available in the base type 2. Allowing the extension to be specified as plain metaObject rather than as type name. 3. Refraining from creating the extension if the create function does not exist. The goal of this is to declare the Qt namespace in a civilized way, but will also help with cleaning up the QtQuick value types and their enums. Change-Id: I13399741d30ce38d1bff753cfa1b11e72ccfbf6a Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Migration guide: cover removal of deprecated functionsFabian Kosmale2020-11-021-0/+102
| | | | | | Change-Id: I9e35d84940652d6de02cb7bd18bbb25f3e111184 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* QML migration guide: Add initial contentFabian Kosmale2020-10-291-1/+29
| | | | | | | | | Add information about the variant/var unification. Remove place-holder sentence. Change-Id: I79bb230820eab71fea72929a24fb8c1b0479b256 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Add porting guides for all modules to porting guidePaul Wicking2020-09-161-0/+46
| | | | | | | Task-number: QTBUG-84051 Change-Id: Iffc8774898dba5bda329fa572289cc0134fddb6f Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Document QML_FOREIGN_NAMESPACE() macroFawzi Mohamed2020-08-271-1/+20
| | | | | Change-Id: I5793df82849f06e2d870335c3c17902e452399a4 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Unify "variant" and "var" properties in QMLFabian Kosmale2020-08-241-95/+0
| | | | | | | | | | | | | | | | | | | | variant and var properties differ in two important ways: - variant properties trigger "magic" string conversions: variant v1: "red" // contains a QColor var v2: "red" // contains a string - variant properties behave differently for value types: they create copies, instead of references. However, as variant properties were marked as obsolete and this behavior was effetively undocumented, it should be safe to give "variant" "var semantics". With this change, we can also avoid doing magic conversions when storing data in QVariant properties of QObjects/QGadgets Change-Id: I549b1beb98e6af9639c1ee81f316bda513d5ff65 Reviewed-by: Lars Knoll <lars.knoll@qt.io> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Remove qml statemachine plugin from qtdeclarativeKarsten Heimrich2020-08-231-328/+0
| | | | | | Task-number: QTBUG-80316 Change-Id: I584b699a1eec88117f343870bd2cd01075da64f7 Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
* docs: Mention URL object in url documentationMaximilian Goldstein2020-07-091-0/+5
| | | | | | Task-number: QTBUG-54988 Change-Id: I41c9cd0488db338b5dc1a2d5b8c4d707770b6ba8 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* doc: Explain how to work around the linker removing registrationsUlf Hermann2020-07-021-0/+17
| | | | | | | Fixes: QTBUG-83402 Pick-to: 5.15 Change-Id: Ie8dc93afb3c3333d1263dcf0f13b41c833de91d5 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc:Update docs with cmake package informationNico Vertriest2020-07-021-0/+1
| | | | | | Task-number: QTBUG-85179 Change-Id: I14a1d01c8e983021461f72c5108383f4b277478b Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Discern between "auto" and versioned imports in qmldirsUlf Hermann2020-06-241-0/+17
| | | | | | | | | | | | | You can now import the latest version, a specific version, or, "auto" which is the same version as the parent module. [ChangeLog][QtQml] You can now procedurally add module imports to modules, using qmlRegisterModuleImport(). However, actual import statements in qmldir files should be preferred wherever possible. Fixes: QTBUG-84899 Change-Id: I3b32dd8b07a19d31b6538b9a6bb436840862f345 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Document how to use CMake for Qt QmlKai Koehne2020-06-232-25/+20
| | | | | | Task-number: QTBUG-73058 Change-Id: Ic27cfdf76b8f77c9834baaeaf449434bf5f28416 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Update QML connection inline snippetPaul Wicking2020-06-221-1/+1
| | | | | | | | Pick-to: 5.15 Fixes: QTBUG-85177 Change-Id: I52f0f8a24e53051aff984cabd414bbfa73fe098e Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Revert "Decode directory separators in source URLs"Ulf Hermann2020-06-221-3/+1
| | | | | | | | | | | | | | | | This reverts commit 7ec30c51b287159377761338fe6d3b48706d74ee. We don't want to half-decode directory separators on assignment. This just introduces inconsistency down the line. [ChangeLog][QtQml][Important Behavior Changes] Percent-encoded directory separators in URLs are not automatically decoded on assignment to url properties anymore. This was obviously not a good idea to begin with. Fixes: QTBUG-81244 Change-Id: I1938abbe8aada88beff0d628397674255e8b2472 Reviewed-by: Andy Shaw <andy.shaw@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Doc: Improve documentation for DateKai Koehne2020-06-121-12/+36
| | | | | | | | | | | | | | | Structure the overview more by adding section titles. Also be more elaborate on what the enum's mean for the different parts/methods. Finally, make it explicit that NarrowFormat for date and time is the same as ShortFormat. Pick-to: 5.15 Fixes: QTBUG-83841 Change-Id: I0a93361fcc8e30f1080938976d8e0b2d5a55e563 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Doc: Update example of QML int valueYuya Nishihara2020-06-121-1/+1
| | | | | | | | | Item width and height are real numbers. Let's pick other property of int type. Pick-to: 5.15 Change-Id: I43e74e4005681d570047648e2c141994a075150e Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: Clarify exact range of QML int valueYuya Nishihara2020-06-121-1/+1
| | | | | | | | | The original definition "around -2000000000 to around 2000000000" was unscientific and would make a false impression that full 32bit integer range wouldn't be supported. Change-Id: I712eb35dee05410f50572a12af98365013efeb62 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Allow QML plugins to be optionalUlf Hermann2020-06-091-1/+6
| | | | | | | | | | | If a plugin does nothing but load the library that provides the types, we can skip the plugin loading by linking the library directly. State that in the qmldir file, and evaluate it when loading the module. Task-number: QTBUG-84639 Change-Id: I2097237866a50f66c55e4653ad119fe10e18a893 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Add missing since to qmlRegisterSingletonType docsNicolas Fella2020-05-191-0/+1
| | | | | | | | It's relatively new, so better reflect that in the API docs. Pick-to: 5.15 Change-Id: Iedd8e545228a47d8fcb9ec294a723b5fcd1afe75 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Remove the last traces of qmlplugindump from the documentationUlf Hermann2020-05-191-15/+9
| | | | | | | | | People should use qmltyperegistrar instead. We have plenty of documentation for it. Change-Id: Ib74909cb31cf856cbf80ec964959126638af08e9 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Add a default message to QML_UNCREATABLEMaximilian Goldstein2020-05-061-0/+2
| | | | | | | | | [ChangeLog][QML][Feature] Add a default message to QML_UNCREATABLE when proving an empty string as a reason Fixes: QTBUG-83842 Change-Id: Ifd2044fa6c56c3a382d451ec47d5f92a1ac16b81 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Doc: add code example to QML_NAMED_ELEMENTMitch Curtis2020-04-291-0/+10
| | | | | | | | I always forget that you don't pass a string. Pick-to: 5.15 Change-Id: Ied1bf64c8da5e37c38dab8633c048ce4851f8fc4 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Merge remote-tracking branch 'origin/5.15' into devQt Forward Merge Bot2020-04-092-0/+6
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/qml/jsruntime/qv4executablecompilationunit.cpp src/qml/jsruntime/qv4executablecompilationunit_p.h src/qml/qml/qqmlobjectcreator.cpp src/qml/qml/qqmlpropertycachecreator_p.h src/qml/qml/qqmltypecompiler.cpp src/qml/qml/qqmltypedata.cpp tests/auto/qml/qmlformat/tst_qmlformat.cpp tools/qmllint/scopetree.cpp src/qml/qml/qqmlapplicationengine_p.h Adjusted tools/qmllint/findunqualified.cpp to use newer API Change-Id: Ibfb4678ca39d626d47527265e3c96e43313873d4
| * 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>
* | Merge remote-tracking branch 'origin/5.15' into devQt Forward Merge Bot2020-03-201-1/+1
|\| | | | | | | Change-Id: I6f320ea43b5837444226228c118e57c4bda8702a
| * 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.15' into devQt Forward Merge Bot2020-03-091-0/+19
|\| | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: src/qml/compiler/qqmlirbuilder_p.h src/qml/qml/qqmlpropertycachecreator_p.h src/qmltyperegistrar/qmltypesclassdescription.cpp src/qmltyperegistrar/qmltypesclassdescription.h src/qmltyperegistrar/qmltypescreator.cpp src/quick/items/qquicktext_p.h src/quick/util/qquickvaluetypes_p.h Change-Id: Ic209741592e7b85820bf3845722023a190ebc1c5
| * 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>
* | | Merge remote-tracking branch 'origin/5.15' into devQt Forward Merge Bot2020-02-218-74/+75
|\| | | | | | | | | | | | | | | | | | | | Conflicts: tests/auto/quick/qquickmousearea/BLACKLIST Change-Id: I3de2c6377d57f5f9204d2cfc688d50a7a0b4150c
| * | 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-204-15/+17
| | | | | | | | | | | | | | | | | | Fixes: QTBUG-82313 Change-Id: I7c2f30411ab8011254d7c232c87cb12a39761bda Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-14 05:52:08 +0000