Details
-
Task
-
Resolution: Fixed
-
P3: Somewhat important
-
6.5
-
None
-
34d28f769 (dev), 046447a6f (dev), 041e10e64 (dev), 55ad63713 (6.5)
-
DaVinci 78
Description
QDoc supports multiple ways to document the status of a C++ class or a QML type: Deprecated, deprecated since <version>, preliminary, or a custom status, typically 'Technology preview'.
This status information is reflected on different parts of the documentation; An auto-generated sentence in the detailed description of the type and/or it's module page, or in the navigation (breadcrumbs) for HTML output.
Add the status to the 'requisites' table on of of the type reference - it's a logical place for this information and makes it easier to discover.
Attachments
| For Gerrit Dashboard: QTBUG-113026 | ||||||
|---|---|---|---|---|---|---|
| # | Subject | Branch | Project | Status | CR | V |
| 473701,3 | qdoc: Add status information to the requisites table for types | dev | qt/qttools | Status: MERGED | +2 | 0 |
| 473702,3 | qdoc: Allow custom status descriptions for C++, QML types | dev | qt/qttools | Status: MERGED | +2 | 0 |
| 474176,2 | qdoc: Allow custom status descriptions for C++, QML types | 6.5 | qt/qttools | Status: ABANDONED | 0 | 0 |
| 474177,1 | qdoc: Add status information to the requisites table for types | 6.5 | qt/qttools | Status: ABANDONED | 0 | 0 |
| 474380,2 | Doc: Add CSS styling and icon for 'technical preview' items | dev | qt/qtbase | Status: MERGED | +2 | 0 |
| 476831,2 | Doc: Add CSS styling and icon for 'technical preview' items | 6.5 | qt/qtbase | Status: MERGED | +2 | 0 |