[Development] Proposal to retain \since version information in Qt Documentation

[Mathias Hasselmann]

Am 24.09.2024 um 19:24 schrieb Christian Ehrlicher via Development:
>
>
>
> Am 24.09.2024 um 15:12 schrieb Paul Wicking via Development:
>> Dear Qt Developers,
>>
>> I am writing to address a series of recent code review changes that propose
>> removing the `\since [version]` documentation strings from various modules in
>> Qt:
> ...
>> By making these adjustments, we can ensure that our documentation remains a
>> comprehensive resource for all developers—whether they're maintaining legacy
>> systems, planning migrations, or simply seeking to understand the evolution of
>> Qt.
> You're aware that noone will see those \since tags in any 
> documentation except he builds it by himself (which even I did not 
> manage until now for unknown reasons - maybe because I try to build 
> the documentation for qtbase only - don't know) and also needs to 
> modify config.qdocconf before?
> So basically we're leaving in code which is ifdef'd out aka dead code.
> Maybe we should focus on improving the documentation instead 
> discussing if (or if not) we remove dead code added 20 years ago.

Hello Christian,

maybe I fail to understand what exactly you are refering to. If we both 
are talking about comments like "\since 4.8" for `QRegExp::swap()` then 
you are wrong. This comment definitely becomes "This function was 
introduced in Qt 4.8." in the documenation provided by the official 
installers. If this should not work consistency this seems like a bug in 
Qt's documentation tools.

Ciao
Mathias
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.qt-project.org/pipermail/development/attachments/20240925/aea3f115/attachment-0001.htm>