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

qdoc: Show additional comments that are attached to \obsolete or \deprecated members

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Duplicate
    • Not Evaluated
    • 5.15
    • 5.11.0 RC 1
    • Documentation

    Description

      Functions/enums that are marked "\obsolete" or "\deprecated" are sometimes annotated with additional comments that show the relevant replacements. Examples:

      \obsolete Use QMetaType::Type instead
      \enum QVariant::Type
      \property QTextEdit::tabStopWidth
      \deprecated in Qt 5.10. Use tabStopDistance instead.

       

      (see http://code.qt.io/cgit/qt/qtbase.git/tree/src/corelib/kernel/qvariant.cpp#n1374, http://code.qt.io/cgit/qt/qtbase.git/tree/src/widgets/widgets/qtextedit.cpp#n1960 )

       

      However, the hints don't appear in the final documentation (see http://doc.qt.io/qt-5/qvariant-obsolete.html#Type-enumhttp://doc.qt.io/qt-5/qtextedit-obsolete.html )

       

      These comments would be helpful to developers who want to future-proof their code.

      Attachments

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

        Activity

          People

            docteam Qt Documentation Team
            jksh Sze Howe Koh
            Votes:
            1 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes