Commit Graph

873 Commits

Author SHA1 Message Date
Leena Miettinen
779a3b126f Doc: Update the Examining Data topic
- Add some basic info
- Move info about Qt objects from Expressions view,
  How-tos, and Debugging Helpers topics
- Add links

Task-number: QTCREATORBUG-28778
Change-Id: I9ef5fbaef610e7a183a8d903d73e0e052c3e7177
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-31 06:58:33 +00:00
Leena Miettinen
df53b7c9b7 Doc: Add docs for Peripheral Registers view in Debug mode
Task-number: QTCREATORBUG-28778
Change-Id: I17b66417c943c08295a8e7fb9936e5f8d28b9263
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-28 14:19:39 +00:00
Leena Miettinen
faf8f91b65 Doc: Update the docs for the Expressions view in Debug mode
Task-number: QTCREATORBUG-28778
Change-Id: I687fb1bb2ecf6dbc511bffc70a6f9ac00aee6ee9
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-28 10:48:18 +00:00
Leena Miettinen
094b5294f6 Doc: Edit docs for Debug mode Disassembler and Debugger Log views
Task-number: QTCREATORBUG-28778
Change-Id: I66ea94881dc1ce3fa8d8fbe3bdd4b59504330738
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-27 07:29:40 +00:00
Leena Miettinen
1b2f1ac0f9 Doc: Edit Registers view docs
Task-number: QTCREATORBUG-28778
Change-Id: I30f24e7c192332611f9e7d14ec5541b6adccb9a5
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-27 07:29:33 +00:00
Leena Miettinen
31ea42eb54 Doc: Describe Threads, Modules, and Source Files debugger views
Add screenshots and more information about the views.

Task-number: QTCREATORBUG-28778
Change-Id: I385c1f6dd5eeed20d122bed2d9420b32b9a3d70b
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-03-24 07:24:26 +00:00
Leena Miettinen
7babb9677d Doc: Update debugger topics
- Add info about PDB
- Edit info about setting up debuggers and add (existing)
  screenshots
- Update info about Add Breakpoints view
- Move some text around

Task-number: QTCREATORBUG-28778
Change-Id: Ice3813ef2d4b143ed1f9d246aa6c029829dee60f
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-23 12:31:09 +00:00
Leena Miettinen
5633533e0d Doc: Update Android docs
Fixes: QTCREATORBUG-28858
Task-number: QTCREATORBUG-28721
Change-Id: Id18a2ad0f88600362a5d10e36b3e3d95e5d19644
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2023-03-21 10:35:39 +00:00
Leena Miettinen
cf1854a2d7 Doc: Update docs for Docker devices
Task-number: QTCREATORBUG-28721
Change-Id: Ie00e736a0a7d8d3d7c6238ce74e1d516bb5dca1a
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2023-03-21 09:41:16 +00:00
Leena Miettinen
1397cf0aac Doc: Update info about Testing preferences
Task-number: QTCREATORBUG-28721
Change-Id: I649902d2d2d336abd21d01a0b3b0febf13084b04
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-16 13:34:39 +00:00
Leena Miettinen
b48826f7bf Doc: Fix a broken link to Editing MIME Types
Change-Id: I545ec936b52db08c804f0fe025429dc39ddce978
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-03-15 14:09:56 +00:00
Leena Miettinen
b0605f1095 Doc: Fix UI string in Build Settings docs
Change-Id: I1627dc59266767ec02ac80999931a8497e3be309
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-03-15 09:49:31 +00:00
Leena Miettinen
81bc007ddd Doc: Describe version control system preferences
Task-number: QTCREATORBUG-28721
Change-Id: Ib4d1899885012af5eac176fd53e5536f69a2689b
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2023-03-14 07:29:06 +00:00
Leena Miettinen
e7f924ba6a Doc: Update Clang tools info
Clang-Tidy and Clazy can now be run separately and the results
are shown in separate views in the Debug mode.

Task-number: QTCREATORBUG-28721
Change-Id: I74dd866b68657460603cdf36d12ddf1758b761c2
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-03-10 09:26:47 +00:00
Leena Miettinen
837a779b86 Doc: Describe changes in CMake build settings
- Added `Show advanced options by default` to
  `Edit > Preferences > CMake > Tools`
- Moved `Autorun CMake` to `Edit > Preferences > CMake > General`
- Reorganize the building with CMake topic and add subtitles for
  readability

Task-number: QTCREATORBUG-28721
Change-Id: Id8bab60bc2e148c067ac1eb3669b544d12031078
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-03-10 09:26:27 +00:00
Leena Miettinen
5fc74d06e0 Doc: Describe Formatter tab in Preferences > CMake
Update screenshots and fix alt text to use {} instead of "".

