Commit Graph

4471 Commits

Author SHA1 Message Date
Vikas Pachdha
8d5b3b4ad6 Docs: Update figma qt bridge plugin docs
Update screenshots
Remove stale docs
Document start screen and page organization

Task-number: QDS-11614
Change-Id: I16160ffae415a258e1250d6529f976e9dbe0e376
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2024-01-15 15:13:46 +00:00
Vikas Pachdha
65b0d04558 Docs: Document page organization for Sketch
Task-number: QDS-11614
Change-Id: I22e5e7668ae1617f459dce1549847ab163265b61
Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2024-01-15 15:13:38 +00:00
Pranta Dastider
1e56f5d919 QmlDesigner: Update image in the Effect Maker document
This patch updates the old image to include the new topbar
in the Qt Quick Effect Maker document.

Fixes: QDS-11568
Change-Id: I90086b8fdb0f86947efcce40d2ef2171fa9b1c63
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-12 12:01:43 +00:00
Pranta Dastider
fdcb29c711 QmlDesigner: Update image in the Managing Workspaces document
This patch updates the old image to include lock the views features
in the document screenshot. Also it updates the text description to match
the change.

Fixes: QDS-11562
Change-Id: I0e573be2f0e879bf4fb62a6f5120cd0b0aafa1d0
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-11 15:16:42 +00:00
Pranta Dastider
f631c25d8b QmlDesigner: Update image in the Previewing Android Applications document
This patch updates the old image to include lock the views features
in the document screenshot. The image was updated from Png to Webp.

Fixes: QDS-11566
Change-Id: I28fc637a3fe78a8e82b6fb3474b1edb49a31c1ee
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-11 15:16:06 +00:00
Leena Miettinen
acf5c2e602 Doc: Move sources for "Jump to the Code" to qtdesignstudio\src
To fix QDoc warnings.

Also, hide the topic from the Qt Creator Manual.

Change-Id: I499f338a6f4adc3fff7f6b38eb2363437f1a84d5
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Pranta Ghosh Dastider <pranta.dastider@qt.io>
2024-01-02 13:56:36 +00:00
Pranta Dastider
1c4a2ade1d QmlDesigner: Document Jump to the Code feature
This patch documents the jump to code features. It allows
users to instantly jump to code specific for a component,
state or connection.

Fixes: QDS-11132
Change-Id: I4483dda8dd6a899ddee017196e697008f4be0fcd
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2023-12-18 15:39:25 +00:00
Mats Honkamaa
0b32abdb31 Doc: Update Fire Particles tutorial
Fixes and updates:
- Added more screenshots
- Improved descriptions of properties
- Fixed errors
- Improved text in general

Task-number: QDS-11184
Change-Id: I8c6d26758e8e86512e736ecffd9e0a15c479e632
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2023-12-15 08:36:43 +00:00
Johanna Vanhatapio
4d042e5b7d Doc: Update info on baking lights
Fixes: QDS-11174
Change-Id: I8f92c3cca0faaa3f4b1db11caa8825677c80121e
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2023-12-14 12:28:40 +00:00
Mats Honkamaa
f03b1cd53b Doc: Clarify previewing on device instructions
Task-number: QDS-10228
Change-Id: Ic5fd9abd26e996e3201ca5fac062e6d593e8609f
Reviewed-by: Tanja Remes <tanja.remes@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2023-12-08 10:56:26 +00:00
Johanna Vanhatapio
54ea684438 Doc: Describe Viewport Shading
Fixes: QDS-11110
Change-Id: I098745446f421a37a8f263577aa4c098a5d13cea
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-11-28 13:23:47 +00:00
Mats Honkamaa
7ca7ec4664 Doc: Update 3D view icons
Task-number: QDS-11241
Change-Id: I644b77813751081112cf9a6023c2bae265aa6fab
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
2023-11-28 09:42:13 +00:00
Johanna Vanhatapio
3930deff29 Doc: Describe the split view in 3D
Fixes: QDS-1109
Change-Id: I849bd54109a9caaf9de989099495aa02dfd60a5f
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-11-23 09:48:56 +00:00
Esa Törmänen
a3283587dd Doc: Update Creating UIs for MCUs page
Removed the references to 3D design tools (Blender, Maya) and 3D UI
design assets as the 3D view is not supported for developing MCU
projects.

