Commit Graph

594 Commits

Author SHA1 Message Date
Leena Miettinen
ccc5223d94 Doc: Describe adding other projects to CMake projects
Mostly, this is explained in CMake documentation. There is
currently no special support for this in Qt Creator.

Task-number: QTCREATORBUG-26616
Change-Id: I7981324e04be6fc716256754db9f2089eaffee73
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-03 12:02:20 +00:00
Leena Miettinen
be059ac11a Doc: Fix info about qtc_runnable for CMake and qmake
Combine the sections and fix misleading information.

Task-number: QTCREATORBUG-26616
Change-Id: I6349d7f6d6765b8f76d391a48c232bf68ed124f6
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-03 09:31:52 +00:00
Mats Honkamaa
06e1182574 Doc: Split the Examples and Tutorials Section into two pages
Splitting Examples and Tutorials to own separate pages.

Task-number: QDS-5495
Change-Id: I0014f1ab456298e9b5887b511f608725ec9d2455
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2021-12-01 13:15:28 +00:00
Leena Miettinen
b6fe15294e Doc: Add CMake way of making global changes to build environment
Task-number: QTCREATORBUG-26616
Change-Id: I67668c64c6e61e36f35a33947c19be5ec1651dad
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2021-12-01 07:49:28 +00:00
Leena Miettinen
4c82d69779 Doc: Update info about opening output panes
- Describe additional ways to open output panes.
- Add a screenshot of the taskbar.
- Add descriptions of related icons.
- Fix the Maximize Output Pane command keyboard shortcut.

Task-number: QTCREATORBUG-26278
Change-Id: I92712d1542871119e4402df18bd10c9563a335d3
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-29 15:30:50 +00:00
Leena Miettinen
0f4a203337 Doc: Edit the How-tos for grammar and punctuation
Also remove the specific mention of Shift key for enclosing
code because that requires Ctrl for curly braces on some
keyboards.

Task-number: QTCREATORBUG-26278
Change-Id: I7daa02392e9f405264bbc5960ad569ea2a4b281b
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-11-29 12:18:24 +00:00
Leena Miettinen
0215a31c4a Doc: Update Performance Analyzer docs
- Describe Create Memory Trace Points button
- Describe Create Memory Trace Points dialog in more detail
- Fix "Load perf.data File" menu item name
- Update screenshots

Task-number: QTCREATORBUG-26278
Change-Id: I028d8da6f19a61bbe457c94287779c2aed0ab7ba
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-11-29 08:13:58 +00:00
Leena Miettinen
136bb81776 Doc: Add missing space
Change-Id: If4480bf34d5ecf5aeab55cd5212865150ffa4568
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-11-26 17:47:50 +00:00
Leena Miettinen
3858181e61 Doc: Describe selecting run targets in kit selector
If several run targets, such as tests or AVDs are configured for
a project, users can select the one to run in the kit selector.

Task-number: QTCREATORBUG-26278
Change-Id: Iaa4828865db7be488ec426c4284573156e5131db
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-26 10:53:51 +00:00
Leena Miettinen
0dcbe6077b Doc: Use \QC macro instead of \QDS for correct branding
This needs to be extended to "Qt Creator" in the Qt Creator Manual.

Change-Id: I86003c306937db5c0318f0fcf5aa917ae789dc39
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-11-26 09:59:44 +00:00
Leena Miettinen
4f2928b935 Doc: Update info about QML Profiler
- Fix some paths to actions and action names.
- Describe Start QML Profiler dialog.
- Update screenshots to use Design Dark mode.

Task-number: QTCREATORBUG-26278
Change-Id: I00359ed21da8e48a9d08d00bfbff634dd50199fb
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2021-11-26 09:52:28 +00:00
Leena Miettinen
06f8d860ed Doc: Mention that QNX for Qt 6 is part of Qt for Device Creation
...and the Qt Creator support is considered experimental.

