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

qdoc: Warn about usage of C++ types in QML API documentation

    XMLWordPrintable

Details

    • User Story
    • Resolution: Unresolved
    • P2: Important
    • None
    • None
    • Build tools: qdoc
    • DaVinci 109

    Description

      A lot of our QML API is documented by the C++ types, while it should use QML types. See e.g. https://doc.qt.io/qt-6/qml-qtquick-application.html :

      Anyhow, this error is easy to make, as the surrounding C++ code actually does use the native C++ types - the conversion to the QML native types when the class is used from QML is implicit.

      Can qdoc at least warn about such cases?

      Attachments

        Issue Links

          relates to

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-130092 Documentation: WindowContainer doesn't link to Window

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-131261 Use QML types Application QML Type documentation

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Reported

          Suggestion - Public suggestions QTBUG-119727 Automatically generate QML documentation from C++

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Reported
          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              docinfrastructure Documentation Infrastructure Team
              kkohne Kai Köhne
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes