[Development] On Removing Public Undocumented/\internal APIs

Thiago Macieira thiago.macieira at intel.com
Thu Jul 10 15:22:50 CEST 2025


On Thursday, 10 July 2025 06:01:25 Pacific Daylight Time Fabian Kosmale via 
Development wrote:
> I really don't like "undocumented API can change", especially not for
> members. Using such a member is one tab completion away
> 
> I'm willing to make some amends (function which can't be used without
> also using private API, like a function taking an instance of a private
> class), but I think the general guide line should IMHO be: Use the
> normal deprecation workflow for them.

The interesting thing about this case is that it is both.

QArrayData and QTypedArrayData are not documented, but are otherwise public 
classes. I wouldn't be surprised if someone found them and decided to use 
them, or QADP, for the very purpose they were created. Manipulating the 
reference count may be uncommon, but it might happen.

And yet the use inside of Qt Creator got to a QString's QArrayData through a 
clearly-marked private API.

-- 
Thiago Macieira - thiago.macieira (AT) intel.com
  Principal Engineer - Intel Platform & System Engineering
-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 5150 bytes
Desc: not available
URL: <http://lists.qt-project.org/pipermail/development/attachments/20250710/d771cc45/attachment.bin>


More information about the Development mailing list