Commit Graph

1059 Commits

Author SHA1 Message Date
Leena Miettinen
35f8f069ad Doc: Fix "the the"
Change-Id: Ib39bc4dddc75a10dedff6006283d1258415d679b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-11-13 11:07:49 +00:00
Leena Miettinen
eb9c2da726 Doc: Turn Managing Sessions into a how-to topic
Task-number: QTCREATORBUG-29361
Change-Id: If15556fdcb5d365b65f1f56a77ab9c21739d0854
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-11-13 09:05:07 +00:00
Leena Miettinen
266f9bc632 Doc: Turn "Specifying Environment Settings" into how-tos
Add a line drawing that describes the environment settings
hierarchy.

Task-number: QTCREATORBUG-29361
Change-Id: I7869797154c0e70263528a8635ea7f2dcee30f30
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-11-09 08:23:10 +00:00
Leena Miettinen
2f664c4c3d Doc: Add a note about iOS support being broken in version 12.0
Task-number: QTCREATORBUG-29392
Change-Id: Iede2437b370971c595df2ddca6a0cb544550b1c3
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-11-08 15:03:24 +00:00
Leena Miettinen
afc5395bd1 Doc: Update info about vcpkg package manager
- Generating code for CMake
- Add vcpkg Package dialog
- Creating vcpkg.json files

Task-number: QTCREATORBUG-29392
Change-Id: Iffe2aadc9f5e2cb9846c56756685d46a2cb079e1
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-11-07 16:30:07 +00:00
Leena Miettinen
ae4b6f9e17 Doc: Update Preferences > Environment > System screenshot
Task-number: QTCREATORBUG-29392
Change-Id: Ic8ccedfbcb3f6aeb139f969bde1c439c78720941
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-11-07 16:29:34 +00:00
Leena Miettinen
04fb088cf9 Doc: Update GDB Preferences screenshot
"GDB" and "GDB Extended" tabs have been combined into one tab.

Task-number: QTCREATORBUG-29392
Change-Id: I5f5e40399abf20d61cf0e2cd4e4c1f02dfc1404c
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-11-07 16:24:16 +00:00
Leena Miettinen
40fae907ba Doc: Update Bare Metal docs
- Describe "Peripheral description file" option
- Update screenshots

Task-number: QTCREATORBUG-29392
Change-Id: I2d2881a13447dd2f14ac13f3b61cb3306b0e7f30
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-11-07 16:24:02 +00:00
Leena Miettinen
fe8b8fc3b2 Doc: Update Beautifier docs
The "Enable auto format on file save" check box was removed
and the group name turned into a check box.

Task-number: QTCREATORBUG-29392
Change-Id: Ic9b01191e523e234431f18ffceb42b9c332bcf5c
Reviewed-by: hjk <hjk@qt.io>
2023-11-07 16:23:42 +00:00
Leena Miettinen
5b8f7c315a Doc: Describe the "Throw on failure" check box
...in Preferences > Testing > Google Test.

Updated the screenshot.

Task-number: QTCREATORBUG-29392
Change-Id: I35faf25fe39cab7569bcefbfd0fa072f55684c2c
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-11-06 15:03:22 +00:00
Leena Miettinen
0b322ef178 Doc: Describe the Preferred comment position option
...in Preferences > Text Editor > Behavior.

Updated screenshots.

Task-number: QTCREATORBUG-29392
Change-Id: If368d6e2e05c81b3b83007bad7636e275a0f3950
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-11-03 13:47:52 +00:00
Leena Miettinen
65366d96c3 Doc: Describe the "Prefer .clang-tidy file, if present" option
...in Preferences > Analyzer > Clang Tools.

Task-number: QTCREATORBUG-29392
Change-Id: Ied7b2894cbe3c502db7d787532ecd1bf6822cea0
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-11-03 07:44:48 +00:00
Leena Miettinen
aa9206ca81 Doc: Describe CMake profiling
Task-number: QTCREATORBUG-29392
Change-Id: I661d6d39148a53daf328b4895d8cd7cabf163d7a
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-11-02 10:00:19 +00:00
Leena Miettinen
372d19f9f4 Doc: Describe CMake changes
- Divide the "Setting Up CMake" into several how-to topics.
- Rename it as "CMake" and link to all the new topics.
- Update related topics accordingly.

