Commit Graph

3031 Commits

Author SHA1 Message Date
Leena Miettinen
85bcef044c Doc: Fix typo "fil" > "file"
Change-Id: Iaa0f25c9ef0c76f2923f91354304e3b0c6bb78b1
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-02-28 12:04:42 +00:00
Leena Miettinen
fb185eef11 Doc: Update screen shot to show the list of locator filters
Change-Id: If6b4068676e994ce5ec684432983df3f173dfab5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-28 11:57:45 +00:00
Leena Miettinen
a8c9d394fd Doc: Replace "Qt Bug Tracker" with "Qt Project Bug Tracker"
Add links where they were missing.

Change-Id: I218c1160226ec5223e6bd055d73e82092f254792
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-28 09:30:42 +00:00
Leena Miettinen
d119258c9d Doc: Describe new help options
- Only latest docs are registered by default
- Users can change the settings for displaying help in
  the detached help window

Change-Id: Id7efb98e11eb8a27b7d01422e65ac63b860c868e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-28 08:58:56 +00:00
Leena Miettinen
ae98f91f1b Doc: Update info about finding with the locator
- Describe the new bug filter
- Describe the new URL template custom filter type
- Update screenshots

Change-Id: I830b3953e89e97a7e5a405687915b67153412d9a
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-28 08:10:00 +00:00
Leena Miettinen
171ad62aed Doc: Describe linking Qt Creator to a Qt installation
... for sharing auto-detected Qt versions and kits

Change-Id: Ie0063b0a66a58508bb848b2b8fb4b29cadc35c26
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-27 12:07:04 +00:00
Leena Miettinen
5278f69851 Doc: Fix typo "ajust"
Change-Id: I6a974dc9e9f9439392cf8029740fe72415f80e54
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2020-02-27 10:03:58 +00:00
Leena Miettinen
da5d53b89b Doc: Document the Restart Now button that appears when needed
Typically, when users enable or disable plugins.

Change-Id: I1d9588e662613d6c061756d247bf12f7c1ace4ba
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-26 16:15:21 +00:00
Leena Miettinen
4a9dc144f0 Doc: Remove duplicate file
This file has been moved to \doc\qtcreator\src\...

Change-Id: Idaf18e7113f8af9e4054682872eaefc419dc63fc
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-26 14:15:28 +00:00
Leena Miettinen
8b5934900c Doc: Describe using custom fonts in Qt Quick Applications
Developers can use custom fonts in Qt Quick UI projects that they
create in Qt Design Studio. Additional steps are needed when
converting these projects to Qt Quick Applications.

Fixes: QTCREATORBUG-23646
Change-Id: Iebc8e6efd9683450232d1ea878925f9791536663
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-02-26 14:11:54 +00:00
Leena Miettinen
4cd4316a16 Doc: Replace "pane" with "view"
...for anything listed in Window > Views, except "Output Pane".

Task-number: QTCREATORBUG-23582
Change-Id: I1a46de22657dd5779d693a5078b5aca8b1b57a37
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-02-26 08:10:19 +00:00
Eike Ziller
0acce09457 cmake build: Fix qdoc call for LLVM-based qdoc
It requires us to pass a whole bunch of include paths manually,
including Qt include paths.

Extracts a stripped down list of include paths from all the plugin and
library targets that we know of.
On macOS, also gets Qt's framework path derived from the QtCore location.

Since these can contain generator expressions, we have to write them to
a file (so the expressions are resolved).
We pass this file with qdoc options with the hidden "@" command line
feature of qdoc.

Task-number: QTCREATORBUG-22451
Change-Id: Ifae6960023cc6e63cd66104417dd4a16f2e491a2
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2020-02-26 06:42:51 +00:00
Leena Miettinen
2c406ff398 Doc: Describe managing workspaces
Conceptually separate dockable views from sidebar views, because
the former can now be organized using workspaces in the Design
mode (where the sidebars are now disabled).

