1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

QImage: fix documentation of toCGImage

Browse Source 
Remove the \brief section, which qdoc doesn't support for functions.
Explicitly use \fn to link the documentation, as qdoc doesn't always see
the declaration.

This makes the function not only public, but also documented API,
similar to QImage::toHBITMAP and toHICON. In practice, this is what
was intended, so fixing this in stable branches as well.

Pick-to: 6.8 6.5
Change-Id: Id825e494d13f10064742318d2b3bbd8f8f7a1435
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
This commit is contained in:
Volker Hilsheimer 2024-10-22 12:01:36 +02:00
parent e7c8c2ccc8
commit 26375032c9
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/gui/image/qimage_darwin.mm
View File

@ -12,9 +12,10 @@
QT_BEGIN_NAMESPACE
/*!
\brief Creates a \c CGImage equivalent to this QImage.
\fn CGImageRef QImage::toCGImage() const
Returns a \c CGImageRef handle.
Creates a \c CGImage equivalent to this QImage, and returns a \c CGImageRef
handle.
The returned CGImageRef partakes in the QImage implicit sharing,
and holds a reference to the QImage data. CGImage is immutable