Task-number: QTCREATORBUG-29361
Task-number: QTCREATORBUG-29392
Change-Id: Ib8f4a1951b5ffd7eaa25a4e5cf40e7bb252f9cf4
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-11-01 13:26:19 +00:00
Leena Miettinen
edea408026 Doc: Describe new Terminal features
Task-number: QTCREATORBUG-29392
Change-Id: I00aaf4cad1ec521e42f5c55bb236d0c3cb04a4d6
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2023-10-31 12:10:34 +00:00
Leena Miettinen
1341a75c78 Doc: Add new groups for creating projects and files
...and configuring projects.

Task-number: QTCREATORBUG-29361
Change-Id: Icaaa9271b43efe4bba6a4ea436fe0dc6b76bb614
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-31 12:06:16 +00:00
Leena Miettinen
7621b9f0f1 Doc: Update screenshots of Examples tab and kit selector
In the Building and Running an Example tutorial.

Task-number: QTCREATORBUG-29392
Change-Id: I7fa0bfe0917e54f6706f555879015501e81ef525
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-31 12:03:13 +00:00
Leena Miettinen
8762af4912 Doc: Describe the "Stage for installation" option
...in Projects > Build & Run > Build Settings.

Updated screenshots.

Task-number: QTCREATORBUG-29392
Change-Id: Ieb44b593452e4999c9603ae51148075cb23b6e86
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-10-31 11:05:51 +00:00
Leena Miettinen
52a6d2ab6b Doc: Describe the Preferences > "Sort categories" option
Task-number: QTCREATORBUG-29392
Change-Id: Icfe9caa387fdf809be136b813de6b9ffe4a05718
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-31 10:37:49 +00:00
Leena Miettinen
dc4703e5c0 Doc: Describe Preferences > Testing > General > Scan threads
Task-number: QTCREATORBUG-29392
Change-Id: I71f253b0ffd6df615525da0c4c31e72245970bec
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-10-30 12:02:26 +00:00
Leena Miettinen
472b4cb358 Doc: Describe changes in Git Instant Blame
"Instant Blame" is now a check box. The
"Add instant blame annotations to editor"
check box was removed and the following were added:
"Ignore whitespace changes" and "Ignore line moves".

Task-number: QTCREATORBUG-29392
Change-Id: I8dd0a779dd4a72fef7a5bb1a9023c3b705f0f174
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2023-10-30 10:57:48 +00:00
Leena Miettinen
022847c852 Doc: Make the instructions for enabling plugins more consistent
- Add the following for documented plugins that are
  disabled by default: \note Enable the <name> plugin to use it
- Add \sa {Enable and disable plugins} for the above plugins and
  describe there how to find the About Plugins dialog on macOS
