Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-130864

Doc: Help users to realize that some QML types have different implementations in different modules (e.g. FileDialog)

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • None
    • Documentation
    • 9a6d405cd (dev)
    • framework-content 1

    Description

      There are 3 different QML modules that contain types with the same name but different APIs:

       

      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

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              hurlevent Oliver Eftevaag
              skoh-qt Sze Howe Koh
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes