Commit Graph

1380 Commits

Author SHA1 Message Date
Andrew Shark
6deb5dce75 Minor fixes in documentation
Fix alignment of "<data>" tag.
Correct the thing which the clear button clears (output of cmake, not the search result).

Change-Id: I6a6775c025e334c6a45484c7c59c8de1b4b70421
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-07-29 08:07:17 +00:00
Leena Miettinen
138c8ddd82 Doc: Link from SDK tool commands in the summary to their docs
Change-Id: I19e50073b0c837a0fe0b35b91b68b726b95c4b06
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-26 06:25:10 +00:00
Andrew Shark
f2a5c6f0ce Move icon selection mentioning to correct place
The icon of kit is located next to "Name" field, not next to "Run Device Type" field.

Also, it should not be double-clicked. Just single clicked.

Change-Id: I962dbe2647beeae8f7c5038b2ead3903336172ab
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-07-24 08:22:06 +00:00
Eike Ziller
8a060b285a Fix in-wizard translation support
We in principle support a map of locale->string for keys starting with
"tr" like "trDisplayName". This didn't work everywhere.

We may not cast the value for these keys to QString before passing it to
`localizedString`, since that would result in an empty string if the
value is such a map.

Also fix the documentation since we remove all parts from '_' (to also
get rid of encoding parts).

Fixes: QTCREATORBUG-23575
Change-Id: I2be795053e645c8bf81417d0db69cd7e63eff022
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-07-19 09:36:52 +00:00
Leena Miettinen
bb2ad2d73f Doc: Add topics to more groups
Change-Id: I4c6c7faad4220a7be8c0539aa55008ed79731a8b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-18 06:23:32 +00:00
Leena Miettinen
3bb3fbd698 Doc: Add Python Window UI tutorial to the sidebar TOC
Change-Id: I7550d0e388d08e5ded3baa2d87089f98d6c3b62f
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-18 06:23:14 +00:00
Leena Miettinen
63c48e0199 Doc: Update sceenshot of CTF Vizualizer Timeline
To use the new yellow numbers. Change the order of numbers
to make them easier to find.

Change-Id: Ibf31238e990e295cf2bfadd062c9ac62f2575a27
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-18 06:23:00 +00:00
Leena Miettinen
7d137e56b3 Doc: Fix help topics for QDS
- Hide \sa {Read Documentation}{How To: Read Documentation} to
  fix QDoc warnings
- List the other help topics in "Get help" (they were only accessible
  from All Topics)
- Add an image that shows the QDS Code view instead of
  Qt Creator Edit mode

Change-Id: I85b570b8db8953e5e676e1518fdb03f4e8bfded4
Reviewed-by: Teea Põldsam <teea.poldsam@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2024-07-17 09:52:02 +00:00
Leena Miettinen
431b0c314a Doc: Add a tutorial for using the Qt for Python Window UI wizard
Update the other Python tutorials to describe setting up PySide6
for a project.

Change-Id: Ia0a13f41c1f270fa0ec6c1445f1546e884b7e78f
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-07-16 14:14:25 +00:00
Leena Miettinen
0dab2acd83 Doc: Add examples of .shared file names for different build systems
To make it easier for users to find the information online using search.

Change-Id: Ibd27f724b5c7b0e8bbb69809d98e57b332a25de4
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-07-16 12:57:25 +00:00
Leena Miettinen
9e060ae585 Doc: Update SDK Tool docs
- Add values of addDebugger --engine option
- Make section titles unique so that the links in the
  Contents will lead to correct places
- Link to the values from CMake presets docs, where they
  are also used