Task-number: QTCREATORBUG-26278
Change-Id: I7d4963605cc18a016c8bb6be412e6774b4fd106d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-25 14:42:47 +00:00
Leena Miettinen
35f0246006 Doc: Update information about adding generic Linux devices
Key Deployment was pulled into a separate dialog.
Update screenshots.

Task-number: QTCREATORBUG-26278
Change-Id: I257b225c91a65af4b8794cc0a10ec9045e132ac4
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-25 14:42:35 +00:00
Leena Miettinen
4ea1303266 Doc: Edit information about MIME Type options
Try to make clearer where all the actions happen.
Update screenshots.

Task-number: QTCREATORBUG-26278
Change-Id: Iac3499b12a786a644bb7134907ec907ec675acee
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2021-11-25 11:49:18 +00:00
Leena Miettinen
72cd43594c Doc: Add external link target to Qt Application Manager docs
Task-number: QTCREATORBUG-26278
Change-Id: Ibb1e3e7737b31db8afe9c1e83622e211f2e7c554
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2021-11-25 09:07:47 +00:00
Leena Miettinen
068e89eb63 Doc: Use a fixed link to refer to a Qt 6 command
The docs are built with Qt 5 for production, so a fixed
link is needed to:
QNativeInterface::QAndroidApplication::hideSplashScreen()

Task-number: QTCREATORBUG-26278
Change-Id: I9228ea53381532a1b4a5bea863802ea4e97f2956
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2021-11-25 09:07:29 +00:00
Leena Miettinen
c0d8571928 Doc: Describe mapping FakeVim commands
Describe using the FakeVim > Ex Command Mapping tab in Options.
Update and add screenshots.

Task-number: QTCREATORBUG-26278
Change-Id: I926dbebb4c3ba73bda37b08eba010680d1056b23
Reviewed-by: hjk <hjk@qt.io>
2021-11-25 08:24:34 +00:00
Leena Miettinen
e56847f200 Doc: Update info on Beautifier Options
Use the file names for each tool and update screenshots.
Also, some small text edits.

Change-Id: Id8678a7d482f1c33fb1ad779e3d660b88090bd9f
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2021-11-23 14:04:53 +00:00
Leena Miettinen
965fd595bb Doc: Use HTTPS for a link to remove message about broken link
Even though the link with HTTP automatically works on at least
some browsers, the doc snapshot server prints an error about a
broken link.

Task-number: QTCREATORBUG-26278
Change-Id: I5fa030b4b6148dbebeeca9c7dccc0d77dc929243
Reviewed-by: hjk <hjk@qt.io>
2021-11-23 14:04:44 +00:00
Leena Miettinen
60f2b81773 Doc: Fix method to ignore Boot2Qt for auto-linking
Removed the backslash from \Boot2Qt, and added Boot2Qt in ignorewords
in .qdocconf file. Created explicit links to the Boot2Qt topic in
this manual where needed.

Task-number: QTCREATORBUG-26278
Change-Id: Ieac851f711d7a2cd4d7ae034c3b81ab47c5fbc11
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2021-11-23 10:48:46 +00:00
Leena Miettinen
6124bd4124 Doc: Document the designer-developer workflow
Fixes: QDS-4506
Change-Id: Iff581a36c699764b91788e166af82faee282f2d4
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-11-23 08:07:13 +00:00
Leena Miettinen
89e6e99957 Doc: Update keyboard shortcuts for recording text editing macros
Task-number: QTCREATORBUG-26278
Change-Id: I4bbb52859671b4f1840bb1803695fd3f106b05ad
Reviewed-by: hjk <hjk@qt.io>
2021-11-22 13:41:40 +00:00
Leena Miettinen
470beadce1 Doc: Remove obsolete info on "Getter and Setter" tab
The tab has been removed from Tools > Options > C++.

