Details
-
Bug
-
Resolution: Fixed
-
P2: Important
-
5.13
-
-
DaVinci X-mas sprint
Description
The documentation for the QML types DelegateChooser and DelegateChoice has a few errors:
- Both types show incorrect import statements on their documentation pages:
- The Qt Labs Platform module documentation does not reference these types: https://doc.qt.io/qt-5.13/qtlabsplatform-index.html#
- Both DelegateChooser and DelegateChoice are shown on the "All QML Types" page despite being in Qt Labs: https://doc.qt.io/qt-5.13/qmltypes.html. It's not clear to me if this is intentional or not but it seems to be inconsistent with the other Qt Labs types because they are not shown on this page.
- Not entirely an issue, but something to note- The previous 5.12 links to these types are no longer valid in the 5.13 documentation:
(1) is a regression from 5.12 because the import statement of both types was previously documented correctly: https://doc.qt.io/qt-5.12/qml-qt-labs-qmlmodels-delegatechoice.html
(2) is not a regression because these types were not listed on the 5.12 Qt Labs Platform module documentation either. https://doc.qt.io/qt-5.12/qtlabsplatform-index.html#
(3) is not a regression because both types were shown on the "All QML Types" page in the 5.12 documentation. https://doc.qt.io/qt-5.12/qmltypes.html
In the 5.13 documentation it is unclear what the proper import statement to use these types is. Based on the 5.13 source code, it appears that the import statement should be the same as it was before (based on ./Src/qtdeclarative/src/imports/labsmodels/plugins.qmltypes):
import Qt.labs.qmlmodels 1.0
This might be a reoccurring issue because it looks like there was an issue with the documentation of these types initially in 5.12 too: QTBUG-71316
Attachments
Issue Links
- relates to
-
QTBUG-71316 The documentation for DelegateChooser doesn't show up
- Closed
-
QTBUG-73964 The documentation for DelegateChooser & DelegateChoice lacks code examples
- Closed