Commit Graph

1214 Commits

Author SHA1 Message Date
Eike Ziller
ff08e30b0a Doc: Improve the description of default build configurations
- Consistently use emphasis and case for configuration names
- Do not promise *separate* debug information for "Profile". CMake
  doesn't have that option
- Add information about "Release with Debug Information" for CMake and
  the difference to "Profile"

Fixes: QTCREATORBUG-30581
Change-Id: Idd53b11d3dd45121a34a41f12e48ea5339fd61c1
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-22 08:51:44 +00:00
hjk
68772325cd Doc: Point to the pull-down menu of the debug mode button
... for starting analyzer tools. It's not very prominent in the UI.

Change-Id: I476d45b4f82a4b363fa4e33858261283850ff654
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-21 14:16:30 +00:00
Leena Miettinen
9e1c513167 Doc: Add direct links to reference topics to the front page
Add links to "Version Control Systems" and "Views"

Change-Id: I7a3865bde35912307be3b86fd19c2387cb755cba
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-03-21 12:21:14 +00:00
Leena Miettinen
78f3dfad87 Doc: Make the \page value consistent with that for other tutorials
Fix the link in the TOC sidebar online.

Change-Id: I4522c7b65be6498797e5945f3e9c6dc4b4f3966b
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-03-21 12:00:12 +00:00
Eike Ziller
9fe7922058 Doc: Small improvement of the locator pages
It was unclear what "file type" was meant. The available filters could
depend on a lot of other things, but I guess "current document and
project" is ok as a baseline.

Clarify what list of filters is meant, that is the list that appears when
the locator input field is empty. Mention the list that is shown when
selecting the magnifying glass. The descriptions in the preferences is
not longer than what appears in the tool tips, so remove that reference.

Mention the Magnifying glass > Configure menu item as an option for
opening the preference page.

Change-Id: I7d16d3f3eed11cce0aff9dcaf7e467fe0508366e
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-21 07:13:29 +00:00
Leena Miettinen
d644632382 Doc: Remove references to CMake from a qmake-specific topic
Fixes: QTCREATORBUG-30580
Change-Id: Ic722ca8c6cfcf570aec48eb957ebfdc2ec929011
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-03-20 15:59:21 +00:00
Christian Kandeler
2cacb1444c doc: Update tutorial for creating mobile app
Change the wording so it no longer suggests we are shipping an outdated
CMake.

Change-Id: Ifa1d44017eb66fffd7b3dff17b2d5af2e247cca5
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 14:35:42 +00:00
Marcus Tillmanns
9ed9d6fc8a Doc: Reword beginning of creator-keyboard-shortcuts.html
Change-Id: Id1f736c7855002d3ecd8c600d9897ae81c83947c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 13:56:49 +00:00
Marcus Tillmanns
dd2942d157 Doc: Improve "Manage files in CMake projects"
Change-Id: I2fa40b005f534bc71789d4fd834307c7dca1b867
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 13:53:00 +00:00
Christian Kandeler
0a4b0e71d3 doc: Clarify which settings page to switch the theme in
While "Interface" is the first (and therefore default) tab, the user
might have visited a different one before, in which case it will become
the new default and the user will look in vain for the theme setting
there.

Change-Id: I66d3035d16aa75162616d08a021bc43c906a7133
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 12:26:41 +00:00
Christian Kandeler
c16e15f37b doc: Update information about main build system
Also clarify that the set of supported build systems is not fixed.

Change-Id: Ida2588c599a4fc4deadfd62b10fb47c2bbda5457
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 11:59:13 +00:00
Christian Kandeler
f75e26005f doc: Specify that the list of pre-configured build configs is not fixed
E.g. cmake has five of them.

Change-Id: I8521c99335b9b31a7ab5f9691de9639394450fd1
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 11:51:01 +00:00
David Schulz
a3668827aa Doc: improve create python project tutorials
Use consistent paths in screenshots and instructions. The paths from the
screenshots are preferable since they are not inside a default Qt
installation location.

