Details
-
User Story
-
Resolution: Fixed
-
P2: Important
-
None
-
None
-
DaVinci 104, DaVinci 105, DaVinci 106
-
ba92ad037 (dev), d3cff9974 (dev), 05e51d405 (dev)
Description
As a developer, I want to write the documentation for my API in the header file where I declare it.
Background: In Qt, documentation is contained in implementation files and .qdoc files. Other projects keep documentation comments in header files. This was raised as an obstacle in using QDoc for generating documentation for other projects during the Qt Contributor's Summit 2021.
Attachments
Gerrit Reviews
| For Gerrit Dashboard: QTBUG-94746 | ||||||
|---|---|---|---|---|---|---|
| # | Subject | Branch | Project | Status | CR | V |
| 574401,8 | QDoc: Allow processing documentation comments in headers | dev | qt/qttools | Status: MERGED | +2 | 0 |
| 592928,9 | QDoc: Add test project with C++ documentation in headers only | dev | qt/qttools | Status: MERGED | +2 | 0 |
| 598011,4 | qdoc: Allow auto-tying templated function docs in the header | dev | qt/qttools | Status: MERGED | +2 | 0 |