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

New feature: be able to set a group name when using the selector fake:qmlclass

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • P3: Somewhat important
    • 5.6.0 RC
    • None
    • Build tools: qdoc
    • None

    Description

      It would be nice to be able to set a group name when using the selector value fake:qmlclass. It would be convenient for sub-projects when you want to split the qmltypes in different categories.

      Looking at the qdocconf sample below:

      qhp.QtQuickControls.filterAttributes    = qtquickcontrols $QT_VERSION qtrefdoc
      qhp.QtQuickControls.customFilters.Qt.name = QtQuickControls $QT_VERSION
      qhp.QtQuickControls.customFilters.Qt.filterAttributes = qtquickcontrols $QT_VERSION
      
      qhp.QtQuickControls.subprojects = qtquickcontrolsqmltypes qtquickcontrolsstyles qtquickcontrolsstylesqmltypes
      
      qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.title      = Controls QML Types
      qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.indexTitle = Qt Quick Controls QML Types
      qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.selectors  = fake:qmlclass # cannot qmltypes from a specific group
      qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.sortPages  = true
      
      qhp.QtQuickControls.subprojects.qtquickcontrolsstyles.title      = Qt Quick Controls Styles
      qhp.QtQuickControls.subprojects.qtquickcontrolsstyles.indexTitle = Qt Quick Controls Styles
      qhp.QtQuickControls.subprojects.qtquickcontrolsstyles.selectors  = fake:module
      qhp.QtQuickControls.subprojects.qtquickcontrolsstyles.sortPages  = true
      
      qhp.QtQuickControls.subprojects.qtquickcontrolsstylesqmltypes.title      = Styles QML Types
      qhp.QtQuickControls.subprojects.qtquickcontrolsstylesqmltypes.indexTitle = Qt Quick Controls Styles QML Types
      qhp.QtQuickControls.subprojects.qtquickcontrolsstylesqmltypes.selectors  = fake:qmlclass # cannot qmltypes from a specific group
      qhp.QtQuickControls.subprojects.qtquickcontrolsstylesqmltypes.sortPages  = true
      

      The subprojects qtquickcontrolsqmltypes and qtquickcontrolsstylesqmltypes need the selector fake:qmlclass.
      When this selector is set, all the qml type from the parent projects are shown. It would be convenient to have an option to show the qmltypes only for a given group.

      For example:
      qhp.QtQuickControls.subprojects.qtquickcontrolsstylesqmltypes.selectors = fake:qmlclass.controlsstyling
      qhp.QtQuickControls.subprojects.qtquickcontrolsqmltypes.selectors = fake:qmlclass.controls

      Given that the doc looks like:

          \qmltype ButtonStyle
          \inqmlmodule QtQuick.Controls.Styles 1.0
          \since QtQuick.Controls.Styles 1.0
          \ingroup controlsstyling
          \brief Provides custom styling for Button
      

      and

          \qmltype Button
          \inqmlmodule QtQuick.Controls 1.0
          \since QtQuick.Controls 1.0
          \ingroup controls
          \brief A push button with a text label.
      

      Attachments

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

        Activity

          People

            treinio Topi Reiniƶ
            carochao Caroline Chao (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes