Commit Graph

53 Commits

Author SHA1 Message Date
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
Leena Miettinen
bd17dd445b Doc: Add instructions for using the \youtube macro
The macro shows a thumbnail with a play button to start the
video.

Change-Id: If4dcddfbdbc40e795f4306e83ede43187dd2439c
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-11-30 10:12:00 +00:00
Leena Miettinen
2e1eed1945 Doc: Add list to words to ignore for automatic linking
Change-Id: Idfa50889deeff64a8d97bfbb5deaf4c86a32e2bf
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2020-09-09 12:45:19 +00:00
hjk
361b80cb9b ExtensionSystem: Remove PluginSpec::isHiddenByDefault
Not used anymore.

Change-Id: Ic73ba3024b9e6157ff044cb23450fc9dad3c4c02
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-06-16 09:08:36 +00:00
Eike Ziller
1d3d2b5311 Add some documentation about distributing plugins
Change-Id: I02eff822105a4c98575f745bb0f4d222afb0bb73
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2020-06-03 08:39:26 +00:00
Leena Miettinen
45b96d12e5 Doc: Describe writing docs for independent plugins
Plugins that reside in their own repositories need their
own documentation.

Change-Id: I97ff5b2b6788c6dd90364117e842dcdfd63085b5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-05-28 07:42:04 +00:00
Eike Ziller
6d97c1fcb1 Unregister deleted IContext objects automatically
Change-Id: I7b84c02c8fe1e7201431116e3d993792370fb942
Reviewed-by: hjk <hjk@qt.io>
2020-05-27 06:54:54 +00:00
Eike Ziller
e7b319fbc1 Doc: Fix naming of .index files
Qt Creator Manual and Extending Qt Creator had the same project name,
and therefore the same index file name.
Also qdoc's "depends" configuration requires the index file to have
the same name as the directory.
Adapt the project names accordingly.

Change-Id: Ie1ec8ede360e19e3ffd5c7dbea44344f0a631f68
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-05-25 08:50:54 +00:00
Eike Ziller
8383ca777f Add some documentation on action manager and commands
Change-Id: I03d8292120b30973155248471b12d1627536fb39
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-20 08:12:34 +00:00
Eike Ziller
708f84cce8 Doc: Fix style for menu hierarchies
Use \uicontrol for the individual components individually

Change-Id: Idf62db7c37e94a55a988792f13aaa8c49cb1ac07
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-03 06:10:16 +00:00
Eike Ziller
3a8505fcaf Fix link to documentation on writing highlighting files
Change-Id: I374219b03d94279ca9902567294ff4e49b8ad17a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-02 12:51:08 +00:00
Leena Miettinen
6741eb9293 Doc: Update guidelines for writing Qt Creator documentation
- Include information about writing Qt Design Studio Manual
  from its README file
- Update information about building the docs

Change-Id: Iaaff47ca3f07c859aa726e7e7f571042a8aadd48
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-04-02 07:07:52 +00:00
Leena Miettinen
e0d38ab353 Doc: Update instructions for creating plugins
Fixes: QTCREATORBUG-23701
Change-Id: I8e5569512eee87b18ddaeedde87122015e69b821
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-03-17 08:34:24 +00:00
Leena Miettinen
ac26d3bab9 Doc: Add Core:: namespace to \fn commands
To suppress QDoc warnings.

Task-number: QTCREATORBUG-23620
Change-Id: I4e5c633e7a0066f892f3247c28dac055557e68da
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-25 13:37:46 +00:00
Leena Miettinen
98e940c9b3 Doc: Display Core plugin classes in the API Reference
Task-number: QTCREATORBUG-23620
Change-Id: I64b3fc9ebd9ec140a28a5fbb2f70961086821ed2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-25 13:37:30 +00:00
Leena Miettinen
45a575c218 Doc: Fix QDoc warnings in Core plugin Wizard classes
Task-number: QTCREATORBUG-23620
Change-Id: Ia8d27be35911378703126c1e2d06a157ce6185f0
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-21 11:37:36 +00:00
Eike Ziller
e2fad3afa4 doc: Fix qdoc warnings in aggregation
Change-Id: Ia9a2e6dcdb8dc82ae600b974e396fd8ac3a42678
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-02-18 10:02:48 +00:00
Leena Miettinen
8046e3311f Doc: Fix QDoc warnings in Find classes
- Document BaseTextFind and FindSupport
- Mark undocumented classes and namespaces \internal
- Add and fix docs for IFindFilter, SearchResult, and
  SearchResultWindow

Fixes: QTCREATORBUG-23600
Change-Id: Ic9445f7f15562f114f4cbd9fe16988d7249d48db
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-17 15:45:51 +00:00
Leena Miettinen
d06eee5218 Doc: Fix QDoc warnings in Core plugin dialogs classes
- Fix IOptionsPage class docs
- Mark PromptOverwriteDialog and ReadOnlyFilesDialog

Fixes: QTCREATORBUG-23608
Change-Id: I6a646f0bd68230a7c5f80bd748bda20729f23b74
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-17 14:56:39 +00:00
Leena Miettinen
e12ba2d683 Doc: Fix broken links in Extending Qt Creator Manual
- Move some images from qtcreator\images to qtcreatordev\images
- Hide directories from the doc build (these will be added
  gradually when we fix the docs for the classes in them)
- Fix broken links
- Add README.md that describes the doc projects in the repo

Fixes: QTCREATORBUG-23544
Change-Id: I4fc29d8fbc8b7a0a0f81fa3261f6412c47b9d84e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-10 13:40:43 +00:00
Topi Reinio
4454873b54 Extending Qt Creator Manual: Fix links in the online sidebar
Change-Id: I08ca0c0847c022052428623de3be0416b8682e8d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-02-06 11:54:02 +00:00
Orgad Shaneh
0737291d54 Merge remote-tracking branch 'origin/4.11'
Change-Id: I65ce6aa917219a8f8b91b48c7077f8097248375c
2020-02-06 12:50:22 +02:00