summaryrefslogtreecommitdiff
path: root/doc/qtcreatordev
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix reference to an image that is now in WEBP formatLeena Miettinen2023-03-241-1/+1
| | | | | | Task-number: QTCREATORBUG-28778 Change-Id: I1d0b45781a1692384ec218d74f4f270b083916ed Reviewed-by: Christian Stenger <christian.stenger@qt.io>
* Plugins: Add documentation about testingEike Ziller2023-02-288-2/+213
| | | | | | | | 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>
* Coding style: Avoid optional::value()Eike Ziller2023-02-231-0/+23
| | | | | | Change-Id: Ic4769c6f9f016415e01ca5526f6730bc93c6ea81 Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Coding style: Avoid empty round brackets in lambdasJarek Kobus2023-02-231-29/+14
| | | | | | | | | 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>
* Coding style: Remove outdated section wrt nullptrEike Ziller2023-02-161-5/+0
| | | | | | | | Ealier we state that nullptr should be used, and that is the current policy. Change-Id: Id462458f36893354a4f95e086d25a946f94b495e Reviewed-by: hjk <hjk@qt.io>
* Coding style: Remove wrong compiler statement and merge C++ sectionsEike Ziller2023-02-161-4/+0
| | | | | | | | | | | | 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>
* Utils: Enable internal documentationJarek Kobus2023-02-092-3/+4
| | | | | | Change-Id: I8531f7a85c8bee32a207f477e7ee9d3d9f14107c Reviewed-by: <github-actions-qt-creator@cristianadam.eu> Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Replace GPL-3.0 with GPL-3.0-onlyKai Köhne2023-01-102-2/+2
| | | | | | | | | | | | | 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>
* PluginSpec: Add a "LongDescription" to plugin meta dataEike Ziller2022-12-161-1/+6
| | | | | | | | | | | | | | | | | | 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>
* Merge remote-tracking branch 'origin/8.0' into 9.0Eike Ziller2022-10-181-29/+52
|\ | | | | | | | | | | | | | | | | | | 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
| * Doc: Update instructions for writing documentationLeena Miettinen2022-10-131-29/+52
| | | | | | | | | | | | | | For new and updated images, use the display resolution 1920x1080. Change-Id: Ie7a83d23eacfa8ba9b78a4de4ee9046e838fa72c Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
* | Use SPDX license identifiersLucie Gérard2022-08-2618-432/+36
| | | | | | | | | | | | | | | | | | 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>
* | Merge remote-tracking branch 'origin/8.0'Eike Ziller2022-07-122-4/+4
|\ \ | |/ | | | | Change-Id: I37a1f78caf9ae258c6b052efa3be15b3dbcbe164
| * Doc: Do not use comma before "because"Leena Miettinen2022-07-122-4/+4
| | | | | | | | | | Change-Id: I375342fa10b95e26a3de2524610905c4d5503d3e Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* | Adjust coding style to C++17 nested namespaceshjk2022-07-071-4/+2
|/ | | | | Change-Id: I34376108d77e0faeb6498cefedb563276f42fefa Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Doc: Replace "Tools > Options" with "Edit > Preferences"Leena Miettinen2022-06-283-4/+4
| | | | | | | | The menu was moved and renamed. The Options dialog was also renamed "Preferences". Change-Id: I05d187915382b3ce49699d91304cd447c87e2bd6 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Doc: Do not use the term "Output pane" in docsLeena Miettinen2022-03-092-7/+7
| | | | | | | | | | | | 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>
* Doc: Describe src/tools/icons/recolordocsicons.pyLeena Miettinen2022-01-251-1/+30
| | | | | | | Task-number: QTCREATORBUG-26644 Change-Id: Ibba0949211e0ae716ddd6974c87eaefe503b45d2 Reviewed-by: <github-actions-qt-creator@cristianadam.eu> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Remove qmake build filesEike Ziller2022-01-201-99/+0
| | | | | | | | | | 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>
* Bump requirement to Qt 5.15.2Eike Ziller2022-01-171-3/+0
| | | | | | | | | | | | | | 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>
* Split "New File or Project" into "File" and "Project" partsEike Ziller2021-12-024-6/+6
| | | | | | | | | | | 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>
* Doc: Update information about Qt Creator plugin wizardEike Ziller2021-08-2412-134/+626
| | | | | | | | After the switch to CMake. Extends 29f3be1a6e236a199514a4edeeddb07322d70df4 Change-Id: I626bc7393d290710d7e5d1f2907e6fa1f25a7d21 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Fix term used for angle brackets in coding style topicLeena Miettinen2021-08-241-1/+1
| | | | | Change-Id: I73f21a9fd8fbf2e4388b501edbc27371d907b166 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Doc: Update info about Qt Creator plugin wizard templateLeena Miettinen2021-08-238-36/+24
| | | | | | | | | Update screenshots Fixes: QTCREATORBUG-26153 Change-Id: I3dddbc1b8b8f6989a9afd445f1df3e868fd72e0f Reviewed-by: Artem Sokolovskii <artem.sokolovskii@qt.io> Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Doc: Add some rules about use of Utils::FilePath and Utils::QtcProcesshjk2021-05-211-4/+31
| | | | | | | 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>
* Doc: Use version independent Qt linkKai Koehne2020-12-102-2/+2
| | | | | | | or use direct links where possible. Change-Id: I00d559ad53a95caf91c39985bd9fb5ea99f9aed7 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Update instructions for using the \youtube macroLeena Miettinen2020-12-091-16/+13
| | | | | | | | 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>
* Coding style: Remove outdated recommendation of foreach()hjk2020-12-071-29/+0
| | | | | | Change-Id: I01eadfdbefededf3b71df492a0e29abdd3a3a93f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Doc: Describe building docs with CMake and using the online styleLeena Miettinen2020-12-031-44/+177
| | | | | | | | | | 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>
* Doc: Add instructions for using the \youtube macroLeena Miettinen2020-11-301-0/+46
| | | | | | | | | 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>
* Doc: Add list to words to ignore for automatic linkingLeena Miettinen2020-09-091-0/+9
| | | | | Change-Id: Idfa50889deeff64a8d97bfbb5deaf4c86a32e2bf Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* ExtensionSystem: Remove PluginSpec::isHiddenByDefaulthjk2020-06-161-7/+0
| | | | | | | Not used anymore. Change-Id: Ic73ba3024b9e6157ff044cb23450fc9dad3c4c02 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Add some documentation about distributing pluginsEike Ziller2020-06-032-1/+126
| | | | | | Change-Id: I02eff822105a4c98575f745bb0f4d222afb0bb73 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
* Doc: Describe writing docs for independent pluginsLeena Miettinen2020-05-281-3/+20
| | | | | | | | Plugins that reside in their own repositories need their own documentation. Change-Id: I97ff5b2b6788c6dd90364117e842dcdfd63085b5 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Unregister deleted IContext objects automaticallyEike Ziller2020-05-271-2/+3
| | | | | Change-Id: I7b84c02c8fe1e7201431116e3d993792370fb942 Reviewed-by: hjk <hjk@qt.io>
* Doc: Fix naming of .index filesEike Ziller2020-05-251-1/+1
| | | | | | | | | | | 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>
* Add some documentation on action manager and commandsEike Ziller2020-04-204-0/+1048
| | | | | Change-Id: I03d8292120b30973155248471b12d1627536fb39 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Fix style for menu hierarchiesEike Ziller2020-04-031-1/+1
| | | | | | | Use \uicontrol for the individual components individually Change-Id: Idf62db7c37e94a55a988792f13aaa8c49cb1ac07 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Fix link to documentation on writing highlighting filesEike Ziller2020-04-021-2/+2
| | | | | Change-Id: I374219b03d94279ca9902567294ff4e49b8ad17a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Update guidelines for writing Qt Creator documentationLeena Miettinen2020-04-021-71/+250
| | | | | | | | | - 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>
* Doc: Update instructions for creating pluginsLeena Miettinen2020-03-179-20/+33
| | | | | | | Fixes: QTCREATORBUG-23701 Change-Id: I8e5569512eee87b18ddaeedde87122015e69b821 Reviewed-by: David Schulz <david.schulz@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Add Core:: namespace to \fn commandsLeena Miettinen2020-02-251-2/+5
| | | | | | | | To suppress QDoc warnings. Task-number: QTCREATORBUG-23620 Change-Id: I4e5c633e7a0066f892f3247c28dac055557e68da Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Doc: Display Core plugin classes in the API ReferenceLeena Miettinen2020-02-251-2/+5
| | | | | | Task-number: QTCREATORBUG-23620 Change-Id: I64b3fc9ebd9ec140a28a5fbb2f70961086821ed2 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Doc: Fix QDoc warnings in Core plugin Wizard classesLeena Miettinen2020-02-211-5/+10
| | | | | | Task-number: QTCREATORBUG-23620 Change-Id: Ia8d27be35911378703126c1e2d06a157ce6185f0 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* doc: Fix qdoc warnings in aggregationEike Ziller2020-02-181-0/+2
| | | | | Change-Id: Ia9a2e6dcdb8dc82ae600b974e396fd8ac3a42678 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Fix QDoc warnings in Find classesLeena Miettinen2020-02-171-4/+3
| | | | | | | | | | | - 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>
* Doc: Fix QDoc warnings in Core plugin dialogs classesLeena Miettinen2020-02-171-0/+0
| | | | | | | | | - Fix IOptionsPage class docs - Mark PromptOverwriteDialog and ReadOnlyFilesDialog Fixes: QTCREATORBUG-23608 Change-Id: I6a646f0bd68230a7c5f80bd748bda20729f23b74 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
* Doc: Fix broken links in Extending Qt Creator ManualLeena Miettinen2020-02-1017-192/+215
| | | | | | | | | | | | - 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>
* Extending Qt Creator Manual: Fix links in the online sidebarTopi Reinio2020-02-061-7/+6
| | | | | Change-Id: I08ca0c0847c022052428623de3be0416b8682e8d Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Merge remote-tracking branch 'origin/4.11'Orgad Shaneh2020-02-061-1/+2
| | | | Change-Id: I65ce6aa917219a8f8b91b48c7077f8097248375c
View Lorry Controller Status