Details
-
User Story
-
Resolution: Unresolved
-
P2: Important
-
None
-
None
-
None
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,2 | qdoc: Allow processing doc comments in headers | dev | qt/qttools | Status: NEW | 0 | 0 |