Fixes: QTCREATORBUG-23582
Change-Id: Iaf310d4fbc9277330708f6756201e4b43dc1eedb
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-25 13:38:04 +00:00
Leena Miettinen
ac26d3bab9 Doc: Add Core:: namespace to \fn commands
To suppress QDoc warnings.

Task-number: QTCREATORBUG-23620
Change-Id: I4e5c633e7a0066f892f3247c28dac055557e68da
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-25 13:37:46 +00:00
Leena Miettinen
98e940c9b3 Doc: Display Core plugin classes in the API Reference
Task-number: QTCREATORBUG-23620
Change-Id: I64b3fc9ebd9ec140a28a5fbb2f70961086821ed2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-25 13:37:30 +00:00
Thomas Hartmann
0a4471dbbb QmlDesigner: Rename 'Imports' to 'QML Imports'
Change-Id: Ice57052273ac2e7eef555c9a26a9032098541d8e
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2020-02-24 15:42:53 +00:00
Leena Miettinen
45a575c218 Doc: Fix QDoc warnings in Core plugin Wizard classes
Task-number: QTCREATORBUG-23620
Change-Id: Ia8d27be35911378703126c1e2d06a157ce6185f0
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-21 11:37:36 +00:00
Eike Ziller
e886c13abc Make documentation part of branding
So Design Studio can build different documentation than Qt Creator

Change-Id: I078df39d36533a1659caac937ef869e4bf0c7a43
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-02-19 06:57:53 +00:00
Eike Ziller
e2fad3afa4 doc: Fix qdoc warnings in aggregation
Change-Id: Ia9a2e6dcdb8dc82ae600b974e396fd8ac3a42678
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-02-18 10:02:48 +00:00
Eike Ziller
bf25c21eb0 Merge remote-tracking branch 'origin/4.12'
Change-Id: I333037e56be7280b86ce577ea63393245c28c09d
2020-02-17 16:47:06 +01:00
Leena Miettinen
8046e3311f Doc: Fix QDoc warnings in Find classes
- Document BaseTextFind and FindSupport
- Mark undocumented classes and namespaces \internal
- Add and fix docs for IFindFilter, SearchResult, and
  SearchResultWindow

Fixes: QTCREATORBUG-23600
Change-Id: Ic9445f7f15562f114f4cbd9fe16988d7249d48db
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-17 15:45:51 +00:00
Eike Ziller
a467e34e58 Fix qdoc call after it moved to LLVM/Clang
For some unknown reason qdoc does not add the include paths for
Qt modules, so we need to do that manually.
Also, if we do that, we need to pass it the default include paths, so
standard C++ headers are found.

Qt includes and standard headers are found now, but

Framework style includes on macOS still fail ("QtCore/QString"), which are
used in Qt headers as well. Looks like the framework path that is passed
with -F to qdoc is not passed on correctly.

Task-number: QTCREATORBUG-22451
Change-Id: I04b2c75ecdeb1f0e70ba9adfea039f0ff16ec96b
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-02-17 15:45:48 +00:00
Leena Miettinen
d06eee5218 Doc: Fix QDoc warnings in Core plugin dialogs classes
- Fix IOptionsPage class docs
- Mark PromptOverwriteDialog and ReadOnlyFilesDialog

Fixes: QTCREATORBUG-23608
Change-Id: I6a646f0bd68230a7c5f80bd748bda20729f23b74
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-17 14:56:39 +00:00
Thomas Hartmann
0ffc029d70 QmlDesigner: Rename resources to assets in the ui
Task-number: QDS-1646
Change-Id: I8937f70adc3ad59f28d40f99852f2be053ce6c3b
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-02-14 15:31:23 +00:00
Leena Miettinen
9c8b340816 Doc: Link to information about exporting 3D assets from Blender
...for importing them to Qt Design Studio.

Fixes: QDS-1470
Change-Id: I47e8a947fecbf0971fdeab32ae41dcaa645cd359
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
Reviewed-by: Andy Nichols <andy.nichols@qt.io>
2020-02-14 07:59:20 +00:00
Leena Miettinen
b979e1f587 Doc: Add general guidelines for preparing 3D assets for export
These guidelines help optimize the 3D assets for importing them to
Qt Design Studio.

