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

docs for property accessors don't inherit \preliminary from the property docs

    XMLWordPrintable

Details

    • Bug
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • 6.7
    • Build tools: qdoc
    • None

    Description

      This came up while trying to make clear that most of the API (both QML and C++ ) of https://doc.qt.io/qt-6/qml-qtquick-textdocument.html and https://doc.qt.io/qt-6/qquicktextdocument.html is in Tech Preview. There is a blanket \note at the top, but someone might miss it. (I have been working on https://codereview.qt-project.org/c/qt/qtdeclarative/+/545664 ) So this is not quite clear: if a property has \preliminary and then C++ accessor docs end up being generated, are we sure that the accessors are also shown to be \preliminary or tech preview? They should be, IMO, and I should not have to repeat myself by adding accessor docs just for the purpose of adding \preliminary to them.

      Maybe the property change notifier signals should be assumed \preliminary too, unless otherwise documented? I'm not sure.

      Attachments

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

        Activity

          People

            docinfrastructure Documentation Infrastructure Team
            srutledg Shawn Rutledge
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes