summaryrefslogtreecommitdiffstats
path: root/src/gui
diff options
context:
space:
mode:
authorTor Arne Vestbø <tor.arne.vestbo@qt.io>2020-10-07 15:02:18 +0200
committerTor Arne Vestbø <tor.arne.vestbo@qt.io>2020-10-13 10:44:02 +0200
commit12ef5a7344da486f1e4601bf7c917caa69667f7f (patch)
tree67eede5b9e8ad23719ce5d5e42097c3e24925e84 /src/gui
parentf8076d6a5be7d833bd81f4a7a66177ccd25b5fca (diff)
doc: Add brief and group for native type conversions
Change-Id: I74608619201bf77e487fb986bf213b349cc22f6a Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/gui')
-rw-r--r--src/gui/image/qimage_darwin.mm7
-rw-r--r--src/gui/image/qpixmap_win.cpp23
2 files changed, 22 insertions, 8 deletions
diff --git a/src/gui/image/qimage_darwin.mm b/src/gui/image/qimage_darwin.mm
index 7ca1a0869a..83b6cef980 100644
--- a/src/gui/image/qimage_darwin.mm
+++ b/src/gui/image/qimage_darwin.mm
@@ -48,8 +48,9 @@
QT_BEGIN_NAMESPACE
/*!
- Creates a \c CGImage equivalent to this QImage. Returns a
- \c CGImageRef handle.
+ \brief Creates a \c CGImage equivalent to this QImage.
+
+ 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
@@ -92,6 +93,8 @@ QT_BEGIN_NAMESPACE
The CGImageRef color space is set to the sRGB color space.
+ \ingroup platform-type-conversions
+
\sa QtMac::toNSImage()
*/
CGImageRef QImage::toCGImage() const
diff --git a/src/gui/image/qpixmap_win.cpp b/src/gui/image/qpixmap_win.cpp
index cd7a8ca80e..aae4a1cbf4 100644
--- a/src/gui/image/qpixmap_win.cpp
+++ b/src/gui/image/qpixmap_win.cpp
@@ -352,8 +352,9 @@ Q_GUI_EXPORT HBITMAP qt_imageToWinHBITMAP(const QImage &imageIn, int hbitmapForm
/*!
\since 6.0
- Creates a \c HBITMAP equivalent of the QImage. Returns the \c HBITMAP
- handle.
+ \brief Creates a \c HBITMAP equivalent of the QImage.
+
+ Returns the \c HBITMAP handle.
It is the caller's responsibility to free the \c HBITMAP data
after use.
@@ -368,6 +369,8 @@ Q_GUI_EXPORT HBITMAP qt_imageToWinHBITMAP(const QImage &imageIn, int hbitmapForm
When using the resulting HBITMAP as application icon or a systray icon,
the image should have the format QImage::Format_ARGB32.
+ \ingroup platform-type-conversions
+
\sa fromHBITMAP(), convertToFormat()
*/
HBITMAP QImage::toHBITMAP() const
@@ -493,7 +496,7 @@ Q_GUI_EXPORT QImage qt_imageFromWinHBITMAP(HBITMAP bitmap, int hbitmapFormat = 0
/*!
\since 6.0
- Returns a QImage that is equivalent to the given \a hbitmap.
+ \brief Returns a QImage that is equivalent to the given \a hbitmap.
HBITMAP does not store information about the alpha channel.
@@ -505,6 +508,8 @@ Q_GUI_EXPORT QImage qt_imageFromWinHBITMAP(HBITMAP bitmap, int hbitmapFormat = 0
\c reinterpretAsFormat(QImage::Format_ARGB32) should be called
on the returned image to ensure the format is correct.
+ \ingroup platform-type-conversions
+
\sa toHBITMAP(), reinterpretAsFormat()
*/
QImage QImage::fromHBITMAP(HBITMAP hbitmap)
@@ -520,12 +525,16 @@ Q_GUI_EXPORT QPixmap qt_pixmapFromWinHBITMAP(HBITMAP bitmap, int hbitmapFormat =
/*!
\since 6.0
- Creates a \c HICON equivalent of the QPixmap, applying the mask
- \a mask. If \a mask is not null, it needs to be of format QImage::Format_Mono.
+ \brief Creates a \c HICON equivalent of the QPixmap, applying the mask
+ \a mask.
+
+ If \a mask is not null, it needs to be of format QImage::Format_Mono.
Returns the \c HICON handle.
It is the caller's responsibility to free the \c HICON data after use.
+ \ingroup platform-type-conversions
+
\sa fromHICON()
*/
HICON QImage::toHICON(const QImage &mask) const
@@ -609,7 +618,9 @@ static inline bool hasAlpha(const QImage &image)
/*!
\since 6.0
- Returns a QImage that is equivalent to the given \a icon.
+ \brief Returns a QImage that is equivalent to the given \a icon.
+
+ \ingroup platform-type-conversions
\sa toHICON()
*/