diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-01 15:28:31 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-02 23:16:25 +0100 |
commit | 95d83cb1b68cc4a415d5d80859b4e74472ad7112 (patch) | |
tree | 9f6fa892ee78f584224320a195f03419c0fdbc21 /src/gui/image | |
parent | 15e136d4e116c1513c106dfbb75e1953a7f3463c (diff) |
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold
and list items. This change applies that change in QDoc to the
actual documentation.
Task-number: QTBUG-24578
Change-Id: I519bf9c29b14092e3ab6067612f42bf749eeedf5
Reviewed-by: Shane Kearns <shane.kearns@accenture.com>
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
Diffstat (limited to 'src/gui/image')
-rw-r--r-- | src/gui/image/qimage.cpp | 84 | ||||
-rw-r--r-- | src/gui/image/qimagereader.cpp | 34 | ||||
-rw-r--r-- | src/gui/image/qimagewriter.cpp | 16 | ||||
-rw-r--r-- | src/gui/image/qpixmap.cpp | 42 |
4 files changed, 88 insertions, 88 deletions
diff --git a/src/gui/image/qimage.cpp b/src/gui/image/qimage.cpp index 5b23dbf4dc..6ce08d93cc 100644 --- a/src/gui/image/qimage.cpp +++ b/src/gui/image/qimage.cpp @@ -327,17 +327,17 @@ bool QImageData::checkForAlphaPixels() const formats: \table - \header \o Format \o Description \o Qt's support - \row \o BMP \o Windows Bitmap \o Read/write - \row \o GIF \o Graphic Interchange Format (optional) \o Read - \row \o JPG \o Joint Photographic Experts Group \o Read/write - \row \o JPEG \o Joint Photographic Experts Group \o Read/write - \row \o PNG \o Portable Network Graphics \o Read/write - \row \o PBM \o Portable Bitmap \o Read - \row \o PGM \o Portable Graymap \o Read - \row \o PPM \o Portable Pixmap \o Read/write - \row \o XBM \o X11 Bitmap \o Read/write - \row \o XPM \o X11 Pixmap \o Read/write + \header \li Format \li Description \li Qt's support + \row \li BMP \li Windows Bitmap \li Read/write + \row \li GIF \li Graphic Interchange Format (optional) \li Read + \row \li JPG \li Joint Photographic Experts Group \li Read/write + \row \li JPEG \li Joint Photographic Experts Group \li Read/write + \row \li PNG \li Portable Network Graphics \li Read/write + \row \li PBM \li Portable Bitmap \li Read + \row \li PGM \li Portable Graymap \li Read + \row \li PPM \li Portable Pixmap \li Read/write + \row \li XBM \li X11 Bitmap \li Read/write + \row \li XPM \li X11 Pixmap \li Read/write \endtable \section1 Image Information @@ -347,11 +347,11 @@ bool QImageData::checkForAlphaPixels() const \table \header - \o \o Available Functions + \li \li Available Functions \row - \o Geometry - \o + \li Geometry + \li The size(), width(), height(), dotsPerMeterX(), and dotsPerMeterY() functions provide information about the image size @@ -365,8 +365,8 @@ bool QImageData::checkForAlphaPixels() const setOffset() function. \row - \o Colors - \o + \li Colors + \li The color of a pixel can be retrieved by passing its coordinates to the pixel() function. The pixel() function returns the color @@ -392,8 +392,8 @@ bool QImageData::checkForAlphaPixels() const sections. \row - \o Text - \o + \li Text + \li The text() function returns the image text associated with the given text key. An image's text keys can be retrieved using the @@ -401,8 +401,8 @@ bool QImageData::checkForAlphaPixels() const image's text. \row - \o Low-level information - \o + \li Low-level information + \li The depth() function returns the depth of the image. The supported depths are 1 (monochrome), 8, 16, 24 and 32 bits. The @@ -434,10 +434,10 @@ bool QImageData::checkForAlphaPixels() const \table \header - \o {2,1}32-bit + \li {2,1}32-bit \row - \o \inlineimage qimage-32bit_scaled.png - \o + \li \inlineimage qimage-32bit_scaled.png + \li \snippet doc/src/snippets/code/src_gui_image_qimage.cpp 0 \endtable @@ -455,10 +455,10 @@ bool QImageData::checkForAlphaPixels() const \table \header - \o {2,1} 8-bit + \li {2,1} 8-bit \row - \o \inlineimage qimage-8bit_scaled.png - \o + \li \inlineimage qimage-8bit_scaled.png + \li \snippet doc/src/snippets/code/src_gui_image_qimage.cpp 1 \endtable @@ -529,28 +529,28 @@ bool QImageData::checkForAlphaPixels() const in-place: \table - \header \o Function \o Description + \header \li Function \li Description \row - \o setDotsPerMeterX() - \o Defines the aspect ratio by setting the number of pixels that fit + \li setDotsPerMeterX() + \li Defines the aspect ratio by setting the number of pixels that fit horizontally in a physical meter. \row - \o setDotsPerMeterY() - \o Defines the aspect ratio by setting the number of pixels that fit + \li setDotsPerMeterY() + \li Defines the aspect ratio by setting the number of pixels that fit vertically in a physical meter. \row - \o fill() - \o Fills the entire image with the given pixel value. + \li fill() + \li Fills the entire image with the given pixel value. \row - \o invertPixels() - \o Inverts all pixel values in the image using the given InvertMode value. + \li invertPixels() + \li Inverts all pixel values in the image using the given InvertMode value. \row - \o setColorTable() - \o Sets the color table used to translate color indexes. Only + \li setColorTable() + \li Sets the color table used to translate color indexes. Only monochrome and 8-bit formats. \row - \o setColorCount() - \o Resizes the color table. Only monochrome and 8-bit formats. + \li setColorCount() + \li Resizes the color table. Only monochrome and 8-bit formats. \endtable @@ -3794,11 +3794,11 @@ bool QImage::isGrayscale() const \image qimage-scaling.png \list - \i If \a aspectRatioMode is Qt::IgnoreAspectRatio, the image + \li If \a aspectRatioMode is Qt::IgnoreAspectRatio, the image is scaled to \a size. - \i If \a aspectRatioMode is Qt::KeepAspectRatio, the image is + \li If \a aspectRatioMode is Qt::KeepAspectRatio, the image is scaled to a rectangle as large as possible inside \a size, preserving the aspect ratio. - \i If \a aspectRatioMode is Qt::KeepAspectRatioByExpanding, + \li If \a aspectRatioMode is Qt::KeepAspectRatioByExpanding, the image is scaled to a rectangle as small as possible outside \a size, preserving the aspect ratio. \endlist diff --git a/src/gui/image/qimagereader.cpp b/src/gui/image/qimagereader.cpp index 4a9a9b00f4..870784f638 100644 --- a/src/gui/image/qimagereader.cpp +++ b/src/gui/image/qimagereader.cpp @@ -703,22 +703,22 @@ QByteArray QImageReader::format() const \list - \o Image plugins are queried first, based on either the optional format + \li Image plugins are queried first, based on either the optional format string, or the file name suffix (if the source device is a file). No content detection is done at this stage. QImageReader will choose the first plugin that supports reading for this format. - \o If no plugin supports the image format, Qt's built-in handlers are + \li If no plugin supports the image format, Qt's built-in handlers are checked based on either the optional format string, or the file name suffix. - \o If no capable plugins or built-in handlers are found, each plugin is + \li If no capable plugins or built-in handlers are found, each plugin is tested by inspecting the content of the data stream. - \o If no plugins could detect the image format based on data contents, + \li If no plugins could detect the image format based on data contents, each built-in image handler is tested by inspecting the contents. - \o Finally, if all above approaches fail, QImageReader will report failure + \li Finally, if all above approaches fail, QImageReader will report failure when trying to read the image. \endlist @@ -1423,18 +1423,18 @@ QByteArray QImageReader::imageFormat(QIODevice *device) By default, Qt can read the following formats: \table - \header \o Format \o Description - \row \o BMP \o Windows Bitmap - \row \o GIF \o Graphic Interchange Format (optional) - \row \o JPG \o Joint Photographic Experts Group - \row \o JPEG \o Joint Photographic Experts Group - \row \o PNG \o Portable Network Graphics - \row \o PBM \o Portable Bitmap - \row \o PGM \o Portable Graymap - \row \o PPM \o Portable Pixmap - \row \o XBM \o X11 Bitmap - \row \o XPM \o X11 Pixmap - \row \o SVG \o Scalable Vector Graphics + \header \li Format \li Description + \row \li BMP \li Windows Bitmap + \row \li GIF \li Graphic Interchange Format (optional) + \row \li JPG \li Joint Photographic Experts Group + \row \li JPEG \li Joint Photographic Experts Group + \row \li PNG \li Portable Network Graphics + \row \li PBM \li Portable Bitmap + \row \li PGM \li Portable Graymap + \row \li PPM \li Portable Pixmap + \row \li XBM \li X11 Bitmap + \row \li XPM \li X11 Pixmap + \row \li SVG \li Scalable Vector Graphics \endtable Reading and writing SVG files is supported through Qt's diff --git a/src/gui/image/qimagewriter.cpp b/src/gui/image/qimagewriter.cpp index 966017452c..8395f9d216 100644 --- a/src/gui/image/qimagewriter.cpp +++ b/src/gui/image/qimagewriter.cpp @@ -653,14 +653,14 @@ bool QImageWriter::supportsOption(QImageIOHandler::ImageOption option) const By default, Qt can write the following formats: \table - \header \o Format \o Description - \row \o BMP \o Windows Bitmap - \row \o JPG \o Joint Photographic Experts Group - \row \o JPEG \o Joint Photographic Experts Group - \row \o PNG \o Portable Network Graphics - \row \o PPM \o Portable Pixmap - \row \o XBM \o X11 Bitmap - \row \o XPM \o X11 Pixmap + \header \li Format \li Description + \row \li BMP \li Windows Bitmap + \row \li JPG \li Joint Photographic Experts Group + \row \li JPEG \li Joint Photographic Experts Group + \row \li PNG \li Portable Network Graphics + \row \li PPM \li Portable Pixmap + \row \li XBM \li X11 Bitmap + \row \li XPM \li X11 Pixmap \endtable Reading and writing SVG files is supported through Qt's diff --git a/src/gui/image/qpixmap.cpp b/src/gui/image/qpixmap.cpp index e8c1304b74..504f583baf 100644 --- a/src/gui/image/qpixmap.cpp +++ b/src/gui/image/qpixmap.cpp @@ -1052,11 +1052,11 @@ bool QPixmap::convertFromImage(const QImage &image, Qt::ImageConversionFlags fla \image qimage-scaling.png \list - \i If \a aspectRatioMode is Qt::IgnoreAspectRatio, the pixmap + \li If \a aspectRatioMode is Qt::IgnoreAspectRatio, the pixmap is scaled to \a size. - \i If \a aspectRatioMode is Qt::KeepAspectRatio, the pixmap is + \li If \a aspectRatioMode is Qt::KeepAspectRatio, the pixmap is scaled to a rectangle as large as possible inside \a size, preserving the aspect ratio. - \i If \a aspectRatioMode is Qt::KeepAspectRatioByExpanding, + \li If \a aspectRatioMode is Qt::KeepAspectRatioByExpanding, the pixmap is scaled to a rectangle as small as possible outside \a size, preserving the aspect ratio. \endlist @@ -1273,17 +1273,17 @@ QPixmap QPixmap::transformed(const QMatrix &matrix, Qt::TransformationMode mode) formats: \table - \header \o Format \o Description \o Qt's support - \row \o BMP \o Windows Bitmap \o Read/write - \row \o GIF \o Graphic Interchange Format (optional) \o Read - \row \o JPG \o Joint Photographic Experts Group \o Read/write - \row \o JPEG \o Joint Photographic Experts Group \o Read/write - \row \o PNG \o Portable Network Graphics \o Read/write - \row \o PBM \o Portable Bitmap \o Read - \row \o PGM \o Portable Graymap \o Read - \row \o PPM \o Portable Pixmap \o Read/write - \row \o XBM \o X11 Bitmap \o Read/write - \row \o XPM \o X11 Pixmap \o Read/write + \header \li Format \li Description \li Qt's support + \row \li BMP \li Windows Bitmap \li Read/write + \row \li GIF \li Graphic Interchange Format (optional) \li Read + \row \li JPG \li Joint Photographic Experts Group \li Read/write + \row \li JPEG \li Joint Photographic Experts Group \li Read/write + \row \li PNG \li Portable Network Graphics \li Read/write + \row \li PBM \li Portable Bitmap \li Read + \row \li PGM \li Portable Graymap \li Read + \row \li PPM \li Portable Pixmap \li Read/write + \row \li XBM \li X11 Bitmap \li Read/write + \row \li XPM \li X11 Pixmap \li Read/write \endtable \section1 Pixmap Information @@ -1293,17 +1293,17 @@ QPixmap QPixmap::transformed(const QMatrix &matrix, Qt::TransformationMode mode) \table \header - \o \o Available Functions + \li \li Available Functions \row - \o Geometry - \o + \li Geometry + \li The size(), width() and height() functions provide information about the pixmap's size. The rect() function returns the image's enclosing rectangle. \row - \o Alpha component - \o + \li Alpha component + \li The hasAlphaChannel() returns true if the pixmap has a format that respects the alpha channel, otherwise returns false. The hasAlpha(), @@ -1318,8 +1318,8 @@ QPixmap QPixmap::transformed(const QMatrix &matrix, Qt::TransformationMode mode) QBitmap) for the pixmap based on a given color. \row - \o Low-level information - \o + \li Low-level information + \li The depth() function returns the depth of the pixmap. The defaultDepth() function returns the default depth, i.e. the depth |