- For the one occurrence in the QDS Manual, add instructions for
  finding the About Plugins dialog on macOS ("Enable and disable plugins"
  is not included in the QDS Manual
- Mostly remove other kinds of references to enabling plugins

Task-number: QTCREATORBUG-29734
Change-Id: I7b12bd651c1c99e0c6b3ca6f94d3831ebe038438
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-27 06:59:11 +00:00
Leena Miettinen
1b82616f35 Doc: Describe the "Forward to local display" check box
In the run settings for a remote linux device.

Task-number: QTCREATORBUG-29392
Change-Id: Ib46241b62b4b0208f4f1e52419cc1b2a18e40295
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-10-26 09:09:34 +00:00
Leena Miettinen
70ed0aaa82 Doc: Describe using variables in "Default build directory" field
In Preferences > Build & Run > Default Build Properties

Fixes: QTCREATORBUG-29779
Change-Id: Ic893058d081655e21a294b0dcc25ccb0184f4564
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-10-26 07:37:24 +00:00
Leena Miettinen
9d4c31cb74 Doc: Describe using the locator to go to tabs in Preferences dialog
Change-Id: I9644cdc830494c4e02599b72c584eb02aed1f4f8
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-25 13:15:05 +00:00
Leena Miettinen
d72fa04833 Doc: Update QML Language Server preferences docs
- Some labels changed
- "Use QML Language Server advanced features" was added

Task-number: QTCREATORBUG-29392
Change-Id: I2c4f4d43b8f8e9d74186439e31a9d8cf13ec4967
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-10-25 11:06:41 +00:00
Riitta-Leena Miettinen
0fe891678a Doc: Use a link to "Find preferences" as value of \preferences
- Add the instructions for finding the Preferences menu to the
  "Find a particular preference" topic and rename it "Find preferences".
- Remove the "Find menu items on macOS" topic

Change-Id: I627e5c20d2c63efb4490d446608b923ac15a6aac
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-24 09:00:36 +00:00
Leena Miettinen
86e8676bec Doc: Describe setting DPI rounding policy
Task-number: QTCREATORBUG-29392
Change-Id: I45eef9d1282f7df3f75f08ff55745c4205f553d9
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-10-23 10:40:00 +00:00
Leena Miettinen
e454dc0f1f Doc: Describe setting default C++ file name extensions for a project
Task-number: QTCREATORBUG-29392
Change-Id: I2bba1d26dc6177a1f6b3f78483e669244fa15ff1
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-10-23 06:49:34 +00:00
Leena Miettinen
fb788dec30 Doc: Describe new and changed preferences in C++ > Clangd
Task-number: QTCREATORBUG-29392
Change-Id: I54c56b65a531bccd233f5405c3add4f0dc4c18ab
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-10-20 10:07:40 +00:00
Leena Miettinen
eccbff7698 Doc: Describe Tools > C++ > Fold/Unfold All Comment Blocks
Task-number: QTCREATORBUG-29392
Change-Id: Ie92253165b5004455be6f7dd8e031431c4358dae
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-19 14:30:22 +00:00
Leena Miettinen
6ae4d71a1b Doc: Update GitHub Copilot docs
- Change link to Neovim plugin installation to point to the Readme.md
- Add instructions for macOS users for finding the About Plugins and
  Preferences (using the \preferences macro)
- Describe proxy settings
- Fix a changed check box name

Fixes: QTCREATORBUG-29734
Fixes: QTCREATORBUG-29613
Task-number: QTCREATORBUG-29392
Change-Id: I2b392e805322fd95a7b87295756d5df76015bbbc
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2023-10-19 11:32:33 +00:00
Leena Miettinen
81898c675c Doc: Add a \preferences macro and use it everywhere
The macro can be used to show the path to Preferences
on Windows, Linux, and macOS. The current value expands to:
"Edit (or Qt Creator on macOS) > Preferences".
We can now change this in one place if we so wish.

Task-number: QTCREATORBUG-29734
Change-Id: I9afe4f7093dbcc8e62a2b18e1ae3f6f243bbb72b
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-18 14:43:29 +00:00
Eike Ziller
e51b378ac9 Core/Tr: Fix menu bar action
It is "menu bar", and use placeholder for shortcut instead of
concatenation.

Change-Id: I60094a5fac3893663180f7ef573b6dece7670111
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-10-18 14:11:13 +00:00
Leena Miettinen
5d79b010bf Doc: Describe the Markdown editor toolbar buttons
Task-number: QTCREATORBUG-29392
Change-Id: I390e2c525f9c1c6cadf874cfc313b17429f1f52a
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-18 07:35:36 +00:00
Leena Miettinen
5b97cb375b Doc: Describe new C++ refactoring actions
- Convert Comment to C/C++ Style
- Move Function Documentation to Declaration/Definition

Task-number: QTCREATORBUG-29392
Change-Id: Iae48cd752c909a0007929e0111aa149fbfea02ee
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-10-17 08:48:20 +00:00
Leena Miettinen
3d3a3c8ba8 Doc: Fix grouping of the Record screens topic to "How to Use Qt Creator"
Change-Id: Ic967149435fbb772cfa81e2cdf7eb52fb9baecaa
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-10-16 12:40:12 +00:00
Leena Miettinen
3078aaadcf Doc: Describe debugging CMake project files over DAP
Task-number: QTCREATORBUG-29392
Change-Id: Iceb7f0d07cae62e14b2e2c52c43aaaca090ad07d
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-10-16 10:55:45 +00:00
Leena Miettinen
3e404945cf Doc: Describe the Antialias check box
...in Edit > Preferences > Help > General. Used to disable
antialiasing of help text.

Task-number: QTCREATORBUG-29392
Change-Id: Idc9611d4dd514f8099231b937634cc4da540e957
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-16 08:00:36 +00:00
Leena Miettinen
a4bc7b6ec2 Doc: Describe the line and column indicator
It now shows information about all cursors in the current
document, including selection length for selections.

Task-number: QTCREATORBUG-29392
Change-Id: I160f618215ee969ebb8509bf196c5e4df171b83d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-16 08:00:21 +00:00
Leena Miettinen
3e1ac24141 Doc: Describe the "Sort results" option in md locator filter config
Users can clear the check box to use the sorting from the tool.

Task-number: QTCREATORBUG-29392
Change-Id: I8c656b7dd480ebc4bf16be33b198989bd65d8ecd
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-16 07:57:32 +00:00
Leena Miettinen
57606dfb55 Doc: Describe how to hide and show the main menu bar
After users hide the menubar, they cannot see the keyboard
shortcut for showing it anymore.

Task-number: QTCREATORBUG-29392
Change-Id: I7a26d6bd0972457e225b33d2b041c158ad71548e
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-10-13 13:08:31 +00:00
Leena Miettinen
c324ef6321 Doc: Edit compiler explorer options docs
Update the screenshot after string changes.

Change-Id: Ie6efb13018828b20180b0ff3df2e4607089c8b03
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2023-10-13 10:39:44 +00:00
Leena Miettinen
c044f6104b Doc: Add missing section to TOC and How To
...and fix some \brief commands.

Task-number: QTCREATORBUG-29361
Change-Id: Ic37845ed5c7a02035fcc2e140fd35ad466fff2e3
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-12 14:59:44 +00:00
Leena Miettinen
fd92781e87 Doc: Use the \generatelist command in TOC, How To, and Reference
...to automatically list the topics in each group and avoid manual
work.

Task-number: QTCREATORBUG-29361
Change-Id: I45391b548354e6499bbd0698a9da8d6f9dc77dff
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-12 13:54:13 +00:00
Leena Miettinen
78974347c5 Doc: Describe screen recorder
Fixes: QTCREATORBUG-29721
Change-Id: I19c1067b9394ff24e94be3ded4b9c20c5a01c364
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-10-12 12:43:13 +00:00
Leena Miettinen
fe6dd868c5 Doc: Describe Compiler Explorer
Fixes: QTCREATORBUG-29720
Change-Id: I1de27d01a684249cd8bd3e5e8c98a551947a4436
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2023-10-12 10:54:57 +00:00
Leena Miettinen
551dde7fa9 Doc: Describe Documentation Comments preferences
- Add a topic for setting preferences for Doxygen-style docs
- Update screenshot for Text Editor > Completion preferences, where
  the documentation settings used to be

Task-number: QTCREATORBUG-29392
Change-Id: Ifb915e78f3d2a5fb97555dd99bfaa5abf12ef14b
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-10-11 12:05:32 +00:00
Alessandro Portale
03cca64eea ProjectExplorer: Add non-translatable text options to text edit fields
LineEdit and TextEdit have a couple of text options which start with
"tr". These strings can be translated via Qt Linguist.

In some cases, these text options contain macros or even JavaScript code
which must not be translated. Translation of these fields can
easily break the wizard.

This change adds the possibility to set non-translatable options for
LineEdits and TextEdits "(tr)Text", "(tr)DisabledText" and
"(tr)Placeholder" in the .json files.

Task-number: QTCREATORBUG-29649
Change-Id: I278a0bec848888cf96bdb49306e319c14a09236c
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-11 10:34:28 +00:00
Leena Miettinen
5a715330fc Doc: Describe detaching views
Fixes: QTCREATORBUG-29636
Change-Id: I980d7c523bd40cbc7ad56696987688839baf154d
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-10-11 07:26:23 +00:00