Details
-
Suggestion
-
Resolution: Unresolved
-
P3: Somewhat important
-
None
-
None
-
9a6d405cd (dev)
-
framework-content 1
Description
There are 3 different QML modules that contain types with the same name but different APIs:
- Qt Quick Controls: https://doc.qt.io/Qt-6/qtquick-controls-qmlmodule.html
- Qt Quick Dialogs: https://doc.qt.io/qt-6//qtquick-dialogs-qmlmodule.html
- Qt Labs Platform: https://doc.qt.io/qt-6/qml-qt-labs-platform-dialog.html
There have been numerous cases where users got confused between, say...
- QtQuick.Dialogs.FileDialog and Qt.labs.platform.FileDialog
- QtQuick.Controls.Menu and Qt.labs.platform.Menu
- QtQuick.Controls.Dialog and QtQuick.Dialogs.Dialog and Qt.labs.platform.Dialog
Suggestion
It would be good for the documentation to help users to disambiguate between the different types of the same name.
- Perhaps each type reference page can link to the alternative types. Something like "Note: A different implementations of this type exists in the _________ module" (Although I haven't thought about how to present Dialog, which is present in 3 modules)
- Perhaps a new qdoc command can be introduced to help with this? (Although we generally want to avoid name clashes and ambiguous API in the first place)
Attachments
Issue Links
- relates to
-
QTBUG-130863 [Doc][iOS] Native image picker docs should focus on Qt.Quick.Dialogs.FileDialog rather than Qt.labs.platform.FileDialog
- Reported