aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc
Commit message (Collapse)AuthorAgeFilesLines
* Remove the two default role names listed in cppmodels documentation.Mitch Curtis2014-01-161-14/+1
| | | | | | | | | The list is incomplete, and they are now fully documented under QAbstractItemModel::roleNames(). This saves us maintaining two lists that can easily get out of sync. Change-Id: I4895a8ba19a4f48c26b4077e8bf2eba8c4c8407c Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com>
* Doc: Fix current QtQuick module version.Takumi Asaki2014-01-101-2/+2
| | | | | Change-Id: I8056757967ff2693f69b5a7afa11a00ca826ece0 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: QtTest - Fix documentation for TestCase and SignalSpyCaroline Chao2014-01-093-2/+13
| | | | | | | | | | | | | | | | | The property/methods documentation needs to be available in the components qml file. Thus we now import those components from the qml files directly instead of using fake header files. Rename the Qt Quick Test page to Qt Quick Test Qml Types to be consistent with the other submodules. Task-number: QTBUG-33587 Change-Id: Ifb1df8e7d15f2e23b4b4268e5df138934e62fc42 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Alan Alpert <aalpert@blackberry.com>
* Doc: Fix broken linksSze Howe Koh2013-12-3014-31/+28
| | | | | Change-Id: I4c4577edde96978a986606bf30fbb925f871bd42 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Context2D: don't use an arrow to illustrate scaling in the docs.Mitch Curtis2013-12-261-0/+0
| | | | | | | | | | The example image scales an arrow, but uses an arrow to indicate that the next image (an arrow) is a result of the first arrow being scaled. Instead, use a circle. Change-Id: I8de18d4c2f3cb309681f63c31b0c9f7255d1868c Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Doc: Fixed a few broken links and snippetsVenu2013-12-231-2/+2
| | | | | | | | | | Couple of \snippet references in the ListModel docs were pointing to files outside the exampledirs boundary. Update those references to use the relative path. Change-Id: Ibf9d0fda9e5280345b08cb66a4fe0db9142a42a6 Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Performance note about QQuickWindow::setColor vs top-level RectangleGunnar Sletta2013-11-251-0/+5
| | | | | Change-Id: I58d271b108734958b6e0cd55ff62417d5b649a63 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fixed list of animation types.Jerome Pasion2013-11-181-10/+1
| | | | | | | | | -manually created list duplicates the generated list. -\generatelist{related} doesn't do anything for a regular \page. Task-number: QTBUG-33360 Change-Id: I0bf870c71d3985e232fa8c0d5ef7ad572f596e99 Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Doc: Updated url variable in qdocconf files.Jerome Pasion2013-11-061-1/+1
| | | | | | | | | | | | | | | In 5.2, the HTML output is in a flatter structure and when they are hosted in qt-project.org/doc, the documentation will be found at http://qt-project.org/doc/qt-$QT_VER The url variable is used by projects outside of Qt 5 which need to link to Qt 5 documentation, such as Qt Creator. Task-number: QTBUG-34584 Change-Id: Ie23c3748fbe780fa00f98404238099809df5ef06 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: J-P Nurmi <jpnurmi@digia.com>
* Doc: Fix broken linksSze Howe Koh2013-11-055-7/+5
| | | | | | Change-Id: Ie7408409ddbaa354370267f2dd74326ec56a4186 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Fix typosSze Howe Koh2013-11-051-1/+0
| | | | | | Task-number: QTBUG-33360 Change-Id: I913c14d3d6a90d2c20e40e246ad11f50a26c3ad9 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Add missing image to XmlListModel documentationTopi Reinio2013-11-041-0/+0
| | | | | | | | | | The image was originally part of QtQuick1 docs - copy it over to qtdeclarative repository. Task-number: QTBUG-34556 Change-Id: Ic7089ce157ff7722e5f42b201ff4b01dcff2564e Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Add references to Animators from the QML Type ReferenceGunnar Sletta2013-10-291-0/+6
| | | | | | | Task-number: QTBUG-34221 Change-Id: Iaa1d7f4dd70d2d8150e8360545a33ac984e6bebd Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fixed broken linksVenu2013-10-243-46/+47
| | | | | | | | | | | | | | | | | There were many links (including the broken) on the Qt Quick index page and QML type reference page using the html file name to link to a page or a section within a page. Using html file reference in a link is not a good approach as qdoc does not give complete control to the author to define the html file name. This change updates all such links to use the page \title and \target names, which are considered to be better ways to link. Task-number:QTBUG-33360 Change-Id: Ibd1b1e3223a7e205bbdcf21b1b7f6e515749c5c9 Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Added a QML module page for Qt Quick TestVenu2013-10-231-1/+15
| | | | | | | | | | | | This should avoid the TestCase and SignalSpy types being listed in the All Classes page, which is meant for the C++ classes. Task-number: QTBUG-33316 Change-Id: I0f2f9e557df89f46f656a8820602fe5712c64073 Reviewed-by: Caroline Chao <caroline.chao@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.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>
* Animator overview docs and example.Gunnar Sletta2013-10-031-0/+19
| | | | | Change-Id: If0852e48dbbfea4fadca9c897ea0e62393763055 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* qdoc: no longer recognizes the version nr in QML refsMartin Smith2013-10-024-22/+22
| | | | | | | | | | All QML references of the form <QML-module-name><QML-module-version>::<QML-type>::<member-name> have had the <QML-module-version> removed i. Task-number: QTBUG-33776 Change-Id: Idde279e0f254cd24ea44f9841662dd81a2c5bbc6 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Fix license headers of QtQuick sources.Gunnar Sletta2013-09-301-1/+1
| | | | | Change-Id: I3750c47640bf21c3567c5fa1c4667e3e2552942e Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Convenience class for FBO rendering in Qt QuickGunnar Sletta2013-09-251-10/+7
| | | | | Change-Id: I5712bbfa0cde9f2fe5fddc35c4cc23597717065c Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Doc: Fixed and updated Qt Quick's \qmlmodule pageJerome Pasion2013-09-251-5/+5
| | | | | | | | | | | -incremented version to Qt Quick 2.2 (in \qmlmodule page) -import changed to QtQuick 2.2 -\inqmlmodule no longer needs the version. QDoc will ignore the version but it is better to remove it now to avoid confusion Task-number: QTBUG-32172 Change-Id: I40b52e59667014720be40a35b3a8fb9836825e31 Reviewed-by: Gunnar Sletta <gunnar.sletta@digia.com>
* Animators - Render thread animation systemGunnar Sletta2013-09-211-0/+282
| | | | | | | | | | | | This introduces 6 new QML types for animating state in the scene graph when the UI thread is blocked. The QObject property being animated is updated after the animation completes. It works also with the "windows" and "basic" render loops, but offer litte benefit then compared to in the "threaded" case. Change-Id: Ic19e47c898c0b8bd53e457db922b3c9c457c8147 Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Prefer multisample antialiasing when we have a msaa contextGunnar Sletta2013-09-061-0/+64
| | | | | | Task-number: QTBUG-32699 Change-Id: Id4382c154954cb114af2cc29b075ddab8df9f387 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
* New scenegraph renderer and atlas textures.Gunnar Sletta2013-09-023-2/+325
| | | | | | | | | | | | | The renderer tries to batch primitives together where possible, isolate non-changing subparts of the scene from changing subparts and retain vertexdata on the GPU as much as possible. Atlas textures are crucial in enabling batching. The renderer and atlas texture are described in detail in the doc page "Qt Quick Scene Graph Renderer". Change-Id: Ia476c7f0f42e1fc57a2cef528e93ee88cf8f7055 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
* Doc: Updated Qt QML and Qt Quick module pages.Jerome Pasion2013-08-051-0/+1
| | | | | | | | -added \qtvariable -added Qt QML to the modules group Change-Id: I524bbcea501b7ab5ea49482de0119e3e6d630065 Reviewed-by: Martin Smith <martin.smith@digia.com>
* doc: Eliminate more cases of multiple topic commandsMartin Smith2013-07-231-8/+4
| | | | | | | | | | | | | This fixes the advanced tutotial based on the samegame example. Several instances where \page and \example occur in the same comment are corrected by removing the \page and leaving the \example. And the links in the tutorial's list of chapters are correct. Task-number: QTBUG-31578 Change-Id: I89bb179bc4d4f6120b8d13ba05a51c802a7d4013 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* doc: Eliminate still more cases of multiple topic commandsMartin Smith2013-07-231-8/+4
| | | | | | | | | | | | | | This fixes the dynamic view tutotial based on the pets model example. Several instances where \page and \example occur in the same comment are corrected by removing the \page and leaving the \example. And the links in the tutorial's list of chapters are corrected. Task-number: QTBUG-31578 Change-Id: I5a35b55806e33da5c82c37db1193f96fe74f038a Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-07-111-1/+1
|\ | | | | | | Change-Id: Idaaeba880a175166437e2a7266716c776c4483c6
| * Fix typo in Graphical Effects documentation.Mitch Curtis2013-07-081-1/+1
| | | | | | | | | | Change-Id: Iad5ee6a965a6373941468bf98ac328e51c5c4066 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-06-277-1/+2
|\| | | | | | | Change-Id: I59f34fafd795694981dd1edffca1d322657f1ae6
| * Merge remote-tracking branch 'origin/release' into stableFrederik Gladhorn2013-06-251-1/+2
| |\ | | | | | | | | | Change-Id: I6e060496b8c252fb4e2d5d2d40ae16bf950e2ec4
| | * Update 5.1.0 changelog and what's newAlan Alpert2013-06-251-1/+2
| | | | | | | | | | | | | | | | | | | | | 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>
| * | Tidy up Context2D transform-related documentation.Mitch Curtis2013-06-256-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Also adds back some images that 61d35829eed6661c1371d397bbb316ea2f636c50 removed (4a5d31a56dfd871f3f7c5ce162885ebc870b8803 specified the wrong paths to all but one file, which is probably why they were cleaned up). Change-Id: Idd42bb831c97935e53ce05c69ea2691a2769f453 Reviewed-by: Jerome Pasion <jerome.pasion@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>
* | | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-06-241-0/+0
|\| | | | | | | | | | | Change-Id: I444ed90a02eebe1f68cfa48be5d75544123ab10d
| * | Fix some Canvas/Context2D documentation issues.Mitch Curtis2013-06-211-0/+0
| | | | | | | | | | | | | | | | | | | | | Task-number: QTBUG-23597 Change-Id: I7b3c343a822c136cecec5ce9ce705f2d99466e77 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-06-124-12/+36
|\| | | | | | | | | | | Change-Id: I045587eac266e9b6296d9cd9e3c73031fe18bbd1
| * | Merge remote-tracking branch 'origin/release' into stableFrederik Gladhorn2013-06-121-1/+2
| |\| | | | | | | | | | Change-Id: Ie916db2bc4973016541176363d08c5dd14ff6b69
| | * Doc: Exclude Qt Quick Dialogs examples in qtquick.qdocconf fileTopi Reinio2013-06-101-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Qt Quick Dialogs has its own .qdocconf file where the example path is defined. This change removes the path from .qdocconf for Qt Quick module so qdoc doesn't try to parse it twice. Change-Id: I06ad6895d5929031c37e21bfa91a813ba60d86d2 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * | Merge remote-tracking branch 'origin/release' into stableFrederik Gladhorn2013-06-104-12/+35
| |\| | | | | | | | | | Change-Id: Iafc0497812acb7850cd4e72c49d63ec9c9320b58
| | * Doc: Fixed link to Qt Quick Layouts and made links consistentJerome Pasion2013-06-061-7/+7
| | | | | | | | | | | | | | | | | | | | | -better to use the "QML Types" pages as the version is not specified. Change-Id: I5b150bc8ada25c619dbecb5d68e70854dd9c14d6 Reviewed-by: Alan Alpert <aalpert@blackberry.com>
| | * Doc: Update Qt Quick Controls descriptionCaroline Chao2013-06-041-1/+1
| | | | | | | | | | | | | | | Change-Id: Ifb67ae32fcb8abe49166346fa1017dc5c76bc485 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| | * Doc: Clarified members of QtQml.Models submodule.Jerome Pasion2013-06-043-4/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | -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>
* | | Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-06-046-21/+27
|\| | | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: Ib8b5509c48a686f6e916708d83914e13e4f67e9c
| * | Merge remote-tracking branch 'origin/release' into stableFrederik Gladhorn2013-05-315-20/+26
| |\| | | | | | | | | | Change-Id: Ie4ce4c3e64f093eec26754e06199d350a46ae2a2
| | * Doc: Fix the positioning topic pageCaroline Chao2013-05-302-14/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | Mention both Positioners and Qt Quick Layouts. Also add qtquickdialogs to qtquick.qdocconf. Change-Id: I19bc09a0a81be7c748af83ddf38f1111f0ecc81a Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| | * Doc fixes to the Positioners/Layouts documentationJan Arve Saether2013-05-302-3/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add references to Qt Quick Layouts * Don't lie about that Positioners can resize the items * Rename title from "Item Layouts" to "Item Positioners" to avoid confusion with Qt Quick Layouts Change-Id: I43e3ad6e6d9e4b08a1233868c75f0efcab43f8c3 Reviewed-by: Caroline Chao <caroline.chao@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| | * Doc: Fix links for ListModel and ListElement typesTopi Reinio2013-05-291-3/+3
| | | | | | | | | | | | | | | | | | | | | Link to documentation under QtQml module. Change-Id: Id65d237558c235dcdda8ab206eddef23c2886a29 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| | * Doc: Excluded Dialogs directory from Qt Quick doc build.Jerome Pasion2013-05-291-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Qt Quick Dialogs is separate and should be excluded from the Qt Quick doc build. Task-number: QTBUG-30180 Change-Id: I6e63efc071d8d2e5673745f0dcd97d5b5f562d25 Reviewed-by: Alan Alpert <aalpert@blackberry.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
| | * Dialogs: Create directory structure for documentationCaroline Chao2013-05-281-1/+1
| | | | | | | | | | | | | | | Change-Id: I5245a6931606673733130b1f168fddafe8def695 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>