feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Fix qdoc warnings

Browse Source 
- 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>
This commit is contained in:
Leena Miettinen
2023-05-26 17:00:14 +02:00
parent 4ecb016196
commit c04a4a1ae0
7 changed files with 23 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/qtcreatordev/src/plugin-tests.qdoc
View File

@@ -41,8 +41,8 @@
failure.
To add plugin tests, add a QObject based class with private slots for your
tests, and register it with \l{ExtensionSystem::IPlugin::addTest()} in your
plugin's \l{ExtensionSystem::IPlugin::initialized()} method. Guard all test
tests, and register it with \c{ExtensionSystem::IPlugin::addTest()} in your
plugin's \l{ExtensionSystem::IPlugin::initialize()} method. Guard all test
related code with a check for \c{WITH_TESTS}, to avoid shipping a binary
release of your plugin with test functions.