Commit Graph

4817 Commits

Author SHA1 Message Date
Leena Miettinen
b0b58d6711 Doc: Split up "Using Clang Tools"
Task-number: QTCREATORBUG-29361
Change-Id: If33dbd417575b584836927ff866e2cd1ec20ba70
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2024-01-08 15:32:40 +00:00
Eike Ziller
cf63b1884e Merge remote-tracking branch 'origin/12.0'
Conflicts:
	src/libs/utils/treemodel.cpp
	src/libs/utils/treemodel.h

Change-Id: I9c5e8ef77905745c201cfc647218c9e747d268d6
2024-01-08 14:56:54 +01:00
Leena Miettinen
4d91473c69 Doc: Create a group for supported platforms in Reference
Task-number: QTCREATORBUG-29361
Change-Id: I11f84b97e482c75c157ccec827f5214a9e8d7a7d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2024-01-08 13:27:48 +00:00
Leena Miettinen
ab79d1f970 Doc: Split up "Parsing C++ Files with the Clang Code Model"
Turn "Use compilation databases" into a separate topic.

Task-number: QTCREATORBUG-29361
Change-Id: I022dcd1e0f59293be42b0f953084c63349d5600c
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-01-08 12:09:04 +00:00
Eike Ziller
9954a285f2 Doc: Fix insource build
When implementing acknowledgments via the generated attributions file,
the complete `<qtc_build>/doc/` directory was added as a source
directory for qdoc. For insource builds the build directory is the same
as the source directory, so qdoc would suddenly include all
documentation from `<qtc_source>/doc/`, which mixes Design Studio and Qt
Creator documentation.

Move the generated attributions file into a subdirectory, and only add
that subdirectory. Also fix that attributions were not generated at all
anymore after trying to fix issues when qdoc is missing.

Amends 2ce9f9d97d and
13b48144a6

Change-Id: I689827dabca37c81d4351dec04f23f46503429f6
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
2024-01-08 11:18:53 +00:00
Leena Miettinen
e76ac2e98d Doc: Update instructions for writing Qt Creator and QDS docs
- Mention the new grouping of topics
- Mention that the TOC is now used to automatically generate
  navigation links in the Qt Creator Manual
- Link to QUIP 21 for instructions on using images
  (leave Qt Creator and QDS specific instructions and examples)
- Remove section about Qt Quick Designer docs, which are no longer
  built as part of the Qt Creator Manual
- Remove the example for configuring the docs for an external plugin
  because Fossil is now in qtcreator and Qt Application Manager will
  move there in v.13.0
- Fix broken links to Qt Creator Manual
- Add links to QDoc commands
- Add and remove screenshots
- Fix some language and style issues

Change-Id: I669a3bd5245140f6894bab3fec463766808f1b2a
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2024-01-08 08:37:08 +00:00
Leena Miettinen
7aa57249b8 Doc: Describe setting CLICOLOR_FORCE to 0
...to disable the ANSI Escape codes support in CMake.

Task-number: QTCREATORBUG-30147
Change-Id: Icbc5fa26652d85bbd89d827914b2c59051c69ab0
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2024-01-05 15:34:50 +00:00
Tim Jenssen
435761fd0a Merge remote-tracking branch 'origin/qds/dev'
Change-Id: Ieb14c6311dbfe828a94981854b9ec8c18182b6cd
2024-01-05 14:18:18 +00:00
Leena Miettinen
158058ca3b Doc: Reorganize the "Designing UIs" section
- Create how-to and reference topics.
- Move the short descriptions of topics to "IDE Overview".

Task-number: QTCREATORBUG-29361
Change-Id: I11a334de6151350ce993e4135828a3eecaabf308
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2024-01-05 13:35:43 +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
Leena Miettinen
3f24752247 Doc: Update info about importing generic projcts
Move the topic from Build Systems to How To: Manage Projects.