Task-number: QDS-11231
Change-Id: Idfd2f2d5c513836aba802a7cfed8f8b66b3369f5
Reviewed-by: Yasser Grimes <yasser.grimes@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-11-20 09:55:56 +00:00
Tim Jenssen
39d1dae0d3 Merge remote-tracking branch 'origin/12.0' into qds/dev
Change-Id: Ic6e557806a3209e2c6d983d3c3fcfad66f6e3066
2023-11-16 15:56:06 +01:00
Esa Törmänen
031e23edbe Doc: Update QDS version compatibility with Qt for MCUs SDKs
Modified the QDS version compatibility with Qt for MCUs SDKs page
so that it's up to date with the latest/upcoming releases
(Qt for MCUs 2.6 & QDS 4.4).

Task-number: QDS-11228
Change-Id: I21ca6e5e7362c8bab756d1adcd81954deea48784
Reviewed-by: Yasser Grimes <yasser.grimes@qt.io>
Reviewed-by: Maija Metso <maija.metso@qt.io>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2023-11-15 13:09:26 +00:00
Leena Miettinen
1541a486c1 Doc: Fix double "the"
Change-Id: Ibffeb5da3dd7dda3b8886bf909ecd97bf3b06d83
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2023-11-13 11:08:51 +00:00
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
Tim Jenßen
058fd820e5 Merge remote-tracking branch 'origin/12.0' into qds/dev
Change-Id: I1e38a9dc4402a4cf836c32a6b0e5f49a836574b7
2023-11-09 08:46:51 +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
Tim Jenssen
a28400ec7d Merge remote-tracking branch 'origin/12.0' into qds/dev
Change-Id: Ic0d4bc670cca264cc4013d98f692cdbde70cbaab
2023-11-06 19:55:06 +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
Pranta Dastider
e10e85cd17 QmlDesigner: Update Washing Machine UI Doc for MCU setup info
This patch updates the Washing Machine UI document.
Updates the old instructions for setting up a new MCU
project.

Fixes: QDS-11058
Change-Id: Ib1295966cff7e7a6ea2a5051cce93a1e6596a30b
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-11-06 14:48:51 +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
Pranta Dastider
b44008f15a QmlDesigner: Update the Animated State Transitions doc
This patch updates the Animated State Transitions document.
Removes an old image and adds a new image to support
the current connection view update. Also, changes some texts
to keep the process relevant.

Fixes: QDS-11055
Change-Id: I4ea3face56df6cec05adfd8244d32dc20d7e6e16
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-11-02 12:39:26 +00:00
Johanna Vanhatapio
b46d9de784 Doc: Remove outdated videos
Task-number: QDS-10565
Change-Id: I91d8bf4f6fb8f0b5b756fa4a3bf94753ab16adfb
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-11-02 10:17:30 +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
Tim Jenssen
b5c60597dc Merge remote-tracking branch 'origin/12.0' into qds/dev
Change-Id: Iefea658312bba6675eadce23fb8dc92f9207ea0e
2023-11-01 16:40:26 +01: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
Pranta Dastider
43782a1fce QmlDesigner: Update the Washing Machine UI Doc
This patch updates the Washing Machine UI Tutorial document.
Removes old images and adds a new image to support
the current connection view update. Also, changes some texts
to keep the process relevant.

Fixes: QDS-10938
Change-Id: I7ef161ddadb62eb943c508c7c4f17d2995af4337
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-10-27 09:28:29 +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
Pranta Dastider
ff603fd1e0 QmlDesigner: Update the LoginUI States Tutorial Doc
This patch updates the LoginUI States Tutorial document.
Removes an old image and adds a new image to support
the current connection view update. Also, changes some texts
to keep the process relevant.

Fixes: QDS-10936
Change-Id: I52f403a1f4a4a7c36b5346069f50c1a633c437cc
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-10-25 15:31:01 +00:00
Pranta Dastider
e27a8704df QmlDesigner: Update the Concepts and Terms doc
This patch updates the Concepts and Terms document.
Removes an old image and adds new images to support
the current connection view update.

Fixes: QDS-11000
Change-Id: I7d5d1bea4287e13c2344138af7cce5b8f9f4321d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-10-25 14:48:27 +00:00