Task-number: QTCREATORBUG-28721
Change-Id: I9535f099047b36dda2f7a37b181c688e40a534d1
Reviewed-by: Xavier BESSON <developer@xavi-b.fr>
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-03-10 09:26:10 +00:00
Leena Miettinen
13b5254df6 Doc: Remove 'Window UI - Dynamic load' from project templates
Task-number: QTCREATORBUG-28721
Change-Id: Id1369c189ef4e92ec646e16fa7b8fc4a3d65c877
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
2023-03-09 15:45:12 +00:00
Leena Miettinen
d299edfe05 Doc: Add MSVC example for CMake presets using 'external' strategy
... for the architecture and toolset fields.

Task-number: QTCREATORBUG-28721
Change-Id: Ieac6c4bc1553204a1e34ea0ea05028e6e4975adc
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-03-09 14:40:40 +00:00
Leena Miettinen
c7a67ab9e9 Doc: Add Profile to Qbs Build variant field options
Task-number: QTCREATORBUG-28721
Change-Id: Ib05ce93ac4813d35cbe5bdd0e1bccdf24bce172b
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-03-09 13:31:32 +00:00
Leena Miettinen
e16ddefbdd Doc: Fix link to a removed section
... called Adding Qt Quick Timeline Module to Qt Installations

Change-Id: Ia074ad82ea544bc65286b8f0a8d54997521aabe6
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-03-09 09:37:29 +00:00
Leena Miettinen
b8ddbde13b Doc: Add link to Qt Learning
Linking to the Getting Started with Qt Creator course directly
does not seem to work.

Change-Id: I4393749e9c66d66340d094c7cb7dc4f4847b8eba
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-03-06 14:49:16 +00:00
Leena Miettinen
dedc3e81fa Doc: Describe connection sharing for Boot2Qt devices
- Some language fixes.
- Use {} instead of "" for \image alt text

Change-Id: I1772c7e98bf40d8ff828205dcf1fd8749d4434cb
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-03-06 10:56:37 +00:00
Leena Miettinen
476c072b00 Doc: Add table of debugger toolbar icons and their purpose
Task-number: QTCREATORBUG-28778
Change-Id: Ic7c88862bc28e9680fb103a1d8663baedc28df79
Reviewed-by: hjk <hjk@qt.io>
2023-03-06 08:20:38 +00:00
Leena Miettinen
4c5b4e7ea0 Doc: Describe the "cmake --install" deployment step
Task-number: QTCREATORBUG-28721
Change-Id: Id2571cf357e821555ecfa73a78d9b76dd9ee540b
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-03-06 07:30:08 +00:00
Fabian Kosmale
b80546c1d9 Docs: Adjust to QtQuick application wizard changes
The filename starts now with an upper-case M.
Amends fa2ea6fd97

Change-Id: Ia5055b0be1edc77aa5cab84329424241c4334a27
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-03-03 12:51:29 +00:00
Leena Miettinen
90a8496cdc Doc: Update docs about creating Qt Quick Application projects
You now have the option to create projects that you can open in QDS.

Task-number: QTCREATORBUG-28721
Change-Id: Ia8f36fd65f2356b9987b027d7b37ac6848ff7e03
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2023-03-02 13:10:54 +00:00
Leena Miettinen
3425a2b3d1 Doc: Describe building on remote Linux and Docker devices
Task-number: QTCREATORBUG-28721
Change-Id: I6e6bcea61b04cebfb16a462ebd99a7a97926b7a5
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-03-01 08:16:35 +00:00
Leena Miettinen
81da84ad0b Doc: Describe Build > Run Generator action
That generates build files for other build systems, such as
Microsoft Visual Studio and Eclipse.

Task-number: QTCREATORBUG-28721
Change-Id: I980ee851293b41a9320b90458132ba035dc1f3f4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-02-28 12:18:53 +00:00
Leena Miettinen
2c9ca6008f Doc: Describe Python interpreter selector on editor toolbar
Task-number: QTCREATORBUG-28721
Change-Id: I354c19a72e428e5361eaacb45f79c057affb9cb1
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-02-24 07:26:51 +00:00
Leena Miettinen
3048a14ceb Doc: Update info about using QML language server
You can enable it in QML/JS Editing preferences.

Task-number: QTCREATORBUG-28721
Change-Id: I64b8692fb7a69bd897364b370835ef1e2b3f79ef
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-02-23 10:39:40 +00:00
Leena Miettinen
a8e424f75e Doc: Select the tool to automatically format QML files
For example, qmlformat.

Task-number: QTCREATORBUG-28721
Change-Id: I509cba3fd842f94e7656a3356cc1de81e41fd8e2
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-02-23 10:00:38 +00:00
Leena Miettinen
27760c38c6 Doc: Describe Call Hierarchy view and language server button
Task-number: QTCREATORBUG-28721
Change-Id: I9275c5f0a7ca838aab29c42962e88d4b80ed8622
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-02-22 09:57:16 +00:00
Leena Miettinen
0328c14167 Doc: Describe color tooltips for QML code in code editor
Task-number: QTCREATORBUG-28721
Change-Id: Ifdd82a9e72bc19f484f6b3737f1a562a95e9a7c3
Reviewed-by: André Hartmann <aha_1980@gmx.de>
2023-02-22 09:22:51 +00:00
Leena Miettinen
03779ef94b Doc: Describe how to temporarily cancel Clangd indexing
Task-number: QTCREATORBUG-28721
Change-Id: If942fb7ca6e0dfa5601b62b340ff3bcd3d9b6bcf
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-02-21 17:09:26 +00:00
Leena Miettinen
55760cb5f7 Doc: Fix reference to an \image after image name and format changed
Change-Id: I581a0c3ad6be9cc435fc27069d95c72816948755
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-02-21 10:31:10 +00:00
Cristian Adam
10bbc7ce33 CMakePM: Add QTC_RUN environment variable for the CMake run
This way one can do certain things knowing that CMake is being run in Qt
Creator.

