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

Make QML keyword documentation available in context help (Qt Creator)

    XMLWordPrintable

Details

    • User Story
    • Resolution: Unresolved
    • P3: Somewhat important
    • 6.8
    • None
    • Documentation, QML: Tooling
    • None

    Description

      When pressing F1 on QML keywords like 'import', 'pragma' in Qt Creator, no help is shown. But there is help in the documentation, it is just not properly linked.

      To make these available in Qt Creator, you need to add a qdoc \keyword to the relevant section in the documentation:

      \keyword QML.import

      Suggested keywords

      Keyword Documentation
      import https://doc.qt.io/qt-6/qtqml-syntax-imports.html#syntax-of-an-import-statement
      pragma https://doc.qt.io/qt-6/qtqml-documents-structure.html#pragmas
      Singleton https://doc.qt.io/qt-6/qtqml-documents-structure.html#singleton
      ... ...

      This was done already a while ago for the id property.

      Attachments

        Issue Links

          relates to

          Bug - A problem which impairs or prevents the functions of the product. QTCREATORBUG-3708 Context sensitive help does not work for several QML properties

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

          Task - A task that needs to be done. QTBUG-137204 qmlls: documentation for pragmas

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Reported
          For Gerrit Dashboard: QTBUG-137051
          # Subject Branch Project Status CR V
          647116,4 Make QML import/pragma keywords searchable dev qt/qtdeclarative Status: NEW +2 0

          Activity

            People

              kkohne Kai Köhne
              kkohne Kai Köhne
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There is 1 open Gerrit change