aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/src/appdevguide
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Moved "QML Application Developer Resources" to qtdoc repository.Jerome Pasion2013-04-2919-3588/+0
| | | | | | | | | | 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: corrections (Writing Guidelines) and language editsNico Vertriest2013-04-266-139/+144
| | | | | | | | Corrected punctuation issues. Task-number: QTBUG-30774 Change-Id: I144d2487d4f7c248c60bf824b909145416d356fa Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: corrected snippet issue by changing extension snippet file.Nico Vertriest2013-04-251-1/+1
| | | | | | | | | | | | 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: Replace some references to NokiaSze Howe Koh2013-04-241-2/+2
| | | | | | | Link to internal QDoc pages, or to qt-project.org Change-Id: I5d9adae711213873ab57ccfc5bb2d8f74cf5689b Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Create links to Qt Quick 1Sze Howe Koh2013-04-241-3/+5
| | | | | | | | | | | 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: Fix module name formatSze Howe Koh2013-04-235-8/+8
| | | | | | | | | | | | | | | | | Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation QtGui -> Qt GUI QtMultimedia -> Qt Multimedia QtScript -> Qt Script QtSensors -> Qt Sensors QtSvg -> Qt SVG QtWebkit -> Qt WebKit Also fix a broken link to "Qt WebKit QML Types" Change-Id: Ica6081024d3957a3ca2ef3d870f623506c69d877 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Qt Quick: Fix module name format (Pt 2/2)Sze Howe Koh2013-04-232-4/+4
| | | | | | | | | | | | 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-237-32/+32
| | | | | | | | | | | | 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: Qt QML: Fix module name formatSze Howe Koh2013-04-191-6/+6
| | | | | | | | | | 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-171-1/+0
| | | | | | | | | | | | 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: Fix some titles and linksSze Howe Koh2013-03-304-10/+8
| | | | | | | | | | | | | | | 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: Fixed some uses of terminolgies in qdoc files.Jerome Pasion2013-03-2612-41/+30
| | | | | | | | | | | -"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>
* Docs: Slow Down Animations only exists in qml1Frederik Gladhorn2013-02-191-8/+0
| | | | | | | The functionality was part of qmlviewer. Change-Id: Iaf2e19acf54e6773e2b79659f4dc51b92de91dd4 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Update QtQuickTest documentationCaroline Chao2013-02-181-0/+28
| | | | | | | | | | Add some information about -input, -functions and -help command-line options. Add some examples on how to run a single file and a single function for a QtQuickTest based test. Change-Id: Icd5f92bf8541aa412e2cd18d82dec16a85fe78c9 Reviewed-by: Alan Alpert <aalpert@rim.com>
* Doc: Correcting typo "without with"Marcel Krems2013-02-181-1/+1
| | | | | Change-Id: Ibacbb9aefe9a333994014aec17a0079477a4618f Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Fix unterminated commentSze Howe Koh2013-01-281-1/+1
| | | | | | Change-Id: Ic5bcbac339588fdded265a00515f768058d73870 Reviewed-by: Laszlo Papp <lpapp@kde.org> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: correcting typo "the the"Nico Vertriest2013-01-141-1/+1
| | | | | | | | | | | Task-number: QTBUG-28756 Spurious repetition of the definite article Doc: corrected trailing space issue. Change-Id: I95c1c5773dc4b25dd0a3625343a67975783435fd Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* Update copyright year in Digia's license headersSergio Ahumada2013-01-1019-19/+19
| | | | | | Change-Id: I6c3bd7bebe3d62d1cfd0fa6334544c9db8398c76 Reviewed-by: Akseli Salovaara <akseli.salovaara@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* Doc: Updated docs for examples and etcXingtao Zhang2013-01-091-4/+4
| | | | | | | | | | | | - Corrected several \snippet paths and \example paths. - Added missing example images. - Marked several commands as code. - Updated the exampledirs variable for qtqml. Done-with: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Task-number: QTBUG-28898 Change-Id: I24aac17821f54de4bd5129c45b5bf96dc0f114b2 Reviewed-by: Liang Qi <liang.qi@digia.com>
* Update porting docsv5.0.0-rc2Alan Alpert2012-12-121-1/+10
| | | | | | | | | | | Some improvements to the QML engine in Qt 5 lead to behavior changes. These should be explained in the porting guide. Task-number: QTBUG-28411 Change-Id: Ifc4016cf7b33ba113dbe0cbabd2f71a4ff1a8685 Reviewed-by: hjk <qthjk@ovi.com> Reviewed-by: Bea Lam <bea.lam@jollamobile.com> Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
* Add calqlatr to qmldemos group and move qmldemos listEskil Abrahamsen Blomfeldt2012-11-301-75/+0
| | | | | | | | | | The qmldemos list has been moved to qtdoc, otherwise the links to the documentation for the demos (in qtdoc) doesn't work. Links from qtdoc to calqlatr in qtdeclarative works because that's the direction of the dependency. Change-Id: Ib275a9c7f009194a260b2e70278244afc1cedfaa Reviewed-by: Gunnar Sletta <gunnar.sletta@digia.com>
* Remove QML intro and QML Application Development pagesGunnar Sletta2012-11-282-1306/+2
| | | | | | | | | | | These are duplicates of the getting started document and the overviews listed in the "Important Concents of Qt Quick". They are also not accessible from the toplevel docs (because they are duplicates). Change-Id: I628d264a7738bb3b9efdaf04f3a3c1a3853688d6 Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
* Remove superflous "defining reusable components" documentation.Gunnar Sletta2012-11-282-532/+1
| | | | | Change-Id: I73e6be5c7e5abe42ebf797ccfc7db5035ec4ec2c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Qt Quick (2) is not dependent on LGPL codeLars Knoll2012-11-271-5/+0
| | | | | Change-Id: I0cece9da63bce327d2d6bc2eb13d500bd054f12f Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
* Fix deployment docs.Lars Knoll2012-11-261-9/+13
| | | | | | | Qt Quick is not dependent on widgets. Change-Id: Icd7ab72d9558905ac6d3790faa0248b0d197ea8c Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
* Merge branch 'newdocs'Eskil Abrahamsen Blomfeldt2012-11-202-1/+85
|\ | | | | | | Change-Id: Idd7a9837e4f6a1358edf9accdcdc3c71822f4c25
| * Doc: Moved all content in the doc directory.Venugopal Shivashankar2012-11-082-1/+85
| | | | | | | | | | | | | | | | | | - most images to the corresponding examples directory - Fixed a few broken links to the examples and qdoc pages - removed the obsolete and unused images and qdoc pages Change-Id: I18f9551b42ec713b81e3f69694a2bd04b1ebf794 Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* | QuickTest: Remove reference to /tests/qmlautoKai Koehne2012-11-141-3/+0
| | | | | | | | | | | | | | | | | | There's no tests/qmlauto in the source tree, neither could I find an example using QUICK_TEST_SOURCE_DIR. Task-number: QTBUG-27919 Change-Id: I5a4ba5653a06e448a922a47900ae3f2d12e3020c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* | Fix a missing word in the docsJan Kundrát2012-11-051-1/+1
|/ | | | | | | | The functionality is "*no* longer available", of course. Change-Id: I2c9f2633d74b98c16216f68e3d7e080422cf6506 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
* Doc: Removed reference to QTDIR and did some language editsVenugopal Shivashankar2012-10-291-104/+115
| | | | | Change-Id: I3c7854342fc89c97423c8540a6c5cc51070a5639 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Changed the title to fix broken linksVenugopal Shivashankar2012-10-161-1/+1
| | | | | Change-Id: I84bdb335980fdeae0c91021179ede19eae79e811 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Removed the verbs from the page and section titlesVenugopal Shivashankar2012-09-261-15/+13
| | | | | | Change-Id: I9f8b98e40340a5f871f7a66a3d7ea63675e21d34 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Change copyrights from Nokia to DigiaIikka Eklund2012-09-2321-294/+294
| | | | | | | 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-283-13/+25
| | | | | | | | | | 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>
* Fix doc linksBea Lam2012-08-241-6/+7
| | | | | Change-Id: Iafbcd39472f3e6f12169ae1a17b4a040dbb9a8a4 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Improvements for coding conventions docsBea Lam2012-08-241-14/+3
| | | | | | | | | | | | Shouldn't advise using "__" for "private" properties since this mightn't be the best solution. This doesn't work with the onXChanged handler syntax. Also grouped and dot property syntax are both valid. We use both throughout our code. Change-Id: Ibd86f20136dc0e7225558e234afb79f566ca1039 Reviewed-by: Yann Bodson <yann.bodson@nokia.com>
* Link to Coding Conventions pageBea Lam2012-08-242-3/+4
| | | | | Change-Id: I4c2870bf37ea1f9f110ced4120d4a622096d8dfe Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Doc: Tidied links, titles, and HTML pages.Jerome Pasion2012-08-233-10/+9
| | | | | | | | -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>
* Link to "Deploying QML Applications"Bea Lam2012-08-221-0/+1
| | | | | Change-Id: Ic5403ac972ff71648a8f957baec292a0a207b00c Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Rename "JavaScript" section titleBea Lam2012-08-081-1/+1
| | | | | | | | This was causing every mention of "JavaScript" in the docs to link to this section. Change-Id: Ib6cfd1aa7559305fc08d758a41dbd4176f7501e5 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Provide features/use-case docs in QML AppDevGuideAlan Alpert2012-08-0811-125/+316
| | | | | | | | | | The most common use-cases should have easily-accessible solutions available from the front-page of the QML application developer guide. This commit adds that documentation. Task-number: QTBUG-26428 Change-Id: Id15e76db15fbe3599e9ac5dd98e74ad4e034ece4 Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* Add type name to singleton (module api) implementations.Glenn Watson2012-08-082-4/+4
| | | | | | | | | | | | | 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>
* Restore QML/C++ extensions tutorial and fix plugin docs and examplesBea Lam2012-08-071-1/+1
| | | | | | | | | | | | | | | | | This restores the "Writing QML Extensions with C++" tutorial that was removed during the recent QML doc restructure. This also updates outdated docs in "Creating C++ Plugins for QML" that referred to the use of Q_EXPORT_PLUGIN2() and such as the process for writing QML plugins in Qt 5 has changed. Note the plugins.json line was removed from examples/qml/cppextensions/plugins/plugins.pro since this json file was removed in a previous commit, as plugins no longer require the empty json file. Change-Id: I795d6faf6a741466a952feb8e15b028ec3d52b69 Reviewed-by: Chris Adams <christopher.adams@nokia.com>
* Update porting guide for positioner handling of item opacityBea Lam2012-08-071-7/+36
| | | | | | | | Also moved some items from the release notes that are more appropriate for the porting guide. Change-Id: I0abe4dd5e74ac5505e1210bb330cc55af9e657da Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
* doc: expanded Qt Quick internationalization guideGary Aish2012-08-031-41/+226
| | | | | Change-Id: I246fb252f6fca046a84fc689cea4334438d669de Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>
* Fix various broken links in documentationBea Lam2012-08-034-6/+6
| | | | | Change-Id: I9e2dac37d18e3ca62e4a92be25e5c2e60ffeba00 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
* Minor restructuring of application developer resourcesChris Adams2012-08-021-34/+56
| | | | | | | | | | Move the QtQml/QtQuick overviews below the quickstart / usecases sections. Merge the Important Topics and Debugging And Testing sections into a single Advanced Topics section. Modify some of the formatting used to improve the consistency of the page. Change-Id: Iab0b077130a763951a2967e725c2ef8ec2937ae8 Reviewed-by: Bea Lam <bea.lam@nokia.com>
* Correctly link the QML module C++ class documentationChris Adams2012-07-241-1/+2
| | | | | | | | | | | | | 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>
* Mention opacity property change in porting.qdocAlan Alpert2012-07-201-0/+14
| | | | | Change-Id: I09343469bebcd7324ae1596d408cafea69c5dc60 Reviewed-by: Bea Lam <bea.lam@nokia.com>