Commit Graph

74 Commits

Author SHA1 Message Date
Jarek Kobus
96085f327b Coding rules: Add a note about avoiding sender() and QSignalMapper
Change-Id: Ifbc73b3c1e18484c692ee0e2a2999f2fe2e98f8b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2024-01-10 11:25:49 +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
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
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
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
1a3a8ecc96 Merge remote-tracking branch 'origin/qds/dev'
Change-Id: Id242ab4ca485527defdcc1555d204e12e50ddb7a
2023-09-14 17:37:24 +02:00
Leena Miettinen
6cf4b1a3cd Doc: Use hyphenated form of "command-line" where appropriate
That is where it precedes another noun, such as "options",
"arguments", or "tools".

Change-Id: Ic4c339084e7350fe737e499293a8f96c91c57fd7
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 10:12:26 +00:00
Leena Miettinen
097cb17af4 Doc: Replace "Getting Help" with "How To"
Move the topics to either "How To: Read Qt documentation" or
"Reference", depending on their type.

Task-number: QTCREATORBUG-29361
Change-Id: Ifa46192f7a15a71e8d3454010f6b96764776f82b
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
2023-09-13 06:56:53 +00:00
Leena Miettinen
66fabd0c0d Doc: Turn some "Advanced Use" topics into how-to topics
Task-number: QTCREATORBUG-29361
Change-Id: Ie675e4d72ad524e0a7a4ba4adca8a477ff579d55
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-09-13 06:56:40 +00:00
Mats Honkamaa
781e9dd5e3 Doc: Unify product naming
Unify naming for Qt Online Installer and Qt Maintenance Tool. Ass macros for theses
as well.

Task-number: QTBUG-116573
Change-Id: I90247956300607b852a17df96aa667bf55805e36
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
2023-09-12 16:22:28 +00:00
Eike Ziller
a419670ff5 Build: Change plugin json.in files to CMake style
They were still using variables in qmake style.
Directly use CMake variables in the json.in files and remove the no
longer needed escaping of quotes.

Adds a fatal message if it detects the old style in a .json.in file for
easier porting.

Change-Id: I8de88d8db2da55781f0e9d72eda03f943723188e
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
2023-07-25 13:21:16 +00:00
Leena Miettinen
a76f8cf4dc Doc: Change Extending Qt Creator Manual \page to index.html
It was extending-index.html to solve some issues that were
caused when generating the manuals from the same sources, but
those seem to have been solved. The name index.html was already
used at doc.qt.io for version 10.0.

Change-Id: I16c11d286107141f49cf28824cef998bd233d975
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2023-07-20 08:43:04 +00:00
Eike Ziller
3f912c01fb Doc/Extending: Update "getting and building" page
qmake files were still referenced.
Do not focus on building Qt Creator, we ship a development package
nowadays which is preferred.

Change-Id: If209f48c0fcf4f8fbe87ecaddae826ad3a63c209
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-07-05 06:10:57 +00:00
hjk
857f22e6c9 Coding-style: Mention extensions by plugins implementing callbacks
Change-Id: I03a8c1808e46a44c0c59aad1c5537a906442e5a7
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-07-03 11:44:34 +00:00
Leena Miettinen
e5e2d47d69 Doc: Add guidelines for writing tooltips
Task-number: QTCREATORBUG-29085
Change-Id: I4f4c8083348080c2e5880ee1ccbcbee14bd20906
Reviewed-by: hjk <hjk@qt.io>
2023-06-28 15:08:34 +00:00
Jarek Kobus
c28f40fff1 Spinner: Add some docs
Change-Id: Ia8717ac93c92e03d27fc4b8c93a32b7785ccc3e9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-06-22 08:22:09 +00:00
Jarek Kobus
6f6f6d3f97 Solutions: Add a common Solutions page
Add also The Tasking solution page. Add some hints into README.md file.

Change-Id: I4e355c95977d668fbc2f7bd286f9446e4e4b1f69
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
2023-06-15 14:58:42 +00:00
Leena Miettinen
c04a4a1ae0 Doc: Fix qdoc warnings
- Mark undocumented but existing functions with \c (instead of \l or \sa)
- Remove reference to functions I could no longer find
- Fix other broken links
- Fix reference to an image whose file format changed to WEBP
- Use {} instead of "" to mark alt text for images
- Add missing \a commands
- Add class name to a function name so that it can be found

Change-Id: I10655bb0356c7417ab0e14a3ce620930f4ee8349
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-05-30 08:13:53 +00:00
Leena Miettinen
e1a67c7cfb Doc: Exclude src/libs/utils/mimetypes2 from doc builds
It is copied from Qt.

Change-Id: Ia9a9f02abcb45d1f2981918259b8cc970c3165ca
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2023-05-24 06:53:08 +00:00
Jarek Kobus
d8ed764611 TaskTree: Bring the documentation back
It vanished after recent move into Tasking lib.

Amends f84199f8b7

Change-Id: I561784c82285de41c2e29c257940678eeeccb5eb
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-05-22 09:51:51 +00:00
Leena Miettinen
77fa93ef0a Doc: Fix reference to an image that is now in WEBP format
Task-number: QTCREATORBUG-28778
Change-Id: I1d0b45781a1692384ec218d74f4f270b083916ed
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2023-03-24 08:11:57 +00:00
Eike Ziller
cace5a57f2 Plugins: Add documentation about testing
Add information about how to write plugin tests and how to integrate
unit tests.

Change-Id: I13721f03c4c55a265a93f71a7c4d892f3e53a6bb
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-02-28 15:42:48 +00:00
Eike Ziller
143835aea8 Coding style: Avoid optional::value()
Change-Id: Ic4769c6f9f016415e01ca5526f6730bc93c6ea81
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2023-02-23 13:33:53 +00:00
Jarek Kobus
ef731faa47 Coding style: Avoid empty round brackets in lambdas
Remove outdated rules.
Use QList instead of QVector.

Change-Id: I11ea6be09080ddccfdcfc3d09f79cbeff448659e
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2023-02-23 12:05:22 +00:00
Eike Ziller
22a6b79f45 Coding style: Remove outdated section wrt nullptr
Ealier we state that nullptr should be used, and that is the current
policy.

Change-Id: Id462458f36893354a4f95e086d25a946f94b495e
Reviewed-by: hjk <hjk@qt.io>
2023-02-16 11:08:28 +00:00
Eike Ziller
7a2023f157 Coding style: Remove wrong compiler statement and merge C++ sections
The supported compiler are stated in the README, no sense in replicating
and maintaining that information here.

Back then it made sense to differentiate between "C++" and "advanced C+
+(11/14), but nowadays that separation is artificial, it all is "C++
features".

Change-Id: If67274566776ccd37bd20e925531405628edeb47
Reviewed-by: hjk <hjk@qt.io>
2023-02-16 11:08:11 +00:00
Jarek Kobus
78ae704d77 Utils: Enable internal documentation
Change-Id: I8531f7a85c8bee32a207f477e7ee9d3d9f14107c
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-02-09 07:37:45 +00:00
Kai Köhne
4e9c1d126c Replace GPL-3.0 with GPL-3.0-only
GPL-3.0 is deprecated by SPDX.

Change done by

 find . -type f -exec perl -pi -e 's/LicenseRef-Qt-Commercial OR GPL-3.0(?!-)/LicenseRef-Qt-Commercial OR GPL-3.0-only/g' {} \;

Change-Id: If316a498e3f27d2030b86d4e7743b3237ce09939
Reviewed-by: Lucie Gerard <lucie.gerard@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-01-10 08:05:04 +00:00
Eike Ziller
34aa8e9e19 PluginSpec: Add a "LongDescription" to plugin meta data
The EmacsKeys plugin had a long description with details on what it
does, which in principle is a good thing, but shouldn't be shown with
e.g. the -version command line argument.

Split the description in a short "Description" (name unchanged for
compatibility), and a possibly longer "LongDescription", using only the
first one for -version, and showing both in the plugin details.

Adapt the EmacsKeys plugin meta data.

Fixes: QTCREATORBUG-17312
Change-Id: I4a4abf51e5e19b71ee73edb14c6a897fbceaf916
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: David Schulz <david.schulz@qt.io>
2022-12-16 08:29:57 +00:00
Eike Ziller
ea5a050c5c Merge remote-tracking branch 'origin/8.0' into 9.0
Conflicts:
	src/plugins/mcusupport/mcusupportsdk.cpp
	src/plugins/qmldesigner/components/edit3d/edit3dwidget.cpp
	src/plugins/qmldesigner/components/materialbrowser/bundleimporter.cpp
	src/plugins/qmldesigner/components/materialbrowser/materialbrowserview.cpp

Change-Id: I9317da0fc1243b9ce6d87f577aa843c51f132ad7
2022-10-18 10:48:46 +02:00
Leena Miettinen
b4d0db920a Doc: Update instructions for writing documentation
For new and updated images, use the display resolution 1920x1080.

Change-Id: Ie7a83d23eacfa8ba9b78a4de4ee9046e838fa72c
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2022-10-13 11:55:40 +00:00
Lucie Gérard
a7956df3ca Use SPDX license identifiers
Replace the current license disclaimer in files by
a SPDX-License-Identifier.