Task-number: QTCREATORBUG-30604
Change-Id: Iefa979a3fe4a987191a67e81dffd659963477643
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-07-16 11:51:33 +00:00
Leena Miettinen
bd1829b56f Doc: Update screenshots of Python project wizards
Task-number: QTCREATORBUG-30604
Change-Id: Ia4da792a1270cd25686e9fe02765f81d24232ae2
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-07-16 07:04:24 +00:00
Leena Miettinen
f75821fe99 Doc: Update tutorial names also in sidebar TOC
Change-Id: I4532ef5bbaeee8852dac6b0d9c52ae26d0cc1e32
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-15 10:51:04 +00:00
Leena Miettinen
8ff0438933 Doc: Fix names of UI elements in Qt Widgets tutorial
Change-Id: Id3ca5dc8c10bffe441d1eefdb84e3ed588df33fe
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-15 10:50:52 +00:00
Leena Miettinen
4e40c6b2b4 Doc: Add documentation for the SDK Tool
Task-number: QTCREATORBUG-31082
Change-Id: I0d81240805bb2d0ae9c5bb8f9a42be7af90c6d69
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
2024-07-15 08:33:20 +00:00
Leena Miettinen
95f2f56e02 Doc: Update screenshot of Preferences > C++ > Quick Fixes
Change-Id: I82775c2bea4e5c07bd7e769728786873b46ea8ff
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-07-12 09:49:26 +00:00
Leena Miettinen
b88f1332a8 Doc: Use shorter titles for tutorials
This changes the order in which they are listed to be more
arbitrary, though.

Make some style changes and update screenshots.

Change-Id: Ia46bfb2a6f7e8a297abe07ad1f1026ce1d8bdc79
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2024-07-12 07:19:08 +00:00
Leena Miettinen
6aebad8f80 Doc: Fix typo "righ" > "right"
Change-Id: I45966029de3b55d2be9ec0b9de85a6e3259d162e
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-07-11 13:44:42 +00:00
Leena Miettinen
ad07577e1f Doc: Update docs for project-specific Axivion preferences
Task-number: QTCREATORBUG-30604
Change-Id: I668f1e9cc89a1a138071f3bf103dde7abc6c696d
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-07-11 11:25:55 +00:00
Leena Miettinen
ea3deac2d2 Doc: Add subsections for global and project-level Copilot preferences
Task-number: QTCREATORBUG-30604
Change-Id: I88a75726bb3cca6bb533001f5b65d5c244db2a81
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2024-07-11 11:18:36 +00:00
Leena Miettinen
02ef7186e3 Doc: Add missing introductory text for Debugger preferences
Change-Id: I45a7fd99a7ad262bce389243d5fc177ce75b8041
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-11 09:45:07 +00:00
Leena Miettinen
93fcd753c8 Doc: Fix navigation
- Add "User Interface" and "Configuring Qt Creator" to the TOC
- Fix a \previouspage link to point to the How To topic
- Arrange Reference topic categories in alphabetic order

Change-Id: I674db28d089f5dd13a0bd16d34682fff8887b8ee
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-10 09:16:51 +00:00
Leena Miettinen
dc2af02fa0 Doc: Describe suppressing and filtering Clang-Tidy diagnostics
Task-number: QTCREATORBUG-30604
Change-Id: I259f5484c86b96e31c0cdb4f796d11c2a6afec2a
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-07-05 07:10:44 +00:00
Leena Miettinen
9d65a003d7 Doc: Update screenshots
Task-number: QTCREATORBUG-30604
Change-Id: I08396fd50abf4a7961c91fd36381007716343b33
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2024-07-05 07:10:27 +00:00
Leena Miettinen
b19837f8cb Doc: Use different icons for installation and app development
Task-number: QTCREATORBUG-30592
Change-Id: If914928f3c9ab9c4798ea1a2044e951de3098cbb
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2024-07-04 13:28:45 +00:00
Leena Miettinen
bcd3491fd9 Doc: Update front page and getting started page
Apply new design and images from the UX team.

Task-number: QTCREATORBUG-30248
Change-Id: I202288f0dccedc65e47cd8bdfa49915d47cd79cd
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-04 10:48:11 +00:00
Leena Miettinen
2ba0ad4030 Doc: Describe Android AVD options
- List the available device definitions
- Add information about the other fields