Task-number: QTCREATORBUG-26278
Change-Id: I5b57691dc476a4adcd54c6cc2a5d1128276610dc
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-22 11:55:38 +00:00
Leena Miettinen
4c3756b28b Doc: Add note about C++ settings depending on enabled plugins
Update screenshots for text and code style settings.

Task-number: QTCREATORBUG-26278
Change-Id: Ica3c993592a7e487b351eaac6030378cb36a770a
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-22 11:49:13 +00:00
Leena Miettinen
ccd64cc083 Doc: Update screenshots to use the Design Dark mode
Change-Id: I8851bca12941945bb5f6a442f5c1b6e5a4264a07
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-11-22 10:55:11 +00:00
Leena Miettinen
1d57f755c2 Doc: Document "Prefer single line comments"
Update the screenshot.

Task-number: QTCREATORBUG-26278
Change-Id: I8c7eb57b189a1984be72ba4f15a224c1d80f9610
Reviewed-by: Jacopo Martellini <jack.lilhammers@gmail.com>
Reviewed-by: David Schulz <david.schulz@qt.io>
2021-11-22 08:58:17 +00:00
Leena Miettinen
b569041709 Doc: Update Meson screenshots
And add alt text for them.

Task-number: QTCREATORBUG-26278
Change-Id: Ibe40f284e3162a77982fc3731313a6f2bc9492b5
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-11-19 08:47:58 +00:00
Leena Miettinen
727d1afa6d Doc: Describe "Find References with Access Type"
Task-number: QTCREATORBUG-26278
Change-Id: I08dbea1dd505f818ba2e4e5809e9ca6f37409750
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-11-19 08:16:15 +00:00
Leena Miettinen
9576c34366 Doc: Update info about Valgrind tools
Describe the toolbar options.

Task-number: QTCREATORBUG-26278
Change-Id: I51ebd08a42ba696a3d76f709ff894181d4e9bb7d
Reviewed-by: hjk <hjk@qt.io>
2021-11-18 15:49:22 +00:00
Leena Miettinen
75f9c91c76 Doc: Describe enabling the Qt Quick Designer plugin
The plugin has been disabled by default in 6.0, and
some users have already asked us about it.

Task-number: QTCREATORBUG-26278
Change-Id: I6085b17b0e78592eff285d2d0fc55107593202da
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-11-18 14:40:04 +00:00
Leena Miettinen
67674bca36 Doc: Add alternatives for installing Conan
The installation has been temporarily removed from Qt Installer.

Task-number: QTCREATORBUG-26278
Change-Id: I8de557045857ddaa73e984cce37f31f3d93690bd
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2021-11-18 14:39:52 +00:00
Leena Miettinen
e6e69ad07b Doc: Update info about qmake build settings
Task-number: QTCREATORBUG-26278
Change-Id: Ifa7cd0349ca31c97f8f8db28461db6a4200180fe
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-16 17:04:43 +00:00
Leena Miettinen
949f7c3e84 Doc: Describe "Build missing" option in Conan build step
Task-number: QTCREATORBUG-26278
Change-Id: I0b13495c9bf4b20b4b19e00913b544931d29363d
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
2021-11-15 16:24:41 +00:00
Leena Miettinen
e76b47f184 Doc: Update info about Qbs build settings
Task-number: QTCREATORBUG-26278
Change-Id: Iab2df11d613f6c0a1aa119fcc85104e1bc53e08e
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-15 15:39:18 +00:00
Leena Miettinen
d99145fc54 Doc: Update info about compiler options
Add screenshots.

Task-number: QTCREATORBUG-26278
Change-Id: I55a7f903fd740744c2fc9ada44544641291b95bd
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-15 14:44:38 +00:00
Leena Miettinen
ffc30fedc9 Doc: Describe creating a PySide6 project with the wizard
Task-number: QTCREATORBUG-26278
Change-Id: I643a10cff0a30f0de31851dc5d2077c11248f62e
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
2021-11-15 09:28:03 +00:00
Leena Miettinen
daeb6a0eae Doc: Add Catch 2 test to list of supported testing frameworks
Task-number: QTCREATORBUG-26278
Change-Id: Ic42f63c298c4d7f9ca0373b7737f3653599dbe4d
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2021-11-12 12:16:22 +00:00
Leena Miettinen
1e9e61e4bf Doc: Update info about sidebar views and output panes
Add icons for toolbar buttons.

