Details
-
Bug
-
Resolution: Done
-
P2: Important
-
Qt Creator 4.11.0
-
None
-
e12ba2d68312434f50437c3b01f12834926eeb3b (qt-creator/qt-creator/master)
-
DaVinci sprint 3
Description
The Extending Qt Creator Manual will be published at doc.qt.io (in addition to the current snapshot release), so it would be good to fix at least the obvious QDoc warnings, such as wrong document signatures in \fn commands, wrong QDoc commands, and other QDoc formatting issues.
Fix the warnings for the following libs and plugins and hide the rest:
- src/libs/aggregationÂ
- src/libs/extensionsystem
After this is done, start documenting the rest in the order of importance (will create separate tasks for this):
- src/plugins/coreplugin/actionmanager
- src/plugins/coreplugin
- src/plugins/vcsbase
- src/plugins/projectexplorer (undergoing heavy changes)
- src/plugins/texteditor
- src/libs/utils
The priority of documenting the rest will be determined case-by-case.
Attachments
Issue Links
- resulted in
-
QTCREATORBUG-23584 Document Core plugin ActionManager class
-
- Closed
-
| For Gerrit Dashboard: QTCREATORBUG-23544 | ||||||
|---|---|---|---|---|---|---|
| # | Subject | Branch | Project | Status | CR | V |
| 289233,4 | Doc: Fix Aggregate class docs | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289252,5 | Doc: Fix IPlugin class docs | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289399,5 | Doc: Fix PluginManager docs | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289563,2 | Doc: Fix MimeType docs | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289567,3 | Doc: Fix Utils::NetworkAccessManager class docs | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289589,3 | Doc: Fix Utils::QrcCache and Utils::QrcParser docs | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289636,3 | Doc: Fix PluginDependency, PluginSpec, PluginArgumentDescription docs | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289649,4 | Add documentation for ExtensionSystem::invoke | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289656,2 | Doc: Remove info from ExtensionSystem::IPlugin doc | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289713,2 | Doc: Fix errors in QrcParser and QrcCache docs | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289729,2 | Doc: Fix QDoc warnings in ExtensionSystem class docs | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289732,2 | Doc: Add \inmodule command to Aggregation and Aggregate docs | 4.11 | qt-creator/qt-creator | Status: MERGED | +2 | 0 |
| 289890,3 | Doc: Fix broken links in Extending Qt Creator Manual | master | qt-creator/qt-creator | Status: MERGED | +2 | 0 |