[Development] Documenting API changes in Qt Framework

[Kai Köhne]

Hi,

I've been reviewing some of the Qt 6.6 API diff's lately, focusing on the API documentation. And frankly speaking, there was (and still is) a lot to improve ...

In particular, if you are the original *reviewer of any public API change*, please check:

* Is there documentation for *new public API*, and does it mention the first Qt version the API got added to?
* Is the documentation for *newly deprecated API* reflecting this, and does it mention the first Qt version the API got deprecated in?

Here's how to add version information for _added_ API:

* Modules, classes, types, functions:  '\since 6.6'
* Enums: \value [since 6.6] XYZ

For _deprecated_ API:

* Modules, classes, types, functions: '\deprecated [6.6]'
* (deprecated enums for now have to be marked in text)

If in doubt, add someone from the Qt Documentation Team as a reviewer.

There's also the API Review before a release like it's currently ongoing for 6.6.0. There we have up-to-date documentation at https://doc-snapshots.qt.io/ which you can check. So again, if you're reviewing public API changes, please consider whether the documentation is complete and correct, and that any changes are marked for the Qt version it applies to.

Thanks for your consideration!

Regards

Kai


--
Kai Köhne, Director R&D | The Qt Company

The Qt Company GmbH, Erich-Thilo-Str. 10, D-12489 Berlin
Geschäftsführer: Mika Pälsi, Juha Varelius, Jouni Lintunen
Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B