Fixes: QDS-1431
Change-Id: I267c3897b8da42271948d2b1e45596e3928dbf1f
Reviewed-by: Andy Nichols <andy.nichols@qt.io>
2020-02-14 07:59:10 +00:00
Andre Hartmann
c83a33941d Doc: Describe diffing from editor to another file
Task-number: QTCREATORBUG-17866
Change-Id: I073f998bb9a00bfcf765766b5690a9dc19209a70
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-02-13 08:24:01 +00:00
Leena Miettinen
5997f9754d Doc: Add a note that qmltooling plugins are required for QML debugging
Task-number: QTBUG-82039
Change-Id: I042b8212e3571b806e9a35b12fa83cc84006b2e6
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2020-02-11 14:42:17 +00:00
Leena Miettinen
87b2107290 Doc: Describe the Telemetry plugin
Fixes: QTCREATORBUG-23586
Change-Id: Ie0bd470dcf3cc23d401219d0a83f4179a4948acf
Reviewed-by: Vitaly Fanaskov <vitaly.fanaskov@qt.io>
2020-02-11 13:19:52 +00:00
Leena Miettinen
e12ba2d683 Doc: Fix broken links in Extending Qt Creator Manual
- Move some images from qtcreator\images to qtcreatordev\images
- Hide directories from the doc build (these will be added
  gradually when we fix the docs for the classes in them)
- Fix broken links
- Add README.md that describes the doc projects in the repo

Fixes: QTCREATORBUG-23544
Change-Id: I4fc29d8fbc8b7a0a0f81fa3261f6412c47b9d84e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-10 13:40:43 +00:00
Topi Reinio
4454873b54 Extending Qt Creator Manual: Fix links in the online sidebar
Change-Id: I08ca0c0847c022052428623de3be0416b8682e8d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-02-06 11:54:02 +00:00
Orgad Shaneh
0737291d54 Merge remote-tracking branch 'origin/4.11'
Change-Id: I65ce6aa917219a8f8b91b48c7077f8097248375c
2020-02-06 12:50:22 +02:00
Leena Miettinen
bab8c9b91f Doc: Fix IPlugin class docs
Fix \fn command values and document missing enum and arguments.

Remove unnecessary \fn commands, so that the signatures don't
need to be maintained.

Fix formatting and language issues.

Task-number: QTCREATORBUG-23544
Change-Id: Iddddb704a51e7a4fa9ac79fa2d4a89aa6abeefd5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-05 12:48:15 +00:00
Leena Miettinen
674d342aa9 Doc: Add doc footer and sidebar TOC
These are required for publishing the manual at doc.qt.io.

Because this doc is more a collection of articles than a
traditional guide, list the topics in this guide in the
TOC in alphabetic order.

Change-Id: I2f604ee19f81dcaaccf4601440f178b41b77ec9a
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-02-05 12:11:19 +00:00
Eike Ziller
5c121d5791 Merge remote-tracking branch 'origin/4.11'
Conflicts:
	src/plugins/genericprojectmanager/genericproject.cpp

Change-Id: Ib54f1645ec70a9e6460a888a13190ede130bccca
2020-02-05 11:59:35 +01:00
Andy Shaw
c50e928e76 Fix progressbar example so that it compiles and related doc
Change-Id: I17423a57cf4e86492462caacd3ba0a9d5d4dd6be
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-01-30 13:22:56 +00:00
Leena Miettinen
5ee95ad636 Doc: Update information about Qt Quick 3D Model types
The primitive types are now available as components in
Library > Qt Quick 3D.

Fixes: QDS-1544
Change-Id: I472280bab4bd219eff14b8fd30546941a7ac6a95
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2020-01-29 14:42:30 +00:00
Leena Miettinen
18514a5585 Doc: Fix links in the Extending Qt Creator Manual
- Hide links to sections that have not been written yet
- Fix some links to information that was moved
- Use HTTPS in links to Qt Creator Manual topics

