From 26375032c92b8729ca5625c225e99a696d7b6b9e Mon Sep 17 00:00:00 2001 From: Volker Hilsheimer Date: Tue, 22 Oct 2024 12:01:36 +0200 Subject: [PATCH] QImage: fix documentation of toCGImage MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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ø --- src/gui/image/qimage_darwin.mm | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/gui/image/qimage_darwin.mm b/src/gui/image/qimage_darwin.mm index 3744da2e328..049fbb3a60a 100644 --- a/src/gui/image/qimage_darwin.mm +++ b/src/gui/image/qimage_darwin.mm @@ -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