aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src/syntax
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Refactored and focused the Qt QML documentation.Jerome Pasion2013-04-236-2170/+0
| | | | | | | | | | | | | | | | | 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>
* Update copyright year in Digia's license headersSergio Ahumada2013-01-106-6/+6
| | | | | | Change-Id: I6c3bd7bebe3d62d1cfd0fa6334544c9db8398c76 Reviewed-by: Akseli Salovaara <akseli.salovaara@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* Remove TODO from docs as it doesn't make sense.Gunnar Sletta2012-11-271-4/+0
| | | | | Change-Id: If23707d5778c6f97e9c9565ac1c5e23d5729fdc4 Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
* Use the new QLibraryInfo::Qml2ImportsPath path for QML 2.Thiago Macieira2012-11-191-3/+3
| | | | | | | | | | Also change the environment variable to be QML2_IMPORT_PATH. This splits the imports from QML 1 (the QtDeclarative library). Change-Id: Icadbf96283b1cf071ed0deb04e8c8476da664009 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com> Reviewed-by: Christopher Adams <chris.adams@jollamobile.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Change copyrights from Nokia to DigiaIikka Eklund2012-09-236-84/+84
| | | | | | | 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-7/+7
| | | | | | | | | | 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-8/+8
| | | | | | | | Also restore the main module "reference documentation" links added in 0e0f46c01cf6a183996d36c31987ca4a46b50bd9 Change-Id: I421f5a17e2946a2569537d8ba8a021f219aaf75a Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Improve docs related to visual parent conceptBea Lam2012-08-282-1/+2
| | | | | Change-Id: I73cc63c8a55cf949b94a2fa502cb331fb8adbda3 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Clean up structure of JavaScript related docsBea Lam2012-08-281-1/+1
| | | | | | | | | | | | | | | | 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-0/+28
| | | | | | | | | | | 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>
* Update imports and module documentationChris Adams2012-08-082-61/+379
| | | | | | | | | | | | | | | | | | 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-4/+2
| | | | | | | | | | | | | 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>
* Add specifics of attached property syntaxBea Lam2012-08-031-0/+7
| | | | | Change-Id: Ia5f40e3d65ed8af2f9a14e3f44a1d41160ddf143 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Fix various broken links in documentationBea Lam2012-08-035-10/+10
| | | | | Change-Id: I9e2dac37d18e3ca62e4a92be25e5c2e60ffeba00 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Use \b instead of \boldBea Lam2012-08-021-3/+3
| | | | | Change-Id: Ica77b78b113321f962066f1edabd34bf21d38910 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Update docs now that all basic types can also be property typesBea Lam2012-08-021-32/+18
| | | | | Change-Id: I9f90627dc3f83e64e6d1d7b2937fdf5653a063f3 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Document readonly property syntaxBea Lam2012-08-011-1/+28
| | | | | | | Reviewed-by: Chris Adams <christopher.adams@nokia.com> Change-Id: Ibaf68b39526824098aa67f7d1fdce6d12e3b3111 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* More consistent coding style through QML documentation.Yann Bodson2012-07-201-1/+1
| | | | | Change-Id: Ieeda1b22d30917dc9614b34d6ae4d41e0062478b Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* Fix links in QML documentation.Yann Bodson2012-07-201-1/+1
| | | | | Change-Id: Ifd6a6cae8b0937548be23f36a23073f2b07e09b2 Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* Make title capitalization more consistent in QML documentation.Yann Bodson2012-07-205-36/+36
| | | | | Change-Id: Iec8168135676e0e9e130bd2245ef33fd780829d5 Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* Doc fix: close code blocks properlyYann Bodson2012-07-191-1/+2
| | | | | | Change-Id: Id4f9e9cb9f37fcc13021c5e6582cf1daaa256438 Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Remove the syntax topic page from docsChris Adams2012-07-171-154/+0
| | | | | | | | | 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 object attributes documentationChris Adams2012-07-132-215/+522
| | | | | | | | | | | | 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-5/+32
| | | | | | | | | | | | 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>
* Fix broken value-type support by allowing property definitionChris Adams2012-07-111-1/+1
| | | | | | | | | | | | | | | | | | | | | In QtQuick 1.x the "variant" property type was supported, which could be used to allow value type properties to be defined in QML. In QtQuick 2.0, we have deprecated the "variant" property, but its replacement ("var") is not suited for defining lightweight C++ type values (such as QColor, QFont, QRectF, QVector3D etc). This commit allows those QML basic types to be used in QML once more, by supporting them in the property definition syntax. Note that since some value types are provided by QtQuick and others are provided by QtQml, if a client imports only QtQml they can define but not use properties of certain types (eg, font). Task-number: QTBUG-21034 Task-number: QTBUG-18217 Change-Id: Ia951a8522f223408d27293bb96c276281a710277 Reviewed-by: Matthew Vogt <matthew.vogt@nokia.com>
* Create new documentation structureChris Adams2012-06-216-0/+1628
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>