Change-Id: If9f0bca58a13a66559eae953ccaf19abb2dc7e14
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 11:14:41 +00:00
Eike Ziller
3ad0f8900b Doc: Improve iOS documentation
- make it clearer that the restrictions are only for iOS 17 devices
- refer to Xcode 15 instead of 7
- remove wrong and not very useful section for checking/changing Xcode
  version
- fix screenshots

Change-Id: I1d574ee775c6e1a9db1df8b60b6e5b8aa9dd057f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 10:48:55 +00:00
hjk
5eca9c5614 Doc: Rename "Export SVG images" to "Create pixmaps from SVG images"
Also switch the order with 'View Images', which is likely the more
common use case.

Change-Id: I2a047141976b7ec7a45cf930be5bf972a766d183
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-20 08:35:23 +00:00
Leena Miettinen
9884620724 Doc: Remove "Coding", "Finding", and "Configuring the Editor"
- In the QDS Manual, edit the "Code" view docs
- In the QDS Manual, add topics related to coding to the "Code"
  view docs by using \ingroup and \generatelist commands

Task-number: QTCREATORBUG-29361
Change-Id: I0966986a3b01b3551e8b68265e22fe86d1d5933d
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-03-19 12:37:53 +00:00
Leena Miettinen
05b640abc0 Doc: Turn "Checking Code Syntax" into how-to and reference topics
Task-number: QTCREATORBUG-29361
Change-Id: I96c4384dbde04189be3c80c3b21ee09ca33fb90c
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-19 12:37:45 +00:00
Leena Miettinen
fadfb93b8e Doc: Fix broken links
- Add a dependency to qtqmltest (Qt Quick Test)
- Fix an internal link
- Fix capitalization in links to Qt docs, which now
  seems to matter
- Add the "Qt Qml" link as an external resource, so it works
  regardless of the Qt version used

Change-Id: I0550973237b0df7b328ca202a4188d970af3417d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-19 10:58:21 +00:00
Leena Miettinen
85b3413daf Doc: Fix the value of \page for "Link projects with GitLab"
Using the same value for two topics hides the old topic, but
QDoc did not complain during local builds.

Change-Id: Id5d927cca60c9d288323429c99969475c9ecd15b
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2024-03-18 10:34:11 +00:00
Leena Miettinen
10858b1f68 Doc: Fix minor language issues in Axivion docs
Some text had gone missing.

Change-Id: I9b699f8b47d5897b11dae7aafa8c738f95774abf
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-03-18 09:28:28 +00:00
Leena Miettinen
e7351a8024 Doc: Add links to docs for project-specific settings
...to "Configuring Projects"

Turn "Linking Projects with GitLab" to a separate how-to
topic.

Some style edits.

Change-Id: I3fd68b303126770965c7ca68ca2e041daf593d74
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2024-03-18 07:39:15 +00:00
Leena Miettinen
4fa5422026 Doc: List Tutorials as a separate category on the front page
Add the following topics to the creator-tutorials group:

- Building and Running an Example
- Debugging a C++ Example Application

Task-number: QTCREATORBUG-29361
Change-Id: Ib6de92e99caf552ee8337b49af48bd04d6760474
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-14 15:17:06 +00:00
Leena Miettinen
9fa1dbcd3c Doc: Turn "Semantic Highlighting" into how-to topics
And move the general information to the Overview (or the Code
view docs in the QDS Manual).

Task-number: QTCREATORBUG-29361
Change-Id: Ib1d13f3d81d707691c84aa4241ed28662e2bc8ee
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-14 15:16:37 +00:00
Leena Miettinen
ebb3ad8d47 Doc: Turn "Using Qt Quick Toolbars" into a how-to topic
Task-number: QTCREATORBUG-29361
Change-Id: I5ed2aa9322f2d83dc8c58a6254a7cde5186252be
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-14 15:16:09 +00:00
Leena Miettinen
63cbd5761e Doc: Update info about code pasting
- Pastecode.xyz has been replaced with DPaste.com
- The process has changed