Task-number: QTCREATORBUG-29361
Change-Id: Ia91ef716a2907c9ae9296852ca137d3fa1f3e4c1
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-12-20 08:19:22 +00:00
Tim Jenssen
a546dc65be Merge remote-tracking branch 'origin/qds/dev'
Change-Id: I8aa6ace80911b440485f9006f066aa2113cca63d
2023-12-19 16:02:52 +00:00
Eike Ziller
b37cd984db Merge remote-tracking branch 'origin/12.0'
Conflicts:
	cmake/QtCreatorIDEBranding.cmake
	qbs/modules/qtc/qtc.qbs

Change-Id: I937d301156dac0d20b43e7a14b41a319eff57698
2023-12-19 10:55:55 +01:00
Eike Ziller
38176623eb Doc: Move acknowledgments for binary components to table
Remove reference to OpenSSL, we do not ship it anymore.
Move Qbs to the other acknowledgments of components included in the
binary packages.

Change-Id: I964badc80568c0b5fd09be65231d9b77d34fa4b9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
2023-12-18 16:28:19 +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
Eike Ziller
d63ac7a004 Doc: Add syntax highlighting files to qt_attributions.json
Group by naming.

Change-Id: I467a6b0ca3f1c2b5168207e925fde45855cf96ce
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
2023-12-18 11:10:24 +00:00
Eike Ziller
859dd3a414 Doc: Fix supported macOS platform
Qt 6.6 only supports macOS 11.0 or later

Fixes: QTCREATORBUG-30084
Change-Id: Ic7e83633b8b3e47602d75c65657db88e9381c874
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-12-18 08:57:40 +00:00
Eike Ziller
75819c4903 Doc: Move attributions to kate highlighting files to table with links
Change-Id: I676129d9880869de75e3f73a8675271e690a0d50
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
2023-12-18 08:57:12 +00:00
The Qt Project
96f5e56125 Merge "Merge remote-tracking branch 'origin/qds/dev'" 2023-12-15 09:53:53 +00:00
Eike Ziller
2ce9f9d97d Move most acknowledgments to qt_attributions.json
Create a qt_attributions.json and generate a documentation file from it
automatically when building documentation. The result is included as a
table in the acknowledgments page in the documentation.

Some attributions cannot (yet) move to qt_attributions.json, because
that requires the sources to be available in the project's source tree,
which is not the case for LLVM, Clazy, etc.

Remove the attributions from the README and instead point to the
documentation from there, so we get rid of that duplication.

Change-Id: I22623fe7495593ffce2e2c6c26255c27c5a8cb71
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-12-15 09:02:23 +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
Tim Jenssen
06bfa66ed7 Merge remote-tracking branch 'origin/qds/dev'
Change-Id: I6c657f5b8c0602ca76e9b17b10f1ff7a38b1b8be
2023-12-14 19:50:03 +01:00
Leena Miettinen
ef91b41663 Doc: Remove "Setting Up" from build system reference topic titles
- And split some of them into several topics.
- Combine almost identical topics.
- Put settings values into tables to make them easier to browse.

Task-number: QTCREATORBUG-29361
Change-Id: I2ee5a65848ab3a4643cf5fafe5a654730166aab1
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-12-14 15:38:58 +00:00
Sami Shalayel
556d4d2831 doc: clarify what the qmlls checkboxes really do
Add some documentation about what these qmlls checkboxes really do.

Change-Id: I019d68b6d53efbbd599ba2c8c4edc68e3f9be1da
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-12-14 15:17:46 +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
Leena Miettinen
1cea4ea42e Doc: Hide links to topics not included into QDS Manual
Move a file to a creator-only folder and add conditions.

Change-Id: I8ebe71116f926dea10fa656ef17717b946ae80e2
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-12-13 08:13:59 +00:00
Leena Miettinen
2e7634230e Doc: Turn "Sharing Project Settings" into a how-to topic
Change-Id: I9a2d4058acb93273fdb449e0e5e67abec0ae7a24
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-12-13 08:13:37 +00:00
Eike Ziller
a047ebba50 PluginManager: Add documentation for "SoftLoadable"
Change-Id: I542ffe892490ef796ad76a0afeac103a0c1e12f0
Reviewed-by: hjk <hjk@qt.io>
2023-12-12 14:03:55 +00:00
Eike Ziller
39927ff44d PluginManager: Add an "Deprecated" flag for plugins
For plugins that are still provided, but are no longer supported.
They are disabled by default and show a "unsupported" hint in the
plugin manager (similar to "experimental" plugins).

