Commit Graph

26 Commits

Author SHA1 Message Date
Leena Miettinen
b0039fae98 Doc: Add a step list to Using QML Modules with Plugins
Reorganize the sections in the topic to match the order of the
list.

Task-number: QTBUG-63480
Change-Id: I976647fa11e3046abcd5aad322bf60029656b3e4
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-10-18 07:28:35 +00:00
Leena Miettinen
92918158e1 Doc: Add a link to the Qt Quick Controls 2 - Contact List example
...to the section that describes using the QML_DESIGNER_IMPORT_PATH
option in a project .pro file.

Change-Id: Ia8b10481b4235a89dae6d8df2b0320efb88ed1dd
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-05-09 08:34:41 +00:00
Leena Miettinen
0bbd1e3ca6 Doc: Setting QML import path when using CMake
Change-Id: I7e29f86d2b429fadaad763fa6abe371f79669d75
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2017-02-03 15:39:36 +00:00
Thomas Hartmann
6dec313692 Document QML_IMPORT_PATH and QML_DESIGNER_IMPORT_PATH
QML_IMPORT_PATH has never been officially documented and
QML_DESIGNER_IMPORT_PATH was added recently.

Change-Id: I932445404a185286d8f03077df492a34db9b0ea6
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2016-10-25 08:29:00 +00:00
Thomas Hartmann
69663871fc Update documentation for connections editor
We added a new tab called backends.
I also updated all the screenshot, so they
contain the new tab.

Change-Id: Ib66ffbd3a48383f621a482241cde12caef9ca7b4
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@theqtcompany.com>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2016-10-20 08:57:38 +00:00
Leena Miettinen
4a3c200831 Doc: Use automatic linking to directly link to the type docs
...in Using QML Modules with Plugins.

Change-Id: Icce8e1e2b902e593972bd9f14d118f6a5005ecb8
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@theqtcompany.com>
2016-10-19 07:53:08 +00:00
Tobias Hunger
43800a6aa8 Update License according to agreement with Free Qt Foundation
* Update license in documentation files. Stay at FDL, but update
  URLs as well as license for examples, etc.

Change-Id: I5e8cb5a20f0e9d52fba1d937b7c73197d69dd747
Reviewed-by: Tobias Hunger <tobias.hunger@theqtcompany.com>
2016-01-19 13:09:03 +00:00
Eike Ziller
3c85058694 Update License
Change-Id: I711d5fb475ef814a1dc9d2822740e827f3f67125
Reviewed-by: Alessandro Portale <alessandro.portale@digia.com>
2015-01-16 12:37:56 +01:00
Leena Miettinen
e6f9443394 Doc: fix broken links to Qt 5 reference docs
Some titles had changed and the hash mark references
do not seem to work anymore.

Change-Id: I4ebb877a483eff0a11c32932cc84b6e15935dcec
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-01-07 11:36:36 +01:00
Leena Miettinen
e1fbeedcd4 Doc: use \uicontrol command instead of \gui macro
Change-Id: Idc898b6ac70b6d3186d353086b5f3e45830d1f83
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2014-12-12 10:26:59 +01:00
Leena Miettinen
95afdf6c38 Doc: QML_PUPPET_MODE env variable
The variable was added for checking whether a QML plugin
is run in Design mode or by an application.

Task-number: QTCREATORBUG-12439
Change-Id: Iad99b7279c8191cb8b17ca81ff24fb9db731fdc9
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
2014-12-01 11:31:37 +01:00
Leena Miettinen
16c3745da4 Doc: update QML emulation layer options
A check box was divided into two radio buttons.

Change-Id: I0439e038be2508a62811a5200c10a07367e85576
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
2014-11-28 14:25:58 +01:00
Leena Miettinen
63c8b25ad1 Doc: document QML emulation layer
And the new option to have Qt Creator build the emulation
layer using the kit selected for the project.

Change-Id: I16b3d9e87f21caf7a4ecd1a527df51035494fb34
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
2014-09-17 09:52:38 +02:00
Topi Reinio
627e2b4807 Doc: Use the page title for linking to index.html
Because the Qt Creator documentation depends on Qt reference
docs for linking, qdoc will generate a collision page for
index.html as it exists in both.

This change prevents linking to the collision page in the
navigation links by using the page title as the link target
instead of the file name.

Task-number: QTCREATORBUG-11035
Change-Id: I5638e09b60543dc2068b0e4a269f8f72d4655b48
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-03-17 14:53:01 +01:00
Robert Loehning
746c5d8863 Incremented year in copyright info
Change-Id: Ib5423fdd064e4546f848c0b640b0ed0514c26d3a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
2014-01-08 08:29:47 +01:00
Leena Miettinen
c0704c2091 Doc: use cross-linking to Qt module documentation
Replace links to "\l{http://qt-project.org/doc/"
with links to topic titles. Remove links where QDoc
creates them automatically based on the .index files.
Add the .index files for the modules that are discussed
in the Qt Creator Manual.

Note: the links will only be generated if the Qt used to
build the docs contains the linked modules and documentation
(.index file) has been generated for them.

Change-Id: Ibe624bf3773e7c854c03ebba4db406be0b4a7b90
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2013-11-26 11:51:46 +01:00
Leena Miettinen
bd9c842a38 Doc: restructure UI design section
Remove graphics and combine some short topics to
put more weight on Qt Quick development instead of
generic UI development.

Change-Id: Ief2041022e0ccb407c26b0742825613223082f0a
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
2013-10-08 13:02:17 +02:00
Leena Miettinen
dd4bd99c89 Doc: replace "element" with "QML type" or "item"
Try to make terminology more consistent, by using
"QML type" when describing the types, "item" when
describing instances of QML types, and "component"
when describing objects built by using QML types.

Change-Id: Ie03f3a7e6f483471e344ae1f35bec0742173b27c
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
2013-03-13 14:32:47 +01:00
Leena Miettinen
e3587e8f0d Doc: switch fixed links from Qt 4.8 to 5.0
Will look into changing automatically created links in
another patch.

Change-Id: I29b61c5301402c40d9e711762a6b57479088152b
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-03-13 11:08:27 +01:00
Robert Loehning
298531e370 Incremented year in copyright info
Change-Id: Ic6a9ff0359625021ebc061d22db6811814534205
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
2013-01-29 16:27:03 +01:00
hjk
386ca7c8dd Adjust license headers
Change-Id: Ice592c6de9951ee3b2c4cb52ed0bb3b6770e0825
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2012-10-05 17:12:56 +02:00
Leena Miettinen
0d0121b033 Doc: switch links to point to qt-project.org
Change-Id: I136a28697c0b7aba03227387c5ce2e106c52708a
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2012-08-22 08:56:20 +02:00
Eike Ziller
e0e8cf3ada Contact -> qt-project.org
Change-Id: I7134d7de30bcf9f9dcfad42520dd45ee083a852d
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@nokia.com>
2012-07-19 13:23:21 +02:00
Leena Miettinen
e271000bf7 Doc: reorganize info to make it clearer
Readers got confused with qmldump and qmlplugindump

Change-Id: Ia228ac43e1f40659bc6df4e6e5fc5139055fc455
Reviewed-by: Kai Koehne <kai.koehne@nokia.com>
2012-05-11 11:57:51 +02:00
Leena Miettinen
6696a9b0d0 Doc: change the copyright year to 2012
Change-Id: I31e5f412ec2d4c371382e00503b7ebf5cc57ba02
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
2012-01-26 12:33:30 +01:00
Leena Miettinen
a5661ddabc Doc: divide file into several files
Mostly, place one topic into one file.

Change-Id: I8fdf43f14179816c0a57883068acd15b13a3761a
Reviewed-by: Kai Koehne <kai.koehne@nokia.com>
2011-12-14 15:22:43 +01:00