Task-number: QTBUG-67283
Change-Id: I708fd1f9f2b73d60f57cc3568646929117825813
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-08-26 12:27:18 +00:00
Eike Ziller
90a03391d7 Merge remote-tracking branch 'origin/8.0'
Change-Id: I37a1f78caf9ae258c6b052efa3be15b3dbcbe164
2022-07-12 13:56:23 +02:00
Leena Miettinen
226abd4de7 Doc: Do not use comma before "because"
Change-Id: I375342fa10b95e26a3de2524610905c4d5503d3e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-12 10:39:52 +00:00
hjk
87dfe4725a Adjust coding style to C++17 nested namespaces
Change-Id: I34376108d77e0faeb6498cefedb563276f42fefa
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-07 15:02:33 +00:00
Leena Miettinen
b5066d71b8 Doc: Replace "Tools > Options" with "Edit > Preferences"
The menu was moved and renamed. The Options dialog was
also renamed "Preferences".

Change-Id: I05d187915382b3ce49699d91304cd447c87e2bd6
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-06-28 08:32:44 +00:00
Leena Miettinen
09804a65e4 Doc: Do not use the term "Output pane" in docs
When necessary, replace it with "view". When possible,
rephrase to omit the term. Link to descriptions of the
output views.

Update screenshots.

Change-Id: I80ccd12f5a10f221bbea6de994a15ddd07d20842
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-03-09 15:30:36 +00:00
Leena Miettinen
639a3c3b21 Doc: Describe src/tools/icons/recolordocsicons.py
Task-number: QTCREATORBUG-26644
Change-Id: Ibba0949211e0ae716ddd6974c87eaefe503b45d2
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2022-01-25 12:56:16 +00:00
Eike Ziller
9d8a419d10 Remove qmake build files
Removes qmake as a build system for building Qt Creator itself.
Keep them for some tests that are not completely moved to CMake yet.

Change-Id: I846c6ef65626b6dfae6375fdc85d00677aa8c2fb
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2022-01-20 12:18:15 +00:00
Eike Ziller
33f2074272 Bump requirement to Qt 5.15.2
Qt 5.15.2 includes API that makes transitioning to Qt 6 easier.
We currently have workarounds for Qt 5.14 in place that we can
remove when requiring 5.15.2, and we also can stop adding workarounds
for new code.

Change-Id: I920fdccc41d755a6ad39cb5161cd916999fee755
Reviewed-by: Cristian Adam <cristian.adam@qt.io>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
Reviewed-by: Robert Löhning <robert.loehning@qt.io>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
2022-01-17 10:20:32 +00:00
Eike Ziller
d097314873 Split "New File or Project" into "File" and "Project" parts
This was non-standard to begin with, and splitting it makes it
possible to have different designs for New Project and New File dialogs
that are more tailored for the different needs (as is done in
Design Studio)

Change-Id: Ie6246e3c3f3527702c4562ec6f8fcbf5fae6c6ad
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2021-12-02 11:02:35 +00:00
Eike Ziller
e017eaa3fd Doc: Update information about Qt Creator plugin wizard
After the switch to CMake.
Extends 29f3be1a6e

Change-Id: I626bc7393d290710d7e5d1f2907e6fa1f25a7d21
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2021-08-24 09:34:27 +00:00
Leena Miettinen
5c8564015e Doc: Fix term used for angle brackets in coding style topic
Change-Id: I73f21a9fd8fbf2e4388b501edbc27371d907b166
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-08-24 07:04:59 +00:00
Leena Miettinen
29f3be1a6e Doc: Update info about Qt Creator plugin wizard template
Update screenshots

Fixes: QTCREATORBUG-26153
Change-Id: I3dddbc1b8b8f6989a9afd445f1df3e868fd72e0f
Reviewed-by: Artem Sokolovskii <artem.sokolovskii@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-08-23 12:14:42 +00:00
hjk
d3e2ae35cb Doc: Add some rules about use of Utils::FilePath and Utils::QtcProcess
Change-Id: I6c21fe0bc795a24ce6b61d739f221f28cefc6df2
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-05-21 06:07:35 +00:00
Kai Koehne
33487984b9 Doc: Use version independent Qt link
or use direct links where possible.

Change-Id: I00d559ad53a95caf91c39985bd9fb5ea99f9aed7
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-12-10 10:48:25 +00:00
Leena Miettinen
a45689f85c Doc: Update instructions for using the \youtube macro
We needed a workaround to make this work in Qt Creator
and Qt Design Studio help mode.

Change-Id: I9b66fe91a5faa07366375a886a9f99352629945d
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-12-09 14:19:23 +00:00
hjk
7e8c212c1a Coding style: Remove outdated recommendation of foreach()
Change-Id: I01eadfdbefededf3b71df492a0e29abdd3a3a93f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-12-07 08:31:33 +00:00
Leena Miettinen
0c29e50353 Doc: Describe building docs with CMake and using the online style
You can now use CMake to build docs.

You also have an option to use the online style, which
enables you to check how the docs will look after release.

Change-Id: I63f573a58a2daf3aa05a2f0dd57f33f859e25bc2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-12-03 11:53:24 +00:00