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

qdoc: Allow modules to explicitly declare their state

    XMLWordPrintable

    Details

    • Type: User Story
    • Status: Closed
    • Priority: P3: Somewhat important
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: 6.5.0 Beta1
    • Component/s: Build tools: qdoc
    • Labels:
      None
    • Sprint:
      DaVinci 58, DaVinci 59
    • Commits:
      214521bf8d (qt/qttools/dev) 214521bf8d (qt/tqtc-qttools/dev)

      Description

      Qt modules have a life-time: Most start with a 'technical preview', then are promoted to a fully supported module, before (potentially) being 'deprecated', and eventually removed.

      The documentation should be more explicit when modules are being in 'technical preview'. Right now, the state is only listed on https://doc.qt.io/qt-6/qtmodules.html, but doesn't show up in the module overview, or the class documentation. One suggestion to fix this is to add a

      \modulestate "Technical Preview"

      And show appropriate warnings in all generated documentation pages:

      breadcrumb menu could say e.g. "Qt 6.5 > QtHttpServer (Technical Preview)"

      https://doc-snapshots.qt.io/qt6-dev/qthttpserver-module.html
      could say "This module was introduced in Qt 6.4, and is in Technical Preview state."

        Attachments

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

          Activity

            People

            Assignee:
            treinio Topi Reiniö
            Reporter:
            kkohne Kai Köhne
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Gerrit Reviews

                There are no open Gerrit changes