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

Add used qt modules as example tags

    XMLWordPrintable

    Details

    • Type: User Story
    • Status: Open
    • Priority: P3: Somewhat important
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Build tools: qdoc
    • Labels:
      None

      Description

      As a user, I'd like to look for examples that show usage of a specific Qt module.

      As a developer, I don't want to maintain explicit tags in .qdocconf.

      To overcome this, we could extend qdoc to extract information about used Qt Modules from the example sources.

      Source: CMakeLists.txt file

      All examples have a CMakeLists.txt file that lists the dependencies:

      find_package(Qt6 REQUIRED COMPONENTS Core Gui Quick QuickControls2)
      

      This could be grepped by qdoc.

      Challenge: Some root modules will be all over the place; all examples depend on Core. Also, just because an example uses 'Quick' doesn't mean that it's a good example for development for Quick in itself.

      Example tags: Core, Gui, Quick, QuickControls2

      Should we 'namespace' this, e.g. to Qt6Core?

      Source: QML imports

      Many QML Imports don't require a build system dependency. In this case, qdoc could use qmlimportscanner to list all imports.

      Example tags: QtQuick, QtQml.Models, QtQuick.Controls, TableModel, Qt.labs.animation

        Attachments

          Issue Links

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

            Activity

              People

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

                Dates

                Created:
                Updated:

                  Gerrit Reviews

                  There are no open Gerrit changes