Task-number: QTCREATORBUG-30604
Change-Id: If22f8bfae916bafed7f1153fec7fd5962e406d5f
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2024-07-04 09:23:00 +00:00
Leena Miettinen
e8ad591ae1 Doc: Describe Extensions mode
Task-number: QTCREATORBUG-30604
Change-Id: I5a3b9eadfccfbf759097d48e8cc506d697f53864
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-07-04 08:24:40 +00:00
Leena Miettinen
b6f253548f Doc: Describe the "Use SSH port forwarding for debugging" option
... in Preferences > Devices for a Remote Linux Device.

Add links between developing for remote Linux and debugging
remotely with GDB.

Task-number: QTCREATORBUG-30604
Change-Id: I149447ce5e30409452c203fecc41417822a3d8b2
Reviewed-by: hjk <hjk@qt.io>
2024-07-01 12:58:28 +00:00
Leena Miettinen
e8c32fe472 Doc: Omit "native" when discussing debuggers
Also avoid talking about "debugger plugin".

Change-Id: Iba60f8ad9c655812b6a48e38c1523ddce4f8dcb6
Reviewed-by: hjk <hjk@qt.io>
2024-07-01 12:58:17 +00:00
Leena Miettinen
0afe7caaeb Doc: Mention that perf profiling is supported for app manager apps
Task-number: QTCREATORBUG-30604
Change-Id: I32353849a64459244ccda60ac986b52bbe9813f1
Reviewed-by: Dominik Holland <dominik.holland@qt.io>
2024-07-01 06:47:29 +00:00
Leena Miettinen
5308b11fd2 Doc: Describe new testing preferences
- Timeout can now be turned off and on
- Limit Files to Path Patterns adds filters for scanning
  for tests

Task-number: QTCREATORBUG-30604
Change-Id: Ia0ab109c2dd2958804fea6f6faa1eb9a80377fe3
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-06-28 08:07:08 +00:00
Leena Miettinen
d6eee1e250 Doc: Update supported CMake presets version to 5
Link to the presets docs for version 5, so that users
won't accidentally use fields from newer versions.

Task-number: QTCREATORBUG-30604
Change-Id: Iab548df768d55408dd018e97e2f5c9c1dfc3e594
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-06-26 13:28:23 +00:00
Leena Miettinen
9cb4e8042a Doc: Replace \badcode with \code to show JSON highlighting
...in the online docs. Does not work in the helps.

Change-Id: I6391ff40be2607eb026153deec418e9389954b7d
Reviewed-by: Artem Sokolovskii <artem.sokolovskii@qt.io>
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-06-26 13:11:12 +00:00
Leena Miettinen
064f77a5a8 Doc: Update screenshot of Preferences > Axivion
Add the new options and a link to the docs to the change log

Task-number: QTCREATORBUG-30604
Change-Id: I50acab63b6d7a49c5e2dbf7ebd772f88280fb3a3
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-06-26 07:09:45 +00:00
Leena Miettinen
2f76130a49 Doc: Update info about QML Language Server
- Rename topic as "Configure QML Language Server", as QMLLS
  is now turned on by default
- Describe new preferences
- Remove "QML Language Server" from checkbox labels
- Add a link to the docs to the change log

Task-number: QTCREATORBUG-30604
Change-Id: I397b1747a3d23d728c78dc2eae000839655c4f32
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-06-25 07:44:24 +00:00
Leena Miettinen
b4ece2e056 Doc: Update topics about reading documentation
- Describe the Open Online Documentation option
- Edit the style
- Use How To: Read Documentation as \sa for all topics in the group

Task-number: QTCREATORBUG-30604
Change-Id: I7219ef9a38e993fc1387dd0ece9c8dfe762387d1
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-06-24 14:33:51 +00:00
Leena Miettinen
107a783452 Doc: Describe File > Open Workspace
...which opens a directory as a project and creates a
.json project file.

