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

Document Qt version an API got deprecated

    XMLWordPrintable

Details

    • c366087381978465049e65fffa48ab19974ecb92 (qt/qttools/dev) 1637d91efd8fb389bc09bdaa960f5d9d4f9e0164 (qt/tqtc-qttools/6.2)
    • Da Vinci sprint 30, Da Vinci sprint 31, Da Vinci sprint 32, Da Vinci sprint 33

    Description

      Class documentation should not only say whether a class or function call is deprecated, but also mention the Qt version it got deprecated first.

      We consider the latest documentation at http://doc.qt.io/qt-5/ to be valid for older versions. This is why we e.g. document the exact Qt version when a particular class or method got added (\since). Anyhow, we don't do so when deprecating things.

      We could e.g. add a \deprecatedsince command, alongside \deprecated.

      Attachments

        Issue Links

          relates to

          Suggestion - Public suggestions QTBUG-92481 [QDoc] Warn if a member is marked \obsolete but does not have QT_DEPRECATED_SINCE()

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Open

          Suggestion - Public suggestions QTBUG-114157 qdoc: Consolidate and emphasize \deprecated messages for QML and C++

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Open
          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              paulwicking Paul Wicking
              kkohne Kai Köhne
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes