Commit Graph

2539 Commits

Author SHA1 Message Date
Leena Miettinen
897ce16452 Doc: Describe changes in the Search
Change-Id: I2c4450719203383bae9951c75863fe90504a2d13
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2017-03-21 09:44:08 +00:00
Orgad Shaneh
da7cb91446 Merge remote-tracking branch 'origin/4.2' into 4.3
Change-Id: I4931dcc81be872d7712e67123e94d15ee696459f
2017-03-14 16:20:14 +02:00
Oswald Buddenhagen
8e631c9b26 make fixnavi actually work with examples
we reference examples by title, not by file name (as it's unknowable).

Change-Id: I24e2a543138b77e8c6ea60e2aca49ba057c13273
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-03-13 12:27:08 +00:00
Christian Kandeler
31ce111727 Embed the qbs documentation also when building with qbs
Task-number: QTCREATORBUG-13124
Change-Id: I214a92a03a6d0fa75c1cceca1909c68add09d2c8
Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
2017-03-10 15:47:54 +00:00
Eike Ziller
0467aa5c90 Merge remote-tracking branch 'origin/4.2' into 4.3
Change-Id: I2f32404f36ed885e78a7616da2f686943a8c8471
2017-03-10 15:38:01 +01:00
Oswald Buddenhagen
330f63a8db fix doc navigation links
Change-Id: I0d05947ce6a9caef73c91ba9645bc305000a1794
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-03-10 13:20:22 +00:00
Leena Miettinen
e67db17c09 Doc: Update documentation writing instructions
The location of the TOC file and the built documents has
changed. Qt WebKit has been deprecated. Added a link to doc
build instructions.

Change-Id: I1718e1c706a7e3fd34d2fa44116c0d5631b50f5e
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2017-03-10 08:57:21 +00:00
Eike Ziller
cec29f34ea Merge remote-tracking branch 'origin/4.2' into 4.3
Conflicts:
	doc/src/qtcreator.qdoc
	tests/system/suite_general/suite.conf

Change-Id: Ia298b177d6920a1d853e342b62cf98f7c48a278a
2017-03-09 12:14:55 +01:00
Eike Ziller
33fa4b401c Create a reusable docs.pri for generating documentation
Since we cannot directly use qt_docs.prf since it contains
various Qt specific details, adapt it for use in Qt Creator.
This can then be used e.g. by plugins that are not part of the
Qt Creator repository.

Change-Id: I87511cad74cbcae5cb58087e9a9386130d635aa9
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
2017-03-09 09:30:42 +00:00
Leena Miettinen
0ed42f1c9f Doc: Move the TOC to a separate page that is used as indexTitle value
This fixes the problem that the whole TOC is not visible in the
Qt Creator Help mode Contents view (because it was generated based on
the \table entries, not the \list entries).

Task-number: QTCREATORBUG-10585
Change-Id: I86607e10db7172b2a7492e4ce1660c39390ef9ed
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2017-03-09 09:13:27 +00:00
Eike Ziller
461a7483e3 Doc: Remove unused QTC_LICENSE_TYPE define
Change-Id: Iba49e6fc6b1d857cc0f87b5bf833f42a4a8a976f
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
2017-03-06 07:46:13 +00:00
Christian Stenger
472c570545 Doc: Adapt docs to latest autotest change
Update screenshot.

This amends 69a94c2c.

Change-Id: Ia4a073e66093eef071550c55c3a41994fe61af04
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2017-03-01 09:45:26 +00:00
Eike Ziller
1f8b2dc361 Advanced search: Add exclusion patterns
All files with full file path matching one of the exclusion patterns are
ignored in the search.
Searching with "git grep" now requires git >= 1.9

Change-Id: Ied5d11499bc1ff21247e50f8e146e8e5011dd2c1
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2017-02-28 10:48:23 +00:00
Thomas Hartmann
69ec8054a6 Adjust documentation for QMLPROJECT
Change-Id: Ibb80bf3d966f67577bcfcb499c9dfa5cac405129
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-02-28 09:34:09 +00:00
Eike Ziller
1704c484a8 Merge remote-tracking branch 'origin/4.2'
Change-Id: I9006dd493707ae626ae3502541599c8789e1aab0
2017-02-27 15:17:37 +01:00
Leena Miettinen
2611002463 Doc: Remove link to removed tutorial
Change-Id: Icfc111addf4e9e69d29325275ef997a7f923b1ca
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-02-22 08:49:01 +00:00
Leena Miettinen
0ae475f03b Doc: Clean up links to previous pages
Change-Id: I4352760bfce5637905c432a90f77242d4ad4a668
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-02-22 08:47:14 +00:00
Leena Miettinen
cb8753d093 Doc: Clean up the TOC
Some titles changed, but were not fixed in the TOC.

Change-Id: I2e031e4ac89ea34ee8f385cffadf9cb880db7ce0
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-02-22 08:42:59 +00:00
Leena Miettinen
ffeddec94e Doc: Fix menu item name
This was changed back in the UI, because Stacked Container
is reserved for Stack Layout actions.

Change-Id: Id9fdf3ee6e36bdaa9afde492cfd60074d56da041
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-02-21 15:45:31 +00:00
Leena Miettinen
5c8b6f8a08 Doc: Use "build for", not "build on", because it is misleading
Change-Id: I78e00bda752780c238f46d58f1821c7d7d616436
Reviewed-by: hjk <hjk@qt.io>
2017-02-21 14:05:08 +00:00
Leena Miettinen
fb9cbc2edd Doc: Describe selecting the build system in project wizards
Change-Id: I853676d922ee688385cecb1e498bc4ea2c66fc04
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2017-02-21 13:52:22 +00:00
Leena Miettinen
20a16ef91c Doc: Move Qbs information into the generic sections
Describe build settings for all build systems in the generic topics
(using .qdocinc files) and keep only configuration in the Qbs specific
topic.

Change-Id: I80ff4cd2fc18339f9c07b0a0cb09bda86e8b61cd
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2017-02-21 13:51:24 +00:00
Leena Miettinen
fd54b5bbaf Doc: Move CMake information into the generic sections
Describe build, run, and deployment settings for all build systems
in the generic topics (using .qdocinc files) and keep only configuration
in the CMake specific topic.

Change-Id: I334d7488b32aba90ee1e4ca898a65438b9d304a4
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2017-02-21 13:50:43 +00:00
Leena Miettinen
431dd18bc5 Doc: Describe managing stacked containers
Change-Id: Iee2c24067928e20abbaee3e8b3eff2b2106ba384
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-02-21 11:36:47 +00:00
Leena Miettinen
4fb3cd36eb Doc: Describe Edit Color context menu command in Qt Quick Designer
Change-Id: Icd792f3de1872e6d3f1fe50608b2f81189174bb5
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-02-21 11:36:32 +00:00
Leena Miettinen
97d517b116 Doc: Edit info about managing states in Qt Quick Designer
- Describe expanding the State pane.
- The empty slot has been replaced with a + button.
- Do not call the circle menu a "context menu", because there
  is a separate context menu.

Change-Id: I4bc689fd6490bc171891135b2c9f5bd67f9931ba
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-02-21 11:36:21 +00:00
Leena Miettinen
b1a7731c46 Doc: Describe the qsTranslate() option (Qt Quick Designer)
Change-Id: I7033f683f86157830addf1b403baab0379f631c7
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-02-21 11:36:05 +00:00
Leena Miettinen
95e8f82914 Doc: Fix \include command target
If the whole file is included, the copyright statement is printed
in the HTML file (and we don't want that).

Change-Id: I341c658182745facd000c6ad7ce073c1a37caded
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2017-02-16 13:24:16 +00:00
Eike Ziller
e724934393 Merge remote-tracking branch 'origin/4.2'
Conflicts:
	doc/src/qtquick/creator-tutorial-create-qq-project.qdocinc
	doc/src/qtquick/qtquick-creating.qdoc
	doc/src/qtquick/qtquick-uiforms-tutorial.qdoc
	share/qtcreator/welcomescreen/qtcreator_tutorials.xml
	src/plugins/git/gitgrep.cpp
	src/shared/qbs

Change-Id: I6f4d168d888d9547c3af0819f79cc9ebb4186ca0
2017-02-14 15:32:04 +01:00
Leena Miettinen
37891d92bc Doc: Remove Qt Quick UI Forms example and tutorial
It uses types that do not exist in Qt Quick Controls 2, and
Qt Creator version 4.3 no longer has a wizard for using the
older controls.

Change-Id: I42884ca75eefe957493fcb47d6b243a93341b79c
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-02-14 07:50:51 +00:00
Leena Miettinen
6e87ebfe83 Doc: Setting qsTrId() call as default in Qt Quick Designer options
Change-Id: I36f696ea00f87787094d01423ef6308d208012a7
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-02-13 12:44:41 +00:00
Leena Miettinen
c3608ec7e0 Doc: State that Qt Quick Projects cannot be deployed to mobile
...or embedded. Suggest creating an application, instead.

Task-number: QTCREATORBUG-17708
Change-Id: I6b5b1f26bde0d281f162bc68d5cb9088e8fc79cd
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
2017-02-13 10:11:00 +00:00
Leena Miettinen
3858d4c363 Doc: Add licenses to .qdocinc files
Change-Id: Ia20fe2605a6255af24d4334d8289531aaa262511
Reviewed-by: Jake Petroules <jake.petroules@qt.io>
2017-02-13 08:14:53 +00:00
Marco Bubke
b07f3afac6 Initializion with Curly Brackets
Curly brackets for initialization got quite powerful. To not invent a
different style we should use the some style like for rounded brackets.

Change-Id: Id4789fb8d4d7f3980a3a8ce2df999cc57022a2a7
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2017-02-08 14:46:55 +00:00
Leena Miettinen
e8c31158aa Doc: Describe adding Nim Compilers
Change-Id: Ia6ab5c409ae58ae1c7dfd77fd20679dad9266f82
Reviewed-by: Filippo Cucchetto <filippocucchetto@gmail.com>
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2017-02-08 12:16:24 +00:00
hjk
56409f5afa Replace a few occurrences of QStringList() << ...
... by something shorter.

Change-Id: I363b4e509adb07997517b2d233246a333aea4aea
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2017-02-08 11:21:45 +00:00
Leena Miettinen
195c7711cb Doc: Add links from Qt Quick tutorials to UI design overview
...in Qt docs. Because a user felt the information is missing.

Change-Id: I76a7820974073651e6632b0f8e705655377b92c0
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2017-02-08 08:26:21 +00:00
Leena Miettinen
6f2c120d1c Doc: Describe changes in the Qt Quick Designer UI
The canvas area now contains Form Editor and Text Editor tabs.
Further, the Properties view can be split to show any view, so
there are now two sidebars.

Change-Id: Ib921a806178606a76d584440e2308d504a297fcb
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2017-02-08 08:26:04 +00:00
Leena Miettinen
6417865af6 Doc: Write QML in upper case
Change-Id: I42e26b8f6dd38eaefb801fc7c33cb2532fa64df7
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-02-07 15:56:44 +00:00
Leena Miettinen
7f1a71ede4 Doc: Update Qt Quick app tutorial
The wizard and UI have changed.

Change-Id: I43d9101abdcfec362746b069509293df2317ae99
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2017-02-07 14:55:08 +00:00
Leena Miettinen
5250ed4bbc Doc: Fix breakpoint trigger in Qt Quick debugger tutorial
Task-number: QTBUG-58686
Change-Id: Ib50d6679655c1eb8a1b6ff60fbfa743446749827
Reviewed-by: Julien Gueytat <contact@jgueytat.fr>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-02-07 12:36:04 +00:00
Leena Miettinen
8f53c02296 Doc: Describe Qt Quick Designer Form Editor and Text Editor tabs
Users can now use the code editor within the Qt Quick Designer.

Change-Id: I2ad30bafc4b61ce9c1115c9a8b1c019d2b21151e
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-02-07 08:39:20 +00:00
Eike Ziller
6244168202 Merge remote-tracking branch 'origin/4.2'
Change-Id: Idd63494e3878dbf8811c35beb957562255d83813
2017-02-06 14:52:37 +01:00
Leena Miettinen
f76227fa50 Doc: Describe the "New Session Name" dialog
A developer found the options in the dialog confusing.
Also reorganized the "Managing Sessions" topic for
the new text to fit in.

Change-Id: I5bbe0e2bed91ab5759c7d58d0086352ac4ab3751
Reviewed-by: Jesus Fernandez <Jesus.Fernandez@qt.io>
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2017-02-06 13:41:24 +00:00
Leena Miettinen
8e536a3b01 Doc: Update descriptions of Qt Quick wizards
Qt Quick Controls Application, Qt Quick UI, and Qt Quick Extension
Plugins wizards have been removed from Qt Creator.

Change-Id: I30e6e59e38d7f120d35f6cf34603d4ec356a5ef4
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-02-06 09:57:36 +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
Leena Miettinen
e929cc59f5 Doc: Describe the resource editor
This far, it was only briefly described in a widgets tutorial
and the information is needed when using Qt Quick Controls 2.

Change-Id: Ib80a446277e58dbaed9c6a5ac249e2183dc5f63e
Task-number: QTCREATORBUG-17670
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2017-02-03 13:47:27 +00:00
Orgad Shaneh
5159c3f20e Debugger: Add a missing underscore in the docs
Missed in c2e69f7cfb.

Change-Id: I5633dddba21e4b2db5c0300183b791f352af96c3
Reviewed-by: hjk <hjk@qt.io>
2017-02-03 13:45:51 +00:00
hjk
c2e69f7cfb Debugger: Add some examples of dumper function names
Change-Id: I898f8a7dafbca3beb6fdba9c93350b0488973a46
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-02-03 10:08:14 +00:00
Leena Miettinen
2ae989479f Doc: Fix icon filename from icon-pan.png to pan.png
Change-Id: I2d0ff2a480f76fc8e2a84d19d3c3ae5e6cb7819d
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2017-02-01 09:14:03 +00:00