Task-number: QTCREATORBUG-30604
Change-Id: Ieadcddb298cbf50f25353d344dce0cd1820095e8
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-06-21 13:01:51 +00:00
Sami Shalayel
2809b27be8 doc: document new qmlls checkbox for older versions
Also document the new behavior in the documentation about enabling
older qmlls versions.

Task-number: QTCREATORBUG-31088
Change-Id: I619119f5fec077a50712566bd8fa32b414e239dc
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-06-21 07:31:46 +00:00
Leena Miettinen
2f2ed24092 Doc: Update info on CMake presets
- Described overriding CMake project settings in CMake presets
  or a CMakeLists.txt.shared file
- Added an example of setting debuggers
- Added an example of cross-compiling and running on the wine emulator

Task-number: QTCREATORBUG-30604
Change-Id: I04f26d98e21b1a1a214de5ab4451ac1e758e489e
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-06-21 06:39:36 +00:00
Leena Miettinen
450397f12d Doc: Update screenshots of environment editor
Support for user comments in the editor was already
described in an earlier change.

Task-number: QTCREATORBUG-30604
Change-Id: I69f147681211256be9e25cf63c5b0b8dbd15f452
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-06-20 06:45:00 +00:00
Leena Miettinen
113275118e Doc: Describe overriding values from Preferences > CMake > General
Collect the settings to a table with links to where each setting
is documented.

Task-number: QTCREATORBUG-30604
Change-Id: Ia06076cdd7f51851f58307119716b4ed3cef630e
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-06-20 06:44:44 +00:00
Leena Miettinen
b0428120c4 Doc: Describe the option for hiding unconfigured kits
Task-number: QTCREATORBUG-30604
Change-Id: Ia36c9734937cb7de4e07b417ef36dee178f24f3c
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-06-19 11:11:11 +00:00
Leena Miettinen
ab78847af8 Doc: Update model editor docs
- Describe new model element properties
- Update screenshots
- Update style

Task-number: QTCREATORBUG-30604
Change-Id: I8b296a610ce330d6c382f10e2ff3d8d9994ad503
Reviewed-by: Jochen Becher <jochen_becher@gmx.de>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2024-06-19 08:25:51 +00:00
Cristian Adam
36e84b1c54 Doc/Wizards: Update minimum CMake version to 3.16
Qt Creator due to the usage of CMake File-API was already requiring
CMake 3.14.

Qt 6.7 now requires CMake version 3.16, thus the version requirement
bump.

Note that Qt SDK is shipping CMake version 3.27.

Fixes: QTCREATORBUG-31079
Change-Id: Ife26d178b80949941cb808a1fbd91389d6d723bc
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-06-19 08:12:41 +00:00
Leena Miettinen
b08421af2e Doc: Mention how conditions on SCXML transitions are shown
Task-number: QTCREATORBUG-30604
Change-Id: Ib1c7806951d63c558e0a98aea2f618c2c397acaa
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-06-18 13:10:25 +00:00
Leena Miettinen
c1c462ab11 Doc: Mention "Compiler Explorer Qt & C++ Source" template
Task-number: QTCREATORBUG-30604
Change-Id: I9f21d21086cff38923a2ef2f398d68b2f8652470
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2024-06-18 07:52:44 +00:00
Leena Miettinen
becb0af00a Doc: Add more topics to \ingroup creator-how-to-manage-kits
- Add links to the kit management topics from other topics
- Always use \l{Kits} to link to Preferences > Kits
  This has lived a little, as I've changed the category names

Change-Id: Ibcb137824a23bfe7e320a215eb461f689c43db77
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-06-17 14:33:45 +00:00
Leena Miettinen
e8a85f9974 Doc: Describe options for updating Python Language Server
Task-number: QTCREATORBUG-30604
Change-Id: Ie41a971271e3f350218d45777ed081bc23167f91
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-06-17 08:47:36 +00:00
Leena Miettinen
70941abad9 Doc: Add Type Hierarchy to the list of supported LSP features
Task-number: QTCREATORBUG-30604
Change-Id: Ic8925e990a14a38383f465295d857d15221693df
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-06-14 14:46:57 +00:00