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

Associate a group page to groups that currently have members

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Open
    • Priority: P3: Somewhat important
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      QDoc allows the grouping of semantically related elements under a "group", through the "\ingroup" command.

       

      A page documenting the meaning of a group can be produced through the "\group" command, further containing a reference to each element associated with it.

      Due to recent tentative changes to QDoc to try to give more visibility to "\group" pages, as a way to increase the discoverability of some of the overview documentation, it is strongly advised that a group page is generated for each group.

       

      This is currently not the case, as some elements are associated with groups that have no group page.

       

      A tentative list of such groups is:

       

      comm -23 <(rg -o --no-filename "\\\\ingroup\s*\S*" | cut -d' ' -f2 | sort -u) <(rg -o --no-filename "\\\\group\s*\S*" | cut -d' ' -f2 | sort -u)
      
      ?
      abstractwidgets
      advanced
      alignedboxtypedefs
      and
      androidplatform
      appearance
      arraytypedefs
      attributions-"
      basicwidgets
      camera_examples
      camera_examples_qml
      camera_qml
      cbor
      CborGlobals
      changes-qt-5-to-6
      Cholesky_Module
      classlists
      cmake-commands-qtqml
      cmake-macros-qtlinguisttools
      cmake-macros-qtremoteobjects
      cmake-macros-qtscxml
      cmake-macros-qtwidgets
      cmake-properties-qtcore
      cmake-variables-qtqml
      codecs
      command's
      connectivity-nfc
      Core_Module
      datavisualization_qml
      desktop
      dialog-classes
      draganddrop
      draganddrop}
      Eigenvalues_Module
      enums
      examples
      examples-graphicsview
      examples-graphicsview-graphicseffects
      examples-graphicsview-layout
      examples-layout
      examples-mimetype
      examples-vulkan
      experimentalplatform
      flags
      framegraph
      frameworks-technologies
      funclists
      geomanagement
      geometries
      Geometry_Module
      gestures
      graphicsview-api
      Householder_Module
      \ingroup
      \ingroup)
      \ingroup),
      \ingroup.
      \ingroup}
      input
      Jacobi_Module
      layouts
      licensing
      LU_Module
      mainwindow-classes
      matrixtypedefs
      misc
      miscellaneous
      model-view
      multimedia
      multimedia_audio
      multimedia_audio_qml
      multimedia_camera
      multimedia_control
      multimedia_core
      multimedia-namespaces
      multimedia_playback
      multimedia_qml
      multimedia_recording
      multimedia_spatialaudio
      multimedia_video
      multimedia_video_qml
      native-interfaces-qcoreapplication
      native-interfaces-qguiapplication
      native-interfaces-qoffscreensurface
      native-interfaces-qopenglcontext
      native-interfaces-qsgtexture
      oauth
      objectmodel
      organizers
      overviews
      QML
      qml-animation-transition
      qmlclass
      qmlmodules
      qml-QtPositioning5-basictypes
      qml-QtPositioning5-common
      qml-sensors_reading
      qml-sensors_type
      qml-transform-elements
      qmltypes
      qml-utility-elements
      qmlvaluetypes
      qnxcontent
      qpa
      QR_Module
      qt3d
      qt3d-examples-cpp
      qt3d-examples-qml
      qt3d-extras-cameracontrollers
      qt3d-extras-geometries
      qt3d-extras-materials
      qt3d::math
      qt3d-modules
      qt3d-modules-preliminary
      qt3d-namespaces
      qt3d-qmlmodules
      qt3d-qmlmodules-preliminary
      qtdatavisualization_examples
      qt-embedded-linux
      qtgraphicaleffects-blend
      qtgraphicaleffects-blur
      qtgraphicaleffects-color
      qtgraphicaleffects-distortion
      qtgraphicaleffects-drop-shadow
      qtgraphicaleffects-glow
      qtgraphicaleffects-gradient
      qtgraphicaleffects-mask
      qtgraphicaleffects-motion-blur
      qt-graphics
      qtjavascript
      QtLocation-places
      QtLocation-places-data
      qtpositioning
      QtPositioning-plugins
      QtPositioning-positioning
      qtqmltypes
      qtqmlvaluetypes
      qtquick
      qtquick-animation-control
      qtquick-animation-paths
      qtquick-animation-properties
      qtquick-canvas
      qtquick-containers
      qtquickcontrols2-buttons
      qtquickcontrols2-containers
      qtquickcontrols2-delegates
      qtquickcontrols2-dialogs
      qtquickcontrols2-focusscopes
      qtquickcontrols2-guidelines
      qtquickcontrols2-indicators
      qtquickcontrols2-input
      qtquickcontrols2-menus
      qtquickcontrols2-navigation
      qtquickcontrols2-popups
      qtquickcontrols2-separators
      qtquickdemos
      qtquick-dynamic
      qtquick-effects
      qtquickexamples
      qtquick-images-sprites
      qtquick-input
      qtquick-input-events
      qtquick-input-handlers
      qtquick-interceptors
      qtquick-models
      qtquick-particles
      qtquick-paths
      qtquick-positioners
      qtquick-positioning
      qtquick-states
      qtquicktest
      qtquick-text-utility
      qtquick-text-validator
      qtquick-threading
      qtquick-tools
      qtquick-transformations
      qtquick-transitions-animations
      qtquickvaluetypes
      qtquick-views
      qtquick-visual
      qtquick-visual-transforms
      qtquick-visual-utility
      qtserialbus
      qttools
      qtvirtualkeyboard-components-qml
      qtvirtualkeyboard-cpp-for-apps
      qtvirtualkeyboard-cpp-for-devs
      qtvirtualkeyboard-internal-qml
      qtvirtualkeyboard-key-types
      qtvirtualkeyboard-qml
      qtvirtualkeyboard-settings-qml
      qtvirtualkeyboard-styles-qml
      qtwebview
      quick3d_audio
      qws
      RAPIDJSON_CONFIG
      RAPIDJSON_ERRORS
      renderstates
      sensorgestures_main
      sensorgestures_recognizer
      sensors_backend
      sensors_filter
      sensors_main
      sensors_reading
      sensors_type
      serialport-main
      settings
      spatialaudio_examples
      ssl
      standard-dialog
      statemachine
      statemachine-qmltypes
      supportedplatform
      SVD_Module
      technology-apis
      testgroup
      text
      texttospeech_qml
      tools
      touch
      tutorials
      tutorials}
      utilities
      video_examples
      video_examples_qml
      webchannel-qml
      websockets-qml
      

      Do note that the list may contain some false positive.

      Where it makes sense, a page group should be provided for the groups that are missing it.

        Attachments

          Issue Links

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

            Activity

              People

              Assignee:
              docteam Qt Documentation Team
              Reporter:
              diseraluca Luca Di Sera
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:

                  Gerrit Reviews

                  There are no open Gerrit changes