aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge "Merge branch 'stable' into dev" into refs/staging/devSergio Ahumada2013-08-065-9/+15
|\
| * Merge branch 'stable' into devSergio Ahumada2013-08-055-9/+15
| |\ | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: I06f79bcbde13c7b12905492a17dbcbb4a594e557
| | * Doc: Link to QML Qt object in relevant locationsTopi Reinio2013-07-252-1/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| | * Link between "QML Basic Type: date" and QML Date object documentation.Mitch Curtis2013-07-233-8/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The basic date type seems useless if you don't know it can be used as as JavaScript date (with QML extensions). Task-number: QTBUG-32492 Change-Id: I14962f4e57522f5515f0e78d484aa59fcd9dff3c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | | Doc: Updated Qt QML and Qt Quick module pages.Jerome Pasion2013-08-051-0/+2
|/ / | | | | | | | | | | | | | | -added \qtvariable -added Qt QML to the modules group Change-Id: I524bbcea501b7ab5ea49482de0119e3e6d630065 Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-07-041-0/+2
|\| | | | | | | Change-Id: I15cb7460171b38d11d66367aeb0831ec6e3ca933
| * QtQml: document QQmlExtensionPlugin::baseUrlShawn Rutledge2013-06-281-0/+2
| | | | | | | | | | | | | | | | | | | | | | It was added here https://codereview.qt-project.org/#change,47532 without documentation. Also updated \since because for now qdoc seems to interpret \since 5.0 as QtQml 5.0. Task-number: QTBUG-31928 Change-Id: I652e9471f1ad8e83b355bffc8498a6565dc9aa2b Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-06-271-0/+5
|\| | | | | | | Change-Id: I59f34fafd795694981dd1edffca1d322657f1ae6
| * Update 5.1.0 changelog and what's newAlan Alpert2013-06-251-0/+5
| | | | | | | | | | | | | | All the new features should now be listed in those two documents Change-Id: Ifa17581bf589f3a18b602f8a1d10683a5e48c70d Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
* | Doc: Adding landing page names to navigation variables.Jerome Pasion2013-06-251-0/+4
|/ | | | | | | | | -used by the navigation bar in the HTML output Change-Id: If4689381fb01c0a6fe8adbd966ead1377942a101 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Fixed QCH listings for Qt QML and Qt Quick DialogsJerome Pasion2013-06-061-1/+5
| | | | | | | | | Qt QML: added QML types page as a child in the list Qt Quick Dialogs: "manual" as type taken out Change-Id: I95d77b7582a0f5729801e1e6fb8f5f3242a0b760 Reviewed-by: Caroline Chao <caroline.chao@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Clarified members of QtQml.Models submodule.Jerome Pasion2013-06-044-8/+29
| | | | | | | | | | | | | | -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>
* Deprecate the with statement in QMLSimon Hausmann2013-05-311-0/+9
| | | | | | | | | | | | | It is generally considered deprecated in JavaScript and its use disables a whole range of optimizations that we would like to apply in the future. Therefore this patch will issue a warning if the with statement is detected. This change is also documented, along with the plan on enabling strict mode in the future. Change-Id: Ie60f0536e0bdd6ecc537d8e34efbd8868bcad743 Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Doc: Added Qt 5.1 details in Qt QML's release notes.Jerome Pasion2013-05-301-1/+22
| | | | | Change-Id: Ie5a4199563b22c21d7be009aeb85206670b84642 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Fix some broken linksSze Howe Koh2013-05-202-2/+2
| | | | | Change-Id: I1385a8947107a7c80b32306fc587aff45536a4ec Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Inline a short snippetSze Howe Koh2013-05-161-61/+0
| | | | | | | | | | An indirect way of fixing a broken snippet path. The entire (but very short) file is included as a snippet in only one place, and the license text takes far more space than the snippet. Change-Id: I6f4bf588b8701b655d418a71f83a2f9263d6b532 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Move snippet into correct moduleSze Howe Koh2013-05-161-125/+0
| | | | | | | | The snippet belongs to Qt Quick's "QML Basic Type: color" (src/quick/doc/src/qmltypereference.qdoc) Change-Id: I47defee04c34f9c98ec57d840c377c680d114d71 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Update references to QDeclarative* classesSze Howe Koh2013-05-151-1/+1
| | | | | Change-Id: Ifbde8c1ccfc0c759da6f2204320b9170a04179eb Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Removed pages from the "qml-features" group.Jerome Pasion2013-05-151-2/+0
| | | | | | | | | -This group is from Qt 4 and no longer relevant in Qt 5. -The \group page in qtdoc is removed. Change-Id: I6349a9056ae45c98b31c70fd693adecf71e2ba8c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Doc: Fixed a bunch of missing snippets.Jerome Pasion2013-05-155-4/+276
| | | | | | | | -moved delegate model related snippets from Qt Quick to Qt QML. -corrected snippet paths Change-Id: If688f97fb9317def16f343d5502a6a54d6761e95 Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Doc: Define Qt global object as a QML type and fix referring docsTopi Reinio2013-05-157-20/+20
| | | | | | | | | | | This change adds the Qt global object as a QML type in the Qt QML module and fixes links to it in documentation. Task-number: QTBUG-29353 Change-Id: I1690224091a79a3309fac7a78aa0c0c734449e4f Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Move xmlrole.qml to the correct locationJan Arve Saether2013-05-081-81/+0
| | | | | | | | | The snippets that qqmlxmllistmodel.cpp referred to could not be found. xmlrole.qml is only referenced from src/imports/xmllistmodel/qqmlxmllistmodel.cpp Change-Id: I95f962927097cd9d3295fbc2b376a9ab27ae6e5c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Add qmlClearRegisteredTypes FunctionAlan Alpert2013-05-071-0/+14
| | | | | | | | | | | Registered types are stored in a global static variable, not on an engine instance. For applications managing multiple engines over their lifetime, there needs to be a way to clear the existing types so they can register new ones and avoid memory leaks. Task-Number: QTBUG-28572 Change-Id: Ic70a4dd1e29d99399b21fb42eaf10d4a52bf2adf Reviewed-by: Christopher Adams <chris.adams@jollamobile.com>
* Doc: Fix some broken snippet pathsSze Howe Koh2013-05-061-2/+2
| | | | | Change-Id: Ib79bfbea402b86e26a503de47383522317ca906b Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Move example docs related to QtQml under the correct moduleTopi Reinio2013-05-031-48/+48
| | | | | | | | | | | This change moves 'Extending QML' qdoc file and the tutorials from examples/quick to examples/qml, which is the correct location for them. Change-Id: I24bd9dfa75baaab7bc8efe08489f09a7b65d98a6 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Elaborate on versioning docsAlan Alpert2013-05-011-0/+5
| | | | | | Task-number: QTBUG-30808 Change-Id: I1930bd91a6c2089047ac7e7d74da2c977c522e07 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Changed order of pages in QML reference.Jerome Pasion2013-04-301-9/+10
| | | | | | | | | | | | | New order: QML Syntax Basics QML Object Attributes Property Binding Signal and Handler Event System Integrating QML and JavaScript [etc.] Change-Id: I19e6fc10e36963362dd862feeb697f942902aaac Reviewed-by: Bea Lam <bea.lam@jollamobile.com>
* Doc: Moved "QML Application Developer Resources" to qtdoc repository.Jerome Pasion2013-04-294-108/+1
| | | | | | | | | | The guide is more relevant to Qt, not just Qt QML and Qt Quick. It would need to include information about the tools and other Qt modules which provide QML types. Change-Id: I0cab0db015022dd27f08811a88ea4a6c3c6e917d Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Doc: corrected snippet issue by changing extension snippet file.Nico Vertriest2013-04-252-10/+51
| | | | | | | | | | | | Task-number: QTBUG-30746 Changed in deployment.qdoc Deleted example.qrc Created example.qdoc Added license text to example.qdoc Change-Id: I9699dcdb4977506c0a62d1a9e952c98babfaf03d Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Expand example (importing multiple modules into 1 namespace)Sze Howe Koh2013-04-251-2/+9
| | | | | | | | | Snippet is for the Qt QML "Import Statements" page. Show how to use the namespace to reference types from different modules Change-Id: I8c49703194a18657439afdef75e47ff7e97be653 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Replace some references to NokiaSze Howe Koh2013-04-242-3/+3
| | | | | | | Link to internal QDoc pages, or to qt-project.org Change-Id: I5d9adae711213873ab57ccfc5bb2d8f74cf5689b Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Un-overload the word "module"Sze Howe Koh2013-04-246-8/+9
| | | | | | | | | | | "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: Create links to Qt Quick 1Sze Howe Koh2013-04-241-1/+1
| | | | | | | | | | | Point to the porting guide, so that users who search for the old names will be directed to an explanation of the name change. Also made some new links to Qt Quick 2, and changed "favour" -> "favor" (Sanity Bot complained) Change-Id: If30c8d619d8fdb9df72b7b5f3efd356f1e07b23a Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Qt Quick: Fix module name format (Pt 2/2)Sze Howe Koh2013-04-232-3/+3
| | | | | | | | | | | | Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation Attempt to differentiate between the whole module ("Qt Quick") and the QML import ("QtQuick") by encoding the latter with monospace font. There are places in the text where both representations are valid. Change-Id: If398304757e0a5106542c09099e1814084e54c5c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Qt Quick: Fix module name format (Pt 1/2)Sze Howe Koh2013-04-2311-25/+25
| | | | | | | | | | | | Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation Attempt to differentiate between the whole module ("Qt Quick") and the QML import ("QtQuick") by encoding the latter with monospace font. There are places in the text where both representations are valid. Change-Id: Id6e157a4191aaa4e23a9cd5c76abfe902fe43d33 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Reinstating \qmlmodule page.Jerome Pasion2013-04-231-0/+53
| | | | | | | Was removed in an earlier commit. Change-Id: I1fdaf6c7e1e522f6ba7e36a20040b8222b1714cc Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Refactored and focused the Qt QML documentation.Jerome Pasion2013-04-2323-263/+201
| | | | | | | | | | | | | | | | | 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: Qt QML: Fix module name formatSze Howe Koh2013-04-194-10/+10
| | | | | | | | | | Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation QtQml -> Qt QML Change-Id: I45ca4496a02214feab48707b026c6bec085df138 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Reassigned types and pages to their correct modules.Jerome Pasion2013-04-174-7/+3
| | | | | | | | | | | | 1)Moved classes and basic types to \module QtQml 2. -QQml* classes are in QtQml 2 for 5.1 2)Removed \inqmlmodule commands in overviews and tutorials. -Only QML API should have \inqmlmodule commands because they are added to the auto generated list of types. Change-Id: I9aa3ca8062fa9fed76734885829879122841b119 Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Add required include statement for qmlRegisterSingletonType docsTopi Reinio2013-04-161-5/+7
| | | | | | | | | Adds a missing include for QtQml into QQmlEngine class reference code snippets. Task-number: QTBUG-30642 Change-Id: I2ec10de5b31b4854d5aaea08987b9d75926d2ef4 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Merge remote-tracking branch 'origin/release' into stableFrederik Gladhorn2013-04-032-6/+8
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: examples/qml/xmlhttprequest/doc/src/xmlhttprequest.qdoc examples/quick/accessibility/doc/src/accessibility.qdoc examples/quick/animation/doc/src/animation.qdoc examples/quick/canvas/doc/src/canvas.qdoc examples/quick/draganddrop/doc/src/draganddrop.qdoc examples/quick/imageelements/doc/src/imageelements.qdoc examples/quick/keyinteraction/doc/src/keyinteraction.qdoc examples/quick/localstorage/doc/src/localstorage.qdoc examples/quick/mousearea/doc/src/mousearea.qdoc examples/quick/particles/affectors/doc/src/affectors.qdoc examples/quick/particles/customparticle/doc/src/customparticle.qdoc examples/quick/particles/emitters/doc/src/emitters.qdoc examples/quick/particles/imageparticle/doc/src/imageparticle.qdoc examples/quick/particles/system/doc/src/system.qdoc examples/quick/positioners/doc/src/positioners.qdoc examples/quick/righttoleft/doc/src/righttoleft.qdoc examples/quick/scenegraph/customgeometry/doc/src/customgeometry.qdoc examples/quick/scenegraph/openglunderqml/doc/src/openglunderqml.qdoc examples/quick/scenegraph/simplematerial/doc/src/simplematerial.qdoc examples/quick/threading/doc/src/threading.qdoc examples/quick/touchinteraction/doc/src/touchinteraction.qdoc examples/quick/views/doc/src/views.qdoc Change-Id: Idf7bb76c82acacf86b19a9f4633c3cbf4ae1a9a0
| * Fix duplicate examples for qml/quick modulesKai Koehne2013-03-212-7/+9
| | | | | | | | | | | | Task-number: QTBUG-30233 Change-Id: Ic0a6d9112dbf8903d68f571e0ac853d89ff31ebe Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Doc: Fix some titles and linksSze Howe Koh2013-03-305-10/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Doc: Update module "Qt Declarative" -> "Qt Quick"Sze Howe Koh2013-03-301-1/+1
| | | | | | | | | | | | | | | | Also update examples/README to show the relationship between Qt Quick and Qt QML. Change-Id: I4e50d9f0ddb1ac25ccdfed09f579f76a375b14fe Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* | Doc: Fixed some uses of terminolgies in qdoc files.Jerome Pasion2013-03-2610-32/+31
| | | | | | | | | | | | | | | | | | | | | | -"element" -> "type" or "object" (not in all cases where this change applies) -some instances of QtQuick. It should be "Qt Quick". -only in qdoc files. Examples and source code changes will be done later. Task-number: QTBUG-30180 Change-Id: Ie587461a138e97606f761ad1e90909c91b479303 Reviewed-by: Alan Alpert <aalpert@blackberry.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-03-141-4/+3
|\ \ | | | | | | | | | | | | | | | | | | Conflicts: tests/auto/qml/debugger/qv8profilerservice/qv8profilerservice.pro Change-Id: I2fd99ed8bd03302b9bbf31e6f21990f6455c4f1c
| * | Doc: Changed section title in whatsnew.qdocJerome Pasion2013-03-131-4/+3
| |/ | | | | | | | | | | | | | | | | - "Qt 5.0" is the name of the main landing page, which causes link conflicts in Qt QML module. Change-Id: I2becb864873ea3784eb4fece3ebcbe64e0a00cba Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* | Merge "Merge remote-tracking branch 'origin/stable' into dev" into ↵Frederik Gladhorn2013-02-191-2/+2
|\ \ | | | | | | | | | refs/staging/dev
| * | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-02-181-2/+2
| |\| | | | | | | | | | Change-Id: I33db683ebf12248b2ed14eeaf65c4bcade14bfbf
| | * Doc: Removed reference to deprecated \badcode command.Jerome Pasion2013-02-151-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | QDoc doesn't differentiate between \badcode and \code. They both look the same in the output. Change-Id: Ia0580f7d664ad5e33b48d6511dac7c61349cacce Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-02 07:27:06 +0000