diff options
author | Topi Reinio <topi.reinio@qt.io> | 2020-08-01 00:33:49 +0200 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2020-08-28 11:37:35 +0200 |
commit | 239982901beaf039c25b264a9c6b63aa6fe70710 (patch) | |
tree | 8513201e0e2983bb819d99ac2bfaa2a0c7d18d91 /src/gui/image | |
parent | 00a1e5da7e1aea373a7e6be1d51e1573ff167dd8 (diff) |
Doc: Fix documentation warnings for Qt GUI
* Drop deprecation warnings for now-dropped items
* Use the 'qt6' define and a new \nothing doc macro to conditionally
document items on Qt 6
* Add a custom module header for docs that pulls in also Vulkan headers
* Add \internal command for internal classes/functions
* Move QtGUI-related code snippets from widgets to gui docs
Change-Id: Ieb386b96631a49568d09059906d307c45c01d93a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/gui/image')
-rw-r--r-- | src/gui/image/qimage.cpp | 4 | ||||
-rw-r--r-- | src/gui/image/qimage.h | 3 | ||||
-rw-r--r-- | src/gui/image/qimageiohandler.cpp | 2 | ||||
-rw-r--r-- | src/gui/image/qpicture.cpp | 6 | ||||
-rw-r--r-- | src/gui/image/qpixmap_win.cpp | 2 |
5 files changed, 7 insertions, 10 deletions
diff --git a/src/gui/image/qimage.cpp b/src/gui/image/qimage.cpp index 708f9f3146..15233d0989 100644 --- a/src/gui/image/qimage.cpp +++ b/src/gui/image/qimage.cpp @@ -1476,7 +1476,7 @@ void QImage::setDevicePixelRatio(qreal scaleFactor) \since 5.10 Returns the image data size in bytes. - \sa byteCount(), bytesPerLine(), bits(), {QImage#Image Information}{Image + \sa bytesPerLine(), bits(), {QImage#Image Information}{Image Information} */ qsizetype QImage::sizeInBytes() const @@ -4278,7 +4278,7 @@ bool QImage::isDetached() const The operation is similar to painting \a alphaChannel as an alpha image over this image using \c QPainter::CompositionMode_DestinationIn. - \sa hasAlphaChannel(), alphaChannel(), + \sa hasAlphaChannel(), {QImage#Image Transformations}{Image Transformations}, {QImage#Image Formats}{Image Formats} */ diff --git a/src/gui/image/qimage.h b/src/gui/image/qimage.h index 2743ed285a..1d4ee3168f 100644 --- a/src/gui/image/qimage.h +++ b/src/gui/image/qimage.h @@ -298,7 +298,8 @@ public: // Platform specific conversion functions #if defined(Q_OS_DARWIN) || defined(Q_QDOC) CGImageRef toCGImage() const Q_DECL_CF_RETURNS_RETAINED; -#elif defined(Q_OS_WIN) || defined(Q_QDOC) +#endif +#if defined(Q_OS_WIN) || defined(Q_QDOC) HBITMAP toHBITMAP() const; HICON toHICON(const QImage &mask = {}) const; static QImage fromHBITMAP(HBITMAP hbitmap); diff --git a/src/gui/image/qimageiohandler.cpp b/src/gui/image/qimageiohandler.cpp index 45c5891ccd..96dfa8d670 100644 --- a/src/gui/image/qimageiohandler.cpp +++ b/src/gui/image/qimageiohandler.cpp @@ -170,8 +170,10 @@ the transformation metadata of an image. A handler that supports this option should not apply the transformation itself. +\if !defined(qt6) \value TransformedByDefault. A handler that reports support for this feature will have image transformation metadata applied by default on read. +\endif */ /*! \enum QImageIOHandler::Transformation diff --git a/src/gui/image/qpicture.cpp b/src/gui/image/qpicture.cpp index e46d0ab16b..77f3e7ffc8 100644 --- a/src/gui/image/qpicture.cpp +++ b/src/gui/image/qpicture.cpp @@ -257,9 +257,6 @@ void QPicture::setData(const char* data, uint size) Loads a picture from the file specified by \a fileName and returns true if successful; otherwise invalidates the picture and returns \c false. - Please note that the \a format parameter has been deprecated and - will have no effect. - \sa save() */ @@ -292,9 +289,6 @@ bool QPicture::load(QIODevice *dev) Saves a picture to the file specified by \a fileName and returns true if successful; otherwise returns \c false. - Please note that the \a format parameter has been deprecated and - will have no effect. - \sa load() */ diff --git a/src/gui/image/qpixmap_win.cpp b/src/gui/image/qpixmap_win.cpp index f9b4f600e2..cd7a8ca80e 100644 --- a/src/gui/image/qpixmap_win.cpp +++ b/src/gui/image/qpixmap_win.cpp @@ -493,7 +493,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 bitmap. + Returns a QImage that is equivalent to the given \a hbitmap. HBITMAP does not store information about the alpha channel. |