Fixes: QTCREATORBUG-23529
Change-Id: Idd162c04fe6992bbecd2acd4a7ec388e49f29b84
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-29 12:40:39 +00:00
Leena Miettinen
5c13c7ae7b Doc: Add information about how pivot offset is visualized
Fixes: QDS-1543
Change-Id: I79b00c3e5b3c23f91bf6c6b8b670d53f7870e3a0
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2020-01-28 09:12:37 +00:00
Christian Kandeler
350fe09cec Adapt qbs build to doc changes
Amends 5fc456dd22.

Change-Id: I342b82248ee84267613dd17583840d1c4daaaef3
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-01-27 12:33:51 +00:00
Leena Miettinen
5fc456dd22 Doc: Rearrange files in the doc folder
Source and configuration files for each manual are now located in a
separate subdirectory, with common configuration files in doc/config.

doc
|_config
|_qtcreator
|_qtcreatordev
|_qtdesignstudio

Edit the config files accordingly.

Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-27 09:05:07 +00:00
Leena Miettinen
5b21c66b1d Doc: Update information about Sketch
This change was missed when moving the docs.

Change-Id: I106f5505de46785afd80ea668aa2c13ee4a9d072
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-23 14:48:31 +00:00
Christian Kandeler
12184b9546 ProjectExplorer: Allow to build a project in all configurations
Task-number: QTCREATORBUG-16815
Change-Id: I5c31878f005f8350b3e4aff88ad46ab93c804ce4
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2020-01-22 14:00:32 +00:00
Christian Kandeler
33e86cdbaa ProjectExplorer: Move "default build dir" setting to new options page
The new "default build properties" page is a better fit now.

Change-Id: I2e8e3ed2a7881bb769b72de72a23df2c752a53b0
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-01-22 08:47:01 +00:00
Leena Miettinen
d596da23b9 Doc: Add information about Nimble projects
Fixes: QTCREATORBUG-23493
Change-Id: Icf1895d1ccbd3c004e546e75be426e65f2b2f009
Reviewed-by: hjk <hjk@qt.io>
2020-01-21 14:18:03 +00:00
Leena Miettinen
c16e205a77 Doc: Describe saving Clang-Tidy configuration as a file
Fixes: QTCREATORBUG-23223
Change-Id: Ia78220bb959e9bafb9101e3f130ab75180c1b816
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-01-21 13:22:20 +00:00
Leena Miettinen
6ff762be51 Doc: Describe new Qt for Python application wizards
Fixes: QTCREATORBUG-23484
Change-Id: I86b1988b5b807cad41bfe537b46093c862d85514
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
2020-01-21 08:53:44 +00:00
Leena Miettinen
4a971127ac Doc: Add Qt Design Studio Manual sources
To build the manual, switch to qtcreator\doc\qtdesignstudiodoc,
run qmake, and then "make docs".

The example documentation does not get built with this change.
We need to decide whether to move the examples or fetch their
docs from the other repository.

Task-number: QDS-1487
Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-20 13:54:38 +00:00
Eike Ziller
bd5dae90ad Merge remote-tracking branch 'origin/4.11'
Conflicts:
	share/qtcreator/qml/qmlpuppet/qml2puppet/instances/qt5informationnodeinstanceserver.cpp

Change-Id: I5e424e34db619bb769c7abc1e8651b7b40210839
2020-01-20 09:59:27 +01:00
Leena Miettinen
5f8fe92105 Doc: Describe collecting LTTng data and converting it into CTF
...for viewing in the Chrome Trace Format Visualizer.

Based on a QtWS19 talk by Milian Wolff:
https://resources.qt.io/qt-world-summit-2019/lttng-for-full-stack-tracing

Fixes: QTCREATORBUG-23471
Change-Id: I173aa68e7198c7f13aecb73f28000af02d7ec0ed
Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
2020-01-16 08:42:20 +00:00