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

Make qdoc recognise and document technology preview APIs

    XMLWordPrintable

Details

    • User Story
    • Resolution: Unresolved
    • P2: Important
    • None
    • 6.7
    • Build tools: qdoc
    • None
    • DaVinci 94

    Description

      Once https://codereview.qt-project.org/c/qt/qtbase/+/536809 lands, we can declare APIs (classes, member functions, enums, free functions) as technology preview in our headers, so that we can a) see that they are in TP state when reviewing headers, and b) notice when they move out of TP.

      An additional benefit is that we can implicitly document respective APIs using consistent language - once qdoc knows about the tag. That should ideally make it obsolete to use \preliminary and equivalent tags explicitly in the respective documentation, although a useful first step might also be to warn if APIs marked with the tag don't use the correct existing tag (depends on which is easier to implement).

      Attachments

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

        Activity

          People

            diseraluca Luca Di Sera
            vhilshei Volker Hilsheimer
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes