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

qdoc: Consolidate and emphasize \deprecated messages for QML and C++

    XMLWordPrintable

Details

    • 5917b2b7e (dev), a3a420c3e (6.5), 7e71f1c1a (dev)
    • DaVinci 81, DaVinci 82, DaVinci 83, DaVinci 84, DaVinci 85, DaVinci 88

    Description

      Compare the links at https://doc.qt.io/qt-6/obsoleteqmltypes.html with those at https://doc.qt.io/qt-6/obsoleteclasses.html

       

      Suggestions

      • Add bolded notices at the top of the pages of deprecated QML types, similar to what C++ classes have: "This type is deprecated since 6.5. We strongly advise against using it in new code."
      • Move the "deprecation reason"/"suggested alternative" text from the "Detail Description" section to the end of the bolded notice.

       

      Examples

       

      Rationale

      Normally, the first line of the Detailed Description is a short summary of the class/type. Displacing that summary with a "deprecation reason"/"suggested alternative" can cause surprise. Instead, writing that "deprecation reason"/"suggested alternative" as a continuation of the deprecation notice makes it much clearer.

      Attachments

        Issue Links

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

          Activity

            People

              docinfrastructure Documentation Infrastructure Team
              skoh-qt Sze Howe Koh
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes