Details
-
Suggestion
-
Resolution: Fixed
-
P3: Somewhat important
-
5.8
-
None
-
c366087381978465049e65fffa48ab19974ecb92 (qt/qttools/dev) 1637d91efd8fb389bc09bdaa960f5d9d4f9e0164 (qt/tqtc-qttools/6.2)
-
Da Vinci sprint 30, Da Vinci sprint 31, Da Vinci sprint 32, Da Vinci sprint 33
Description
Class documentation should not only say whether a class or function call is deprecated, but also mention the Qt version it got deprecated first.
We consider the latest documentation at http://doc.qt.io/qt-5/ to be valid for older versions. This is why we e.g. document the exact Qt version when a particular class or method got added (\since). Anyhow, we don't do so when deprecating things.
We could e.g. add a \deprecatedsince command, alongside \deprecated.
Attachments
Issue Links
- relates to
-
QTBUG-92481 [QDoc] Warn if a member is marked \obsolete but does not have QT_DEPRECATED_SINCE()
- Open
-
QTBUG-114157 qdoc: Consolidate and emphasize \deprecated messages for QML and C++
- Open
For Gerrit Dashboard: QTBUG-58249 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
339798,10 | QDoc: Add \deprecatedsince command | dev | qt/qttools | Status: MERGED | +2 | 0 |
346647,4 | Revert "QDoc: Add \deprecatedsince command" | dev | qt/qttools | Status: MERGED | +2 | 0 |
347076,21 | Doc: Improve \deprecated command | dev | qt/qttools | Status: MERGED | +2 | 0 |
347794,7 | qdoc: Remove Node::Obsolete status | dev | qt/qttools | Status: MERGED | +2 | 0 |