Task-number: QTCREATORBUG-30209
Change-Id: I1c52923ada597bd741787a8c7ad66425ed5168f9
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
2024-03-14 12:41:15 +00:00
Leena Miettinen
d5c357e67b Doc: Add path to "Initial Configuration"
It is not in the dialog described in the topic.

Change-Id: Ia0d1a399a2926e78cb8a0cc772abb7e2adc14840
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
2024-03-14 08:57:04 +00:00
Leena Miettinen
f6c3318e94 Doc: Turn "Running on Multiple Platforms" into how-to topics
And hide it from the top level TOC in the manual.
Link to "How To: Build with CMake" from CMake topics.

Task-number: QTCREATORBUG-29361
Change-Id: If0522cdd9636ac075e8bdeafa0fc7248199aaf2a
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-03-14 08:56:36 +00:00
Leena Miettinen
d0e240fd52 Doc: Turn "Pasting and Fetching Code Snippets" into a how-to
Task-number: QTCREATORBUG-29361
Change-Id: I0b2fe3cd2b3d3e3ec2c589ebcbd196832765c4ac
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
2024-03-14 08:56:18 +00:00
Leena Miettinen
75b9b31c62 Doc: Turn "Using GitHub Copilot" into a how-to topic
Task-number: QTCREATORBUG-29361
Change-Id: Ie682ebd399b0f478d106dba9876f4fea9834d340
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2024-03-14 08:07:01 +00:00
Leena Miettinen
6760e2d64b Doc: Fix typo "a installable" > "an installable"
Change-Id: Iea7ac4825de671ac892a8cbb228fb462a1f5be15
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-03-13 08:57:14 +00:00
Leena Miettinen
1cf925bc17 Doc: Describe the application manager plugin
Task-number: QTCREATORBUG-30209
Change-Id: Icd40d6da99e7fa53f667745a4de32b03b1157c99
Reviewed-by: Dominik Holland <dominik.holland@qt.io>
2024-03-12 15:43:42 +00:00
Leena Miettinen
6a74c829df Doc: Extend "Using CMake with Conan" to vcpkg
The automatic setup also works with vcpkg.

Change-Id: I755e59ef0a88105da195e9abe30adca5e3011fae
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-03-12 15:43:23 +00:00
Leena Miettinen
5e2140a01f Doc: Create links between Callgrind and Performance Analyzer
Change-Id: Ia7073a8cef72f141253810558b30ba9c28083b7e
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2024-03-12 13:59:51 +00:00
Leena Miettinen
e6eed39985 Doc: Turn "Using Text Editing Macros" into a how-to topic
Task-number: QTCREATORBUG-29361
Change-Id: I0d62d48036e08528c025eac8653e58ff0039e5a2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-12 12:20:38 +00:00
Leena Miettinen
8c0bb53c76 Doc: Turn "Comparing Files" into a how-to topic
Hide it from the QDS Manual.

Task-number: QTCREATORBUG-29361
Change-Id: I7c44aaed42e374b8e07d093279c8078ada18c250
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-12 12:20:25 +00:00
Leena Miettinen
17f40221e0 Doc: Update the online doc sidebar according to structure changes
Some of the linked topics were removed and others are now how-to
topics. Added How To and Reference categories and fixed topic titles.

Task-number: QTCREATORBUG-29361
Change-Id: I96efb10baacc173c30c6d568589bc91b3ff381ee
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-11 10:53:45 +00:00
Leena Miettinen
681d2da3b3 Doc: Update info about environment settings
They are now edited in an editor next to the variable list.

Task-number: QTCREATORBUG-30209
Change-Id: I8eb46272a2b4b3b92ebf93247f4ef33ee4114b6f
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-03-05 15:32:07 +00:00
Leena Miettinen
5a1e5ce058 Doc: Split up "Searching with the Locator"
Hide the locator docs from the QDS Manual because the
locator is not visible in the Code view.

