[Development] Marking the Tech Preview APIs as such
Giuseppe D'Angelo
giuseppe.dangelo at kdab.com
Mon Jan 22 18:41:05 CET 2024
Hi,
A number of classes and functions that are going to be introduced in 6.7
are meant to be "tech preview", and thus they may pass the header review
even if we are aware of some limitations or issues with their design.
I propose to introduce a macro, QT_TECH_PREVIEW_API (bikeshed please),
that expands to nothing/`[[qt::tech_preview_api]]`/... (moar bikeshed)
and it's used to mark APIs that are considered tech preview.
The first goal of this macro is to ensure that making an API officially
supported (and out of TP) will require changing the header, and
therefore be picked up in the next round of header reviews.
Otherwise, there is the chance that an API becomes official by simply
adjusting the documentation, and one may not notice that this has
happened during the next API review (and confirm that all the
shortcomings have been addressed).
The second goal would be for qdoc to automatically document methods and
classes marked by the macro as TP.
Ideally, this should happen for 6.7 itself, if there's still time.
Opinions?
--
Giuseppe D'Angelo | giuseppe.dangelo at kdab.com | Senior Software Engineer
KDAB (France) S.A.S., a KDAB Group company
Tel. France +33 (0)4 90 84 08 53, http://www.kdab.com
KDAB - Trusted Software Excellence
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 4244 bytes
Desc: Firma crittografica S/MIME
URL: <http://lists.qt-project.org/pipermail/development/attachments/20240122/538f3819/attachment.bin>
More information about the Development
mailing list