aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src/qtqml.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Doc:: Fix documentation warnings for Qt QMLTopi Reinio2020-11-051-4/+6
| | | | | | Task-number: QTBUG-88156 Change-Id: Ic6127c6128b4c7736cb4b5ab8ce51629388b59ca Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Document how to use CMake for Qt QmlKai Koehne2020-06-231-13/+20
| | | | | | Task-number: QTBUG-73058 Change-Id: Ic27cfdf76b8f77c9834baaeaf449434bf5f28416 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Add a section on the QML disk cacheUlf Hermann2019-12-101-0/+2
| | | | | | | | 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>
* Doc: Use a macro to resolve the QML import versionTopi Reinio2018-09-141-4/+5
| | | | | | | | | | | QDoc now supports macros for its command parameters, as well as passing parameters to \code and \qml commands. Use these together with the new \QtMinorVersion macro to automate bumping the QML import versions within documentation. Task-number: QTBUG-67818 Change-Id: I8b5300749880421a0d7cdacc1b2c0f96b3b7ef67 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Doc: bump import version to 2.12Shawn Rutledge2018-07-241-1/+1
| | | | | | | | | This is important since 2.12 is LTS and because Input Handlers are now included. Change-Id: I09417eb873ed7971fc768dddb916954d46091a6b Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io> Reviewed-by: Martin Smith <martin.smith@qt.io>
* Document latest QtQml import version to be 2.11Kai Koehne2018-04-201-1/+1
| | | | | | | | | Since commit 214fbaa57b73296a0 the latest minor version of the import is automatically the Qt minor version, so let's also document this. Change-Id: I232dcef923f3dfa5a6a2377bc8297b07fbe01f37 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Doc: Do make 'Licenses and Attributions' valid for multiple Qt versionsKai Koehne2018-01-221-2/+3
| | | | | | | | | | | The Qt documentation is supposed to be valid for older Qt versions too. Anyhow, the generated attributions are only valid for the exact version the documentation was generated from, so make this explicit. Also mention since when the libraries are under LGPL3/GPL3. Change-Id: Iec8f67e5e43be456cc77283ca6d2a7ebe142f501 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Fix outdated FDL license headerKai Koehne2017-10-171-5/+5
| | | | | Change-Id: I76dccf547de40b5e72fd7abaa062fa96cb2c118a Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* Add qt_attribution.json file for masmKai Koehne2016-09-191-0/+13
| | | | | Change-Id: Ied24eb3dd3741c913f4a4ec80fe39d0678e46d5c Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Qt QML documentation: fix link that should be in listMitch Curtis2015-09-101-1/+1
| | | | | Change-Id: Ied44c63fab703db5188ec8f829363a4999f85560 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: corrected broken linksNico Vertriest2015-09-081-2/+0
| | | | | | Task-number: QTBUG-43810 Change-Id: Ib47749f95c9ce9db7f2b97726c13ccb9550981e4 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Merge remote-tracking branch 'origin/5.4' into 5.5Oswald Buddenhagen2015-07-201-0/+1
|\ | | | | | | | | | | | | Conflicts: tests/auto/quick/qquickwindow/tst_qquickwindow.cpp Change-Id: I272074fa2ca259439cae2f686325932f7f9d7c01
| * Doc: Added the missing examples \group page for Qt QMLVenugopal Shivashankar2015-06-021-0/+1
| | | | | | | | | | | | | | | | | | The QHP meta info. was trying to link to the Qt Quick page, which failed. This should fix the issue. Task-number: QTBUG-46163 Change-Id: Ib012f8f73b74a51b7a8d4e849070742e94d40973 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* | Update copyright headersJani Heikkinen2015-02-121-6/+6
|/ | | | | | | | | Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Change-Id: I61120571787870c0ed17066afb31779b1e6e30e9 Reviewed-by: Iikka Eklund <iikka.eklund@theqtcompany.com>
* Say hello to the Declarative State Machine FrameworkBrett Stottlemyer2014-08-081-0/+5
| | | | | | | | | | | | | | | | | | The Declarative State Machine Framework extends Qt's State Machine Framework (QSM) into QML to provide types for creating and executing state graphs in QML. This gives you the power of deterministic state machines, but declaratively and without having to write all of the boilerplate code. It is an alternative to the existing QML State type, intended for more complex models. [ChangeLog][QtQML] The Declarative State Machine Framework extends Qt's State Machine Framework (QSM) into QML. This gives you the power of deterministic state machines, but declaratively. Change-Id: I02390ba7f1baed50935364530925bd75087299cb Reviewed-by: Sebastian Sauer <sebastian.sauer@kdab.com> Reviewed-by: BogDan Vatra <bogdan@kde.org> Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Doc: Renamed links to "QML Applications".Jerome Pasion2013-10-151-3/+3
| | | | | | | | | | | "QML Application Developer Resources" is too long and the visible text is usually shortened to "QML Applications". The article in qt5/qtdoc changed title to "QML Applications". Change-Id: I301f3b4659bd87631269b912bcc36f6f00fdeb2c Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Link to QML Qt object in relevant locationsTopi Reinio2013-07-251-1/+4
| | | | | | | | | | There is no obvious path to find the reference for QML Qt object. This change adds links to it in Qt QML module index page and QML Basic Types documentation. Task-number: QTBUG-31921 Change-Id: I8a4ef1b3e696a0a7dec416d759ae64110e59c6c0 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Clarified members of QtQml.Models submodule.Jerome Pasion2013-06-041-0/+13
| | | | | | | | | | | | | | -Took out members of QtQml.Models submodule from Qt QML and Qt Quick. -Set up qdocconf files to include QtQml.Models to be part of Qt QML doc build. -Edited the sentences to make it clearer that list and model types are in QtQml.Models. -Placed the Visual* types back to QtQuick 2 module. -This patch removes several collision pages. Change-Id: I16e7045162af6852e5d6c3162b6f4cf97a42402b Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Fix some broken linksSze Howe Koh2013-05-201-1/+1
| | | | | Change-Id: I1385a8947107a7c80b32306fc587aff45536a4ec Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Un-overload the word "module"Sze Howe Koh2013-04-241-1/+2
| | | | | | | | | | | "The Qt Quick module contains the QtQuick QML module and the Qt Quick C++ module" is an odd way to describe things. The concept of a "QML module" is deeply entrenched so this patch won't touch it, but at least we can get rid of references to "C++ module"s. Change-Id: Ib06f8e3152551901dc6016cb37507cb9608d7863 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Refactored and focused the Qt QML documentation.Jerome Pasion2013-04-231-129/+72
| | | | | | | | | | | | | | | | | Before it wasn't clear to what the module provided, especially with the coupling of Qt QML and Qt Quick. The doc is centered around these documentation: -QML refernce: the language syntax and the application constructs -JavaScript environment: the environment provided by the module -Integration with C++: more about the engine and the C++ API -QML Types and Classes reference (created by \qmlmodule and \module) The distinction are made in the directory and the section titles in the Qt QML landing page. Change-Id: I033bfcbf8368b94ffa5ee4b1225bee74347f53eb Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Fix some titles and linksSze Howe Koh2013-03-301-4/+4
| | | | | | | | | | | | | | | Make page titles follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation. Make class/type list titles follow the "<Qt Module> C++ Classes" and "<Qt Module> QML Types" formats. Links are updated accordingly, along with broken links found during this sweep. Some inline links also have their surrounding text modified, to improve flow. Change-Id: I0ed7788caa250085d7ea0080a77d8a2655debf39 Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Update copyright year in Digia's license headersSergio Ahumada2013-01-101-1/+1
| | | | | | Change-Id: I6c3bd7bebe3d62d1cfd0fa6334544c9db8398c76 Reviewed-by: Akseli Salovaara <akseli.salovaara@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* Change copyrights from Nokia to DigiaIikka Eklund2012-09-231-14/+14
| | | | | | | Change copyrights and license headers from Nokia to Digia Change-Id: Ie7f5d49ed8235d7a7845ab68f99ad1c220e64d5c Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Docs - add missing images and code, clean up sectionsBea Lam2012-08-281-2/+2
| | | | | | | | | | Includes the removal of concepts/modelviewsdata/localstorage.qdoc since that is a duplicate of the existing Local Storage module docs. Also removes classes from whatsnew.qdoc that are internal. Change-Id: I4170c1797bbec09bb67784b0b2ad67fd990365a8 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Fix various doc errorsBea Lam2012-08-281-5/+14
| | | | | | | | Also restore the main module "reference documentation" links added in 0e0f46c01cf6a183996d36c31987ca4a46b50bd9 Change-Id: I421f5a17e2946a2569537d8ba8a021f219aaf75a Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Clean up structure of JavaScript related docsBea Lam2012-08-281-2/+5
| | | | | | | | | | | | | | | | The global object and list of javascript functions should be linked to as subsections from the "JavaScript Host Environment" topic page, and all of the subsections should be visible from the module index page. Also move the "restrictions" docs to this topic page as it's more relevant to this section. Also includes some minor doc improvements. Task-number: QTBUG-26380 Change-Id: Iba6e4e510191bf5e4603d6cbb2826ad7bcdbd10c Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Move the Property Modifier Type documentationChris Adams2012-08-271-1/+0
| | | | | | | | | | | Property Modifier Types are just another sort of QML object type, and don't deserve explicit top-level documentation. This commit moves the docs into the object types documentation, and adds documentation to the syntax page about the "<PropertyModifierObject> on <propertyName>" syntax. Change-Id: Ia9b707739b562d2c8b75fa99b88795ba4d415cf7 Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
* Fix doc linksBea Lam2012-08-241-1/+1
| | | | | Change-Id: Iafbcd39472f3e6f12169ae1a17b4a040dbb9a8a4 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Doc: Tidied links, titles, and HTML pages.Jerome Pasion2012-08-231-21/+11
| | | | | | | | -used "Qt Quick" and "Qt QML" to refer to the module -qtquick-index.html and qtqml-index.html for the landing pages Change-Id: I1569949f7875ac6008a5b80a169e327f93f330ae Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Improve main QtQml and QtQuick doc pagesBea Lam2012-08-091-49/+33
| | | | | | | | | | | Make the content of the two pages more consistent with one another. Also improve the reference documentation sections and fix some links. Also the apireferences.qdoc page is not necessary. Change-Id: I01c5b3757c2ec03b1365e4c9c348e33e06f8315f Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Update imports and module documentationChris Adams2012-08-081-4/+8
| | | | | | | | | | | | | | | | | | Recently, the qmldir syntax was modified to allow a module identifier directive to be specified. This allows us to guarantee that types provided in that namespace are not overridden by other modules. Given this fundamental change, the documentation needed to be updated to reflect the new terminology surrounding imports: - modules - identified vs legacy - directories - local and remote directory imports - JavaScript resources - scripts which can be imported directly Change-Id: I5a3d38de93d0186e79b87f2b3050f2b802088348 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Add type name to singleton (module api) implementations.Glenn Watson2012-08-081-1/+1
| | | | | | | | | | | | | This change renames the previous module api implementation to singleton types. When a singleton type is registered, a type name must be provided that is used when accessing the API from QML. This makes the implementation more consistent with the rest of QML. Task-number: QTBUG-26549 Change-Id: Iab0bb1ccf516bd3ae20aee562a64d22976e0aecd Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Fix various broken links in documentationBea Lam2012-08-031-2/+2
| | | | | Change-Id: I9e2dac37d18e3ca62e4a92be25e5c2e60ffeba00 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Improve QML basic types documentationChris Adams2012-07-301-5/+10
| | | | | | | | | | | | | | | Basic types are provided either by the language (int, string, bool, real, double, date, url, var, variant) or by modules (value types). In 5.1 we would like modules to be able to provide more basic types, and thus a cleaner separation of the documentation makes sense. This patch also improves linking of the term QtQml so that a clear distinction is made between the QtQml QML module and the QtQml C++ Qt Module (the QtQml QML module links now point to the QtQml type reference page). Change-Id: Ibe3ad33e4616c5f29ea38dadc27e13938aedb9d7 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Revise the restructured "Integrating QML and C++" docsBea Lam2012-07-251-6/+7
| | | | | | | | | | | | | | | | | These docs were yet to be cleaned up following the recent doc restructure. This changes most of the the content in these sections and includes some new docs and examples. Currently all the code snippets are included inline. In a later patch, these should be moved into the snippets/ directories and be included using the \snippet command instead. Alternatively they can be moved into examples/ to replace the BirthdayParty examples which are no longer referenced in these docs as of this patch. Task-number: QTBUG-26381 Change-Id: I94e3654e61476fad11fe81042d1bbe94fc649d06 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Correctly link the QML module C++ class documentationChris Adams2012-07-241-6/+5
| | | | | | | | | | | | | Previously, the links for in-depth documentation for the various C++ classes led to non-existent pages instead of the correct class documentation. This commit fixes the links to point to the generated class documentation for each class. Also, fix some broken links in the application developer guide essentials section. Change-Id: I2fa9e0c19f645dec696d80387c436c2288b067bf Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Add documentation about property value modifiersChris Adams2012-07-191-0/+3
| | | | | | | | | | | Previously, property value modifiers were only documented in QtQuick, when really they are a QtQml module / QML language feature. This commit also improves the QtQuick documentation for convenience types, and rearranges some links and content for improved consistency. Change-Id: Ic4dbe0b8bb85bdfbb8ac2f336c13c2960f8d1842 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Minor doc fixesYann Bodson2012-07-181-5/+5
| | | | | | | Don't capitalize minor words in titles to be consistent with Qt doc. Change-Id: Ib39ec50d7f9730a5bbf2b574ade8270e9290ec90 Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* Remove the syntax topic page from docsChris Adams2012-07-171-1/+1
| | | | | | | | | This page was superfluous and missing lots of content. This change ensures that we don't link to it, and instead links to the correct subsection of the main page of documentation. Change-Id: I97a944f517fb5d21319811f63c810e0e79cd330c Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Improve QtQml module documentationChris Adams2012-07-161-2/+2
| | | | | | | | | | General improvements, including: - fixing broken links - improving topic page content - fixing incorrect qdoc commands Change-Id: I50b6733b51cdabf9cecd96046f6e7f41260a9a4b Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
* Improve object attributes documentationChris Adams2012-07-131-6/+4
| | | | | | | | | | | | There is no conceptual difference between custom attributes (custom properties, signals and methods defined in QML object declarations) and non-custom attributes (defined in C++). This change coalesces the documentation for the different attribute types, and also fixes some line wrapping issues. Change-Id: I8cb8d71025e873523cb4389827eef7967e49a626 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Merge old "Modules" docs into new doc structureBea Lam2012-07-111-3/+4
| | | | | | | | | | | | This removes modules/todo.qdoc which contained the old "Modules" documentation page and merges this content into the new Modules documentation. Also cleaned up the structure of the "qmldir" docs. Task-number: QTBUG-26378 Change-Id: Idc8800d0595647eb7064ecadc5a00254341ed1e8 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Reorganize "concept" pages in QtQuick docsBea Lam2012-07-051-1/+0
| | | | | | | | | | | | | | | | | This removes concepts/topic.qdoc and move this content into individual concept topic pages under individual directories for each concept to avoid having a really long "concepts" index page. This change also: - Moves components.qdoc ("Defining reusable components") into the appdevguide/ since it's not specific to QtQuick features - it's more about how to use a QtQml feature to build QML apps. - Moves the part of qtqml/doc/src/cppintegration/data.qdoc that discusses how to use C++ models with QtQuick views into quick/doc/src/concepts/modelviewsdata/data-cppmodels.qdoc. Change-Id: Id18a1d56acaaac41714c13cbc94bb3b80f337355 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Reorganise release notes for QtQml and QtQuickBea Lam2012-06-271-0/+1
| | | | | | | | This separates the "what's new" docs into different pages under qml/ and quick/ and reorganizes the content structure. Change-Id: I8a9c437caec75178c44b89b40507ea50f1b8faff Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Create new documentation structureChris Adams2012-06-211-332/+162
| | | | | | | | | | | | | | | | | | | | The documentation currently has no clear separation between Qt QML and Qt Quick. With recent commits like: 6c8378eaf1edbbefe6aaa3672b0127816a004fd7 and ab1e510121c8a679fdaca12ccd30e0f7ac12a26b the separation between the language definition and implementation, provided by Qt QML, and the standard library for the QML language, provided by Qt Quick, is clear. This commit creates a new documentation structure that is more navigable and separates concepts into logical categories, with clear separation between QtQML and QtQuick. It also provides a more generic QML Application Developer Resources page which contains links to information for QML application developers. Change-Id: Ia807ccfbfd24ffa0e1c7f0a51ed9d2ed3aa6a733 Reviewed-by: Martin Jones <martin.jones@nokia.com>
* Remove non-templated qobject module api registration functionChris Adams2012-06-121-9/+0
| | | | | | | | | | | | | Previously, both templated and non-templated qobject module api registration functions were provided as public API. The non-templated version is identical to the templated version, except that bindings which access properties of module apis registered with that function cannot be optimized with v4. This commit removes the non-templated version of the function. Change-Id: Ic417aa241f1172bf6d055bdc7f528d7e9304097b Reviewed-by: Martin Jones <martin.jones@nokia.com>
* Doc: Moving QML docs for new doc structureJerome Pasion2012-05-091-0/+371
Change-Id: Id51e2cf10e8b5c5559bc4a375cb2db46c40bdf0a Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-26 23:35:53 +0000