[Development] PSA: QDoc's \deprecated command is better since Qt 6.2

Paul Wicking Paul.Wicking at qt.io
Thu Jun 17 15:39:44 CEST 2021

Hi all,

The following is a quick update from us documentation folks:

If something is deprecated, use \deprecated in documentation, not \obsolete.

QDoc now lets you record the version something is deprecated and suggest replacements with the \deprecated command. These descriptions become the first paragraph of the resulting documentation.

    \deprecated [6.2]
    \deprecated [6.2] Use QFoo() instead.
    \deprecated Use QFoo() instead.

Any such description must have proper punctuation as QDoc doesn’t inject that if it’s missing.

Happy documenting!

//! Paul

More information about the Development mailing list