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

Axel Spoerl axel.spoerl at qt.io
Tue Sep 24 22:37:13 CEST 2024


Some thoughts to add:

- I can’t seem to find any pattern / rules as to when a \since tag was added in the past. Some APIs have a \since 4.x tag, some have nothing at all. Putting effort into regulating the removal of something, that has been added in an unregulated way, is totally OK if it’s a priority.

- As Christian said: The beauty is hidden in the official part of the documentation.

- It’s of course visible in cpp files. If I have my hands on C++, I tend to believe more in git blame’s version of the gospel.

I don’t feel strong for either side.
I really welcome the discussion!
I have approved removal commits in the past, based on the considerations mentioned above. Totally happy to revert those, if that’ll be the consensus.

> On 24 Sep 2024, at 19:27, Christian Ehrlicher via Development <development at qt-project.org> wrote:
> 
> 
> 
> 
> 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.
> 
> 
> Christian
> 
> 
> 
> --
> Development mailing list
> Development at qt-project.org
> https://lists.qt-project.org/listinfo/development


More information about the Development mailing list