Commit Graph

7 Commits

Author SHA1 Message Date
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
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
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
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
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
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
5fc456dd22 Doc: Rearrange files in the doc folder
Source and configuration files for each manual are now located in a
separate subdirectory, with common configuration files in doc/config.

doc
|_config
|_qtcreator
|_qtcreatordev
|_qtdesignstudio

Edit the config files accordingly.

Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-27 09:05:07 +00:00