Task-number: QTCREATORBUG-29361
Change-Id: Iecbbaece78b0cd6a496289fd9a00acfdd054d41f
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-05 13:37:04 +00:00
Leena Miettinen
add834577b Doc: Update info about autotests
- Split the topic up into how-to and reference topics
- Add and remove descriptions of preferences
- Move general information to the overview
- Describe qdt locator filter

Task-number: QTCREATORBUG-30209
Task-number: QTCREATORBUG-29361
Change-Id: Idb29eebaeb2f77326ebbb5e6b5654c135473f329
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-03-04 09:38:35 +00:00
Leena Miettinen
642c4beac1 Doc: Split up Refactoring into how-to topics
- Move info about viewing search results to the Search Results View
  reference topic
- Remove the Refactoring top-level topic (the general info is now in
  the Overview topic)

Task-number: QTCREATORBUG-29361
Change-Id: I4072e628368905ed1d5006ececae1b9eaa02fa10
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-03-04 07:37:47 +00:00
Leena Miettinen
51ca09c2d7 Doc: Describe the "Edit Checks as String" option for Clazy
Task-number: QTCREATORBUG-30209
Change-Id: I56d2f9d9a18f474ab0228c9c64bbde2101d49429
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2024-03-01 15:17:01 +00:00
Leena Miettinen
217b6eae03 Doc: Describe using junction points on Windows
Task-number: QTCREATORBUG-30209
Change-Id: If6692b697e92a6d3fdffaaddc268cab82f50afd4
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-03-01 15:11:02 +00:00
Leena Miettinen
5e5c86fecb Doc: Update Axivion docs
You can now view and filter issues from selected results.

Task-number: QTCREATORBUG-30209
Change-Id: I175f71589755af3bd75813eea237487128f36c42
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2024-03-01 14:30:39 +00:00
Leena Miettinen
87f2e9e190 Doc: Describe launching the debugger from the locator
The "dr" locator filter was added.

Task-number: QTCREATORBUG-30209
Change-Id: I25efd162c7adbff90e0c31c0965c30053ea4a64b
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-02-29 14:44:06 +00:00
Fabian Kosmale
786797e8e6 Mention QT_QML_GENERATE_QMLLS_INI in Creator docs
Task-number: QTBUG-121703
Change-Id: Iea04979ceb36ead1836f8207794861723ed18fc9
Reviewed-by: Sami Shalayel <sami.shalayel@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-02-28 18:42:09 +00:00
Leena Miettinen
57874c9c0d Doc: Update Git docs
- Git Branches view now shows the differences between
  local branch and origin
- The + button in Git Branches adds a branch

Task-number: QTCREATORBUG-30209
Change-Id: I75909c7c196b0fd81ca38749e456bc80187b822d
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2024-02-28 15:59:13 +00:00
hjk
581e6ddf4f Debugger: Require Python 3.5 in the docs
... and make the adapter/mode description a bit simpler.

Change-Id: Ie1b7c6cc26780f38be60c8e51e3bc0bc82db0bc6
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-02-28 09:19:48 +00:00
Leena Miettinen
d0a1059205 Doc: Describe selecting all text in the terminal
Task-number: QTCREATORBUG-30209
Change-Id: I65bd04dac6b81448c326e27e68352faddc8b3065
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2024-02-28 08:08:19 +00:00
Leena Miettinen
11c1e071d7 Doc: Update the docs about Python development
Task-number: QTCREATORBUG-30209
Change-Id: I3023fb6b9005092ecd76f62774942f366e1bd7d9
Reviewed-by: David Schulz <david.schulz@qt.io>
2024-02-23 13:05:22 +00:00
Leena Miettinen
9f7d8b06b2 Doc: Mention using CMake presets in "Share project settings"
You cannot use a .shared file to share CMake project settings.

Change-Id: I605ead2f42ed012da789c1eef3a4e6a51de62243
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-02-23 11:53:40 +00:00