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

Uses of the \compat command should be flagged with a qdoc warning

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • P3: Somewhat important
    • 5.0.0
    • None
    • Documentation
    • None
    • 28116d2ff9b62b81ddc9b487cd74dce29c9b959e

    Description

      There remain many uses of the \compat command in the C++ sources. Typically, a member function is marked with \compat in its qdoc comment, when that function is meant to be used for maintaining compatibility with Qt3. i.e., the function is part of Qt3 support. But compatibility with Qt3 is no longer supported in Qt5, so these functions should either be marked obsolete and eventually removed, or the \compat command should simply be removed. For now, qdoc will print a warning for each use of compat but continue generating the same html output for the functions marked with \compat. Developers should then decide whether to remove the function or the \compat command.

      Attachments

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

        Activity

          People

            gbk Martin Smith (Qt)
            gbk Martin Smith (Qt)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes