Commit Graph

11 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
Leena Miettinen
18514a5585 Doc: Fix links in the Extending Qt Creator Manual
- Hide links to sections that have not been written yet
- Fix some links to information that was moved
- Use HTTPS in links to Qt Creator Manual topics

Fixes: QTCREATORBUG-23529
Change-Id: Idd162c04fe6992bbecd2acd4a7ec388e49f29b84
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-29 12:40:39 +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