Task-number: QTCREATORBUG-26278
Change-Id: I92f34775142ebba0489944f90fb956494d0a3174
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-11-12 10:35:16 +00:00
Leena Miettinen
5b84f409c8 Doc: Fix UI string in docs
Task-number: QTCREATORBUG-26278
Change-Id: I82aa350d869f5f2c71489be177096c86d41af73f
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2021-11-12 07:40:32 +00:00
Leena Miettinen
ef9569f9b1 Doc: Link to Qt Design Studio Manual
Task-number: QTCREATORBUG-26278
Change-Id: Id51e9591a63aceae3bd92c0e12d8e423059efaf0
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-11-12 07:40:20 +00:00
Leena Miettinen
c073810ba5 Doc: Describe options for running tests without deployment
Add screenshot of CTest options tab.

Task-number: QTCREATORBUG-26278
Change-Id: I5edc97f32724946486d04965323ee81180857e9d
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2021-11-11 10:13:29 +00:00
Leena Miettinen
b7bae45d12 Doc: Rename "Using Other Build Systems" to "Build Systems"
...now that qmake is not the default anymore, but you can choose
the build system when creating projects.

Change-Id: I52098059e1d32ba2c43c48af7df9dd4c2daff09e
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
2021-11-11 08:09:51 +00:00
Leena Miettinen
05d74d000e Doc: Update information about Git Commit and Amend commit views
Describe the options in the views and add a screenshot.

Task-number: QTCREATORBUG-26278
Change-Id: I434af29f8486b7fa523cca151243a53019e92a42
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2021-11-09 14:24:08 +00:00
Leena Miettinen
a59797afa5 Doc: Update info about using CMake
Update screenshots.

Task-number: QTCREATORBUG-26278
Change-Id: I069908acf0cf4cf529460286362b4da579cba8f3
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2021-11-09 10:44:56 +00:00
Leena Miettinen
b19f236c24 Doc: Describe new Project and File System menu commands
- Show some accidentally hidden information in Qt Creator
  Manual

Task-number: QTCREATORBUG-26278
Change-Id: Ia611633d52e4b012a40d7be548313e62f8ce3683
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-11-05 10:01:30 +00:00
Leena Miettinen
61c8895da3 Doc: Describe new search options
Update screenshots.

Task-number: QTCREATORBUG-26278
Change-Id: I6db12622fc207a6ed6d61da4f27f6ba469d6d307
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-11-05 10:00:57 +00:00
Leena Miettinen
cf72b0064e Doc: Describe clangd support and configuration
Task-number: QTCREATORBUG-26514
Change-Id: I709fb009763fa577ce3887d2107f23dc1daf17eb
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-04 15:13:48 +00:00
Eike Ziller
c2e27bd927 Merge remote-tracking branch 'origin/5.0' into 6.0
Change-Id: I436d15f2aeefbf6fc80340f01398509c213fc1b1
2021-11-03 14:26:47 +01:00
Leena Miettinen
5f191126c1 Doc: Describe "Auto-save files after refactoring" option
Task-number: QTCREATORBUG-26278
Change-Id: I7c9a1ead665ab3506f7cb7a8eb13fb14c5863c8d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-11-02 14:42:33 +00:00
Kai Köhne
75b6266694 Document third-party components by their upstream name
Also use a paragraph from the upstream documentation for
third-party code that missed it so far.

Change-Id: I2609d32eafca9810116f7a9ac2df9221541acb15
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-11-02 13:22:51 +00:00