Change-Id: If3ac8a52f30f9fa73a756212199a25632c757dcd
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2023-02-21 10:08:48 +00:00
Leena Miettinen
08e789851e Doc: Describe changing includes when renaming .ui files
Task-number: QTCREATORBUG-QTCREATORBUG-28721
Change-Id: I6508f57dd7f8634e0fb8412bc55845b24fb5af54
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-02-21 08:44:43 +00:00
Leena Miettinen
b1184509b5 Doc: Describe Preferences > C++ > Code Model > Ignore files
Task-number: QTCREATORBUG-28721
Change-Id: I18aa6a624038543fd7a2e9b78e4678dd617cffce
Reviewed-by: Philip Van Hoof <philip@codeminded.be>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-02-21 08:44:26 +00:00
Leena Miettinen
0cf83caa00 Doc: Add finding unused functions in Projects view context menu docs
Task-number: QTCREATORBUG-28721
Change-Id: I180028a09f51ec40d43ae99cfd474b05f5a2b69d
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-02-20 16:44:17 +00:00
Leena Miettinen
ce2d773510 Doc: Remove obsolete \include commands
The information was moved to the Expressions view docs.

Change-Id: I8e98e9de57412792746727f521253e85ecff9930
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2023-02-20 15:50:39 +00:00
Leena Miettinen
ff71290758 Doc: Describe Temporarily hide inline annotations in Edit mode
...for different types of annotations individually in the annotation
tooltip popup.

Update the screenshot.

Task-number: QTCREATORBUG-28721
Change-Id: Ic2f010e370109a5ea35aef5d9c8da5b74927f4ef
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-02-20 08:00:20 +00:00
David Schulz
487ea9cd99 Doc: add link to java language server packages
Change-Id: I9ccd1c6b09300685bbac4a85354f881293d394b9
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-02-17 13:12:00 +00:00
Leena Miettinen
d899cfed38 Doc: Describe that the locator f filter expands variables
Task-number: QTCREATORBUG-242
Change-Id: I6066fc122bfbae50a1daee801ac4d94298dae25f
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2023-02-17 10:59:52 +00:00
Leena Miettinen
959da084cc Doc: Describe what F2 does for URLs and .qrc files
Task-number: QTCREATORBUG-28721
Change-Id: I33f6388d704fa20420585f8fcc6f63b52e7181f9
Reviewed-by: David Schulz <david.schulz@qt.io>
2023-02-16 10:56:17 +00:00
Leena Miettinen
14297b97e4 Doc: Describe Clang Format as the default way to set code style
The plugin is now enabled by default. Clang Format can be disabled
either globally or at project level without disabling the plugin.

Task-number: QTCREATORBUG-28721
Change-Id: Ifbc0418400ed8a7942d0dbceaa95b078ac897c49
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-02-15 15:20:49 +00:00
Leena Miettinen
1e6933f48d Doc: Reorganize the Debugger topic
Divide the long topics into shorter ones and reorganize the
information.

The next step will be to improve the current topics: check that
the information is complete, add screenshots for all views, add
links between related topics, and so on.

Task-number: QTCREATORBUG-28778
Change-Id: I3549289a2be512bb09f45c91f85b12f89cedbe97
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2023-02-13 14:37:39 +00:00
Leena Miettinen
ac252c2d49 Doc: Make the locator more visible in the other parts of the docs
Change-Id: Icdefa64f5874f14c6a9c6a24e4d73837c12b457f
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-02-08 12:12:26 +00:00
Leena Miettinen
8512aba9eb Doc: Add a short overview of what debuggers do
Change-Id: I07062ea6e046ce51a9d3091e9d86071415706e6c
Reviewed-by: hjk <hjk@qt.io>
2023-02-07 09:54:10 +00:00
Leena Miettinen
447f8b80c3 Doc: Remove double words and fix a typo
For example, "and and", "the the", "or or"...

Change-Id: Ie5795efb857e674c5a584e97a60bcb9b2ba869d2
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2023-02-07 07:23:13 +00:00
Leena Miettinen
738819ec71 Doc: Replace "provide" with something simpler
This follows the ComplexWords rule in vale.

Change-Id: I99d8e5dc3ee4736a254064b6ef00166419fccee8
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2023-02-06 11:09:29 +00:00