Details
-
Suggestion
-
Resolution: Unresolved
-
P2: Important
-
None
-
None
-
5917b2b7e (dev), a3a420c3e (6.5), 7e71f1c1a (dev)
-
DaVinci 81, DaVinci 82, DaVinci 83, DaVinci 84, DaVinci 85, DaVinci 88
Description
Compare the links at https://doc.qt.io/qt-6/obsoleteqmltypes.html with those at https://doc.qt.io/qt-6/obsoleteclasses.html
Suggestions
- Add bolded notices at the top of the pages of deprecated QML types, similar to what C++ classes have: "This type is deprecated since 6.5. We strongly advise against using it in new code."
- Move the "deprecation reason"/"suggested alternative" text from the "Detail Description" section to the end of the bolded notice.
Examples
- https://doc.qt.io/qt-6/qwebenginequotarequest.html should say at the top, "This class is deprecated since 6.5. We strongly advise against using it in new code. Requesting host quota is no longer supported by Chromium."
- https://doc.qt.io/qt-6/qml-qtwebengine-quotarequest.html should say at the top, "This type is deprecated since 6.5. We strongly advise against using it in new code. Requesting host quota is no longer supported by Chromium."
- https://doc.qt.io/qt-6/qml-qt-labs-settings-settings.html should say at the top, "This type is deprecated since 6.5. We strongly advise against using it in new code. Use Settings from Qt QML Core instead."
Rationale
Normally, the first line of the Detailed Description is a short summary of the class/type. Displacing that summary with a "deprecation reason"/"suggested alternative" can cause surprise. Instead, writing that "deprecation reason"/"suggested alternative" as a continuation of the deprecation notice makes it much clearer.
Attachments
Issue Links
- blocks
-
QTBUG-117470 qdoc: Warn if a \deprecated string does not end with a dot.
- Open
- relates to
-
QTBUG-58249 Document Qt version an API got deprecated
- Closed
-
QTBUG-117152 Show deprecation, since information for API in a consistent way
- Closed
Gerrit Reviews
For Gerrit Dashboard: QTBUG-114157 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
481335,5 | Unify text on overview pages for obsolete content | dev | qt/qtdoc | Status: MERGED | +2 | 0 |
481379,2 | Unify text on overview pages for obsolete content | 6.5 | qt/qtdoc | Status: MERGED | +2 | 0 |
481701,5 | QDoc: Generate deprecation warning in QML Type page headers | dev | qt/qttools | Status: MERGED | +2 | 0 |