Change-Id: I6ad72fc0043900b5aa919c225ae94850d1d7a443
Reviewed-by: hjk <hjk@qt.io>
2023-12-12 14:03:47 +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
Leena Miettinen
52eff2c6a4 Doc: Turn "Using Custom Output Parsers" into two how-to topics
Task-number: QTCREATORBUG-29361
Change-Id: I426f0fe545a485a1932d1e59fed99c07c71f4aff
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2023-12-07 14:16:22 +00:00
Leena Miettinen
f708e200f9 Doc: Restructure info about build and run configurations
Task-number: QTCREATORBUG-29361
Change-Id: I9e9d3a3448c327938e4f647b37a88857db5b16c4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2023-12-05 12:30:54 +00:00
Leena Miettinen
5034936333 Doc: Fine-tune the How To: Install Qt Creator topic
- Add a link from the "Getting Started" page to make this topic
  easier to find
- Add disclaimers as notes
- Remove link to GitHub (not official)
- Add link to Qt Account where users can also get the packages

Task-number: QTCREATORBUG-29594
Change-Id: I7e667a142e3094c9a0002f0299e104a9b1e8a7ed
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-12-04 14:01:06 +00:00
Cristian Adam
13dc66a08d Fonts: Add Medium SourceCodePro font variants
Add the Medium font families.

The Medium variants make sure that on a MacBook Pro with Retina display
the font doesn't look out of place being too thin.

Taken from https://github.com/adobe-fonts/source-code-pro/releases/tag/
2.030R-ro%2F1.050R-it

We need to stay with version 2.0.30 due to hinting on Windows, and to
force QFont::Medium on macOS due to the fact that the medium font is not
picked up. Newer versions like 2.0.42 do not have this issue.

Task-number: QTCREATORBUG-29964
Change-Id: I4c0fba5730c4a6b869d900642b675698c29c6ae8
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-12-04 13:37:02 +00:00
Leena Miettinen
7fd20e98d7 Doc: Edit info about state chart editor
- Convert paragraphs and lists into tables with icons to allow
  users to browse easier
- Move the info about using the wizard into a how-to topic
- Add subtitles
- Move the topic to Reference

Task-number: QTCREATORBUG-29361
Fixes: QTCREATORBUG-29766
Change-Id: Id9c1aabd8f3a7bfb0659898dd329cedbcbb5f697
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-11-29 15:23:51 +00:00
Leena Miettinen
09144e7a7f Doc: Describe how to get Qt Creator
Fixes: QTCREATORBUG-29594
Change-Id: Ic05329223cd32307b8474fc71c622c9f96d9d25b
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-11-29 14:30:50 +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
Leena Miettinen
3f9f249c0d Doc: Add a readme.md for using recolordocsicons.py
In preparation of moving the instructions for taking screenshots
from the Extending Qt Creator Manual to a QUIP.

Change-Id: I034185e7ab4878cf36766db1e9a6b8de5d2b3fed
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-11-20 08:58:50 +00:00
Tim Jenssen
9f1d23df00 Merge remote-tracking branch 'origin/qds/dev'
Change-Id: Ic852bc9977d0292fb6cd93a319f4bfdebb22a1b0
2023-11-16 17:17:46 +01: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
Eike Ziller
056168beca Merge remote-tracking branch 'gerrit/12.0'
Conflicts:
	src/plugins/texteditor/texteditor.cpp

Change-Id: I76620975760a8f9e64f6d381c948d457e949a87c
2023-11-15 10:32:59 +01: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
Eike Ziller
104959f7f7 Merge remote-tracking branch 'gerrit/12.0'
Conflicts:
	cmake/QtCreatorIDEBranding.cmake
	qbs/modules/qtc/qtc.qbs

Change-Id: Ide00b6dd5b44d637b18892c663035e736de03485
2023-11-13 10:22:12 +01: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
Eike Ziller
e6a39128f5 Merge remote-tracking branch 'origin/12.0'
Change-Id: Ib9f8b81d60162a8b01e7c627ba54901af68afa98
2023-11-10 11:23:21 +01:00