QDoc: Pluralize deprecation notes for shared docs
When one documentation comment covers several members and marks them
`\deprecated`, QDoc says "This function is deprecated" and advises
against using "it". The singular wording reads oddly under a list of
several signatures. This leaves readers unsure whether the notice
applies to every member in the list. The note for members scheduled
for deprecation in a later version has the same problem.
This change makes QDoc use the plural form for such comments in HTML and
DocBook output, for example "These functions are deprecated" and "using
them". This matches how QDoc words the since-version note for the
same comments. A property group keeps the singular form. It documents
one property with several parts, not several independent members.
Pick-to: 6.12
Fixes: QTBUG-151319
Change-Id: I7ad7844bc8a178d0d21622493e1838539145cc4b
Reviewed-by: Topi Reinio <topi.reinio@qt.io>
| commit | b5d1b06fdae1d5cf929c6765d9fc93f04581a69c |
| parent | ca1272cf35070bc46ad29efc9d5c131896604532 |
| author | Paul Wicking <paul.wicking@qt.io> |
| committer | Paul Wicking <paul.wicking@qt.io> |
| commit time | Fri, 9 Oct 2026 12:13:25 +0000 |
- M src/qdoc/qdoc/src/qdoc/docbookgenerator.cpp
- M src/qdoc/qdoc/src/qdoc/generator.cpp
- M src/qdoc/qdoc/tests/generatedoutput/expected_output/testqdoc-test-obsolete.html
- M src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/testqdoc-test.xml
- M src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/html/testqdoc-test-obsolete.html
- M src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject_headerdocs/expected/docbook/testqdoc-test.xml
- M src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject_headerdocs/expected/html/testqdoc-test-obsolete.html
- M src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/scopedenum/expected/docbook/testqdoc-test.xml
- M src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/scopedenum/expected/html/testqdoc-test-obsolete.html
- A src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/shared_comment_deprecation/expected/docbook/deprecations-qmlmodule.xml
- A src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/shared_comment_deprecation/expected/docbook/qml-deprecations-widget.xml
- A src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/shared_comment_deprecation/expected/html/deprecations-qmlmodule.html
- A src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/shared_comment_deprecation/expected/html/qml-deprecations-widget-members.html
- A src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/shared_comment_deprecation/expected/html/qml-deprecations-widget-obsolete.html
- A src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/shared_comment_deprecation/expected/html/qml-deprecations-widget.html
- A src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/shared_comment_deprecation/expected/html/sharedcommentdeprecation.index
- A src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/shared_comment_deprecation/shared_comment_deprecation.qdocconf
- A src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/shared_comment_deprecation/src/widget.qdoc
- M src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/testtemplate/expected/docbook/testqdoc-test.xml
- M src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/testtemplate/expected/html/testqdoc-test-obsolete.html