From 4533cc994484a2308297e64e99af005fb4dca065 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 2 Oct 2013 16:51:05 +0200 Subject: Doc: Adding mark-up to boolean default values. Default values should have mark-up to denote that they are code. This commit changes: -"property is true" to "property is \c true". -"Returns true" to "Returns \c true". -"property is false" to "property is \c false". -"returns true" to "returns \c true". -"returns false" to "returns \c false". src/3rdparty and non-documentation instances were ignored. Task-number: QTBUG-33360 Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e Reviewed-by: Oswald Buddenhagen Reviewed-by: Jerome Pasion --- src/gui/image/qicon.cpp | 6 ++--- src/gui/image/qiconengine.cpp | 4 ++-- src/gui/image/qimage.cpp | 42 +++++++++++++++++----------------- src/gui/image/qimageiohandler.cpp | 24 +++++++++---------- src/gui/image/qimagereader.cpp | 18 +++++++-------- src/gui/image/qimagewriter.cpp | 8 +++---- src/gui/image/qmovie.cpp | 10 ++++---- src/gui/image/qpicture.cpp | 18 +++++++-------- src/gui/image/qpictureformatplugin.cpp | 8 +++---- src/gui/image/qpixmap.cpp | 34 +++++++++++++-------------- src/gui/image/qpixmapcache.cpp | 16 ++++++------- 11 files changed, 94 insertions(+), 94 deletions(-) (limited to 'src/gui/image') diff --git a/src/gui/image/qicon.cpp b/src/gui/image/qicon.cpp index 5a37a8fecf..c1a8cfaa1e 100644 --- a/src/gui/image/qicon.cpp +++ b/src/gui/image/qicon.cpp @@ -859,7 +859,7 @@ void QIcon::paint(QPainter *painter, const QRect &rect, Qt::Alignment alignment, */ /*! - Returns true if the icon is empty; otherwise returns false. + Returns \c true if the icon is empty; otherwise returns \c false. An icon is empty if it has neither a pixmap nor a filename. @@ -1136,8 +1136,8 @@ QIcon QIcon::fromTheme(const QString &name, const QIcon &fallback) /*! \since 4.6 - Returns true if there is an icon available for \a name in the - current icon theme, otherwise returns false. + Returns \c true if there is an icon available for \a name in the + current icon theme, otherwise returns \c false. \sa themeSearchPaths(), fromTheme(), setThemeName() */ diff --git a/src/gui/image/qiconengine.cpp b/src/gui/image/qiconengine.cpp index 6bb1589621..ce52b9fcf1 100644 --- a/src/gui/image/qiconengine.cpp +++ b/src/gui/image/qiconengine.cpp @@ -205,7 +205,7 @@ QString QIconEngine::key() const /*! Reads icon engine contents from the QDataStream \a in. Returns - true if the contents were read; otherwise returns false. + true if the contents were read; otherwise returns \c false. QIconEngine's default implementation always return false. */ @@ -216,7 +216,7 @@ bool QIconEngine::read(QDataStream &) /*! Writes the contents of this engine to the QDataStream \a out. - Returns true if the contents were written; otherwise returns false. + Returns \c true if the contents were written; otherwise returns \c false. QIconEngine's default implementation always return false. */ diff --git a/src/gui/image/qimage.cpp b/src/gui/image/qimage.cpp index 28af8adf9c..234742e6b9 100644 --- a/src/gui/image/qimage.cpp +++ b/src/gui/image/qimage.cpp @@ -1264,7 +1264,7 @@ QImage QImage::copy(const QRect& r) const /*! \fn bool QImage::isNull() const - Returns true if it is a null image, otherwise returns false. + Returns \c true if it is a null image, otherwise returns \c false. A null image has all parameters set to zero and no allocated data. */ @@ -4140,8 +4140,8 @@ QImage QImage::convertToFormat(Format format, const QVector &colorTable, Q /*! \fn bool QImage::valid(const QPoint &pos) const - Returns true if \a pos is a valid coordinate pair within the - image; otherwise returns false. + Returns \c true if \a pos is a valid coordinate pair within the + image; otherwise returns \c false. \sa rect(), QRect::contains() */ @@ -4149,8 +4149,8 @@ QImage QImage::convertToFormat(Format format, const QVector &colorTable, Q /*! \overload - Returns true if QPoint(\a x, \a y) is a valid coordinate pair - within the image; otherwise returns false. + Returns \c true if QPoint(\a x, \a y) is a valid coordinate pair + within the image; otherwise returns \c false. */ bool QImage::valid(int x, int y) const { @@ -4343,7 +4343,7 @@ void QImage::setPixel(int x, int y, uint index_or_rgb) } /*! - Returns true if all the colors in the image are shades of gray + Returns \c true if all the colors in the image are shades of gray (i.e. their red, green and blue components are equal); otherwise false. @@ -4418,9 +4418,9 @@ bool QImage::allGray() const /*! For 32-bit images, this function is equivalent to allGray(). - For 8-bpp images, this function returns true if color(i) is + For 8-bpp images, this function returns \c true if color(i) is QRgb(i, i, i) for all indexes of the color table; otherwise - returns false. + returns \c false. \sa allGray(), {QImage#Image Formats}{Image Formats} */ @@ -5018,9 +5018,9 @@ QImage QImage::rgbSwapped() const } /*! - Loads an image from the file with the given \a fileName. Returns true if + Loads an image from the file with the given \a fileName. Returns \c true if the image was successfully loaded; otherwise invalidates the image - and returns false. + and returns \c false. The loader attempts to read the image using the specified \a format, e.g., PNG or JPG. If \a format is not specified (which is the default), the @@ -5060,8 +5060,8 @@ bool QImage::load(QIODevice* device, const char* format) \fn bool QImage::loadFromData(const uchar *data, int len, const char *format) Loads an image from the first \a len bytes of the given binary \a - data. Returns true if the image was successfully loaded; otherwise - invalidates the image and returns false. + data. Returns \c true if the image was successfully loaded; otherwise + invalidates the image and returns \c false. The loader attempts to read the image using the specified \a format, e.g., PNG or JPG. If \a format is not specified (which is the default), the @@ -5132,8 +5132,8 @@ QImage QImage::fromData(const uchar *data, int size, const char *format) 0 to obtain small compressed files, 100 for large uncompressed files, and -1 (the default) to use the default settings. - Returns true if the image was successfully saved; otherwise - returns false. + Returns \c true if the image was successfully saved; otherwise + returns \c false. \sa {QImage#Reading and Writing Image Files}{Reading and Writing Image Files} @@ -5238,8 +5238,8 @@ QDataStream &operator>>(QDataStream &s, QImage &image) /*! \fn bool QImage::operator==(const QImage & image) const - Returns true if this image and the given \a image have the same - contents; otherwise returns false. + Returns \c true if this image and the given \a image have the same + contents; otherwise returns \c false. The comparison can be slow, unless there is some obvious difference (e.g. different size or format), in which case the @@ -5303,8 +5303,8 @@ bool QImage::operator==(const QImage & i) const /*! \fn bool QImage::operator!=(const QImage & image) const - Returns true if this image and the given \a image have different - contents; otherwise returns false. + Returns \c true if this image and the given \a image have different + contents; otherwise returns \c false. The comparison can be slow, unless there is some obvious difference, such as different widths, in which case the function @@ -5835,7 +5835,7 @@ qint64 QImage::cacheKey() const /*! \internal - Returns true if the image is detached; otherwise returns false. + Returns \c true if the image is detached; otherwise returns \c false. \sa detach(), {Implicit Data Sharing} */ @@ -6021,8 +6021,8 @@ QImage QImage::alphaChannel() const } /*! - Returns true if the image has a format that respects the alpha - channel, otherwise returns false. + Returns \c true if the image has a format that respects the alpha + channel, otherwise returns \c false. \sa {QImage#Image Information}{Image Information} */ diff --git a/src/gui/image/qimageiohandler.cpp b/src/gui/image/qimageiohandler.cpp index 055ace9985..04e3213c53 100644 --- a/src/gui/image/qimageiohandler.cpp +++ b/src/gui/image/qimageiohandler.cpp @@ -52,7 +52,7 @@ Call setDevice() to assign a device to the handler, and setFormat() to assign a format to it. One QImageIOHandler may - support more than one image format. canRead() returns true if an + support more than one image format. canRead() returns \c true if an image can be read from the device, and read() and write() return true if reading or writing an image was completed successfully. @@ -342,7 +342,7 @@ QByteArray QImageIOHandler::format() const \fn bool QImageIOHandler::read(QImage *image) Read an image from the device, and stores it in \a image. - Returns true if the image is successfully read; otherwise returns + Returns \c true if the image is successfully read; otherwise returns false. For image formats that support incremental loading, and for animation @@ -355,10 +355,10 @@ QByteArray QImageIOHandler::format() const /*! \fn bool QImageIOHandler::canRead() const - Returns true if an image can be read from the device (i.e., the + Returns \c true if an image can be read from the device (i.e., the image format is supported, the device can be read from and the initial header information suggests that the image can be read); - otherwise returns false. + otherwise returns \c false. When reimplementing canRead(), make sure that the I/O device (device()) is left in its original state (e.g., by using peek() @@ -379,10 +379,10 @@ QByteArray QImageIOHandler::name() const } /*! - Writes the image \a image to the assigned device. Returns true on - success; otherwise returns false. + Writes the image \a image to the assigned device. Returns \c true on + success; otherwise returns \c false. - The default implementation does nothing, and simply returns false. + The default implementation does nothing, and simply returns \c false. */ bool QImageIOHandler::write(const QImage &image) { @@ -415,8 +415,8 @@ QVariant QImageIOHandler::option(ImageOption option) const } /*! - Returns true if the QImageIOHandler supports the option \a option; - otherwise returns false. For example, if the QImageIOHandler + Returns \c true if the QImageIOHandler supports the option \a option; + otherwise returns \c false. For example, if the QImageIOHandler supports the \l Size option, supportsOption(Size) must return true. @@ -461,7 +461,7 @@ QRect QImageIOHandler::currentImageRect() const not support animation, or if it is unable to determine the number of images, 0 is returned. - The default implementation returns 1 if canRead() returns true; + The default implementation returns 1 if canRead() returns \c true; otherwise 0 is returned. */ int QImageIOHandler::imageCount() const @@ -473,7 +473,7 @@ int QImageIOHandler::imageCount() const For image formats that support animation, this function jumps to the next image. - The default implementation does nothing, and returns false. + The default implementation does nothing, and returns \c false. */ bool QImageIOHandler::jumpToNextImage() { @@ -485,7 +485,7 @@ bool QImageIOHandler::jumpToNextImage() whose sequence number is \a imageNumber. The next call to read() will attempt to read this image. - The default implementation does nothing, and returns false. + The default implementation does nothing, and returns \c false. */ bool QImageIOHandler::jumpToImage(int imageNumber) { diff --git a/src/gui/image/qimagereader.cpp b/src/gui/image/qimagereader.cpp index 5c5b1fa0be..636d86991b 100644 --- a/src/gui/image/qimagereader.cpp +++ b/src/gui/image/qimagereader.cpp @@ -761,8 +761,8 @@ void QImageReader::setAutoDetectImageFormat(bool enabled) } /*! - Returns true if image format autodetection is enabled on this image - reader; otherwise returns false. By default, autodetection is enabled. + Returns \c true if image format autodetection is enabled on this image + reader; otherwise returns \c false. By default, autodetection is enabled. \sa setAutoDetectImageFormat() */ @@ -1089,7 +1089,7 @@ QColor QImageReader::backgroundColor() const /*! \since 4.1 - Returns true if the image format supports animation; + Returns \c true if the image format supports animation; otherwise, false is returned. \sa QMovie::supportedFormats() @@ -1104,15 +1104,15 @@ bool QImageReader::supportsAnimation() const } /*! - Returns true if an image can be read for the device (i.e., the + Returns \c true if an image can be read for the device (i.e., the image format is supported, and the device seems to contain valid - data); otherwise returns false. + data); otherwise returns \c false. canRead() is a lightweight function that only does a quick test to see if the image data is valid. read() may still return false - after canRead() returns true, if the image data is corrupt. + after canRead() returns \c true, if the image data is corrupt. - For images that support animation, canRead() returns false when + For images that support animation, canRead() returns \c false when all frames have been read. \sa read(), supportedImageFormats() @@ -1149,7 +1149,7 @@ QImage QImageReader::read() \overload Reads an image from the device into \a image, which must point to a - QImage. Returns true on success; otherwise, returns false. + QImage. Returns \c true on success; otherwise, returns \c false. If \a image has same format and size as the image data that is about to be read, this function may not need to allocate a new image before @@ -1393,7 +1393,7 @@ QString QImageReader::errorString() const /*! \since 4.2 - Returns true if the reader supports \a option; otherwise returns + Returns \c true if the reader supports \a option; otherwise returns false. Different image formats support different options. Call this function to diff --git a/src/gui/image/qimagewriter.cpp b/src/gui/image/qimagewriter.cpp index c502a01df5..e4065724be 100644 --- a/src/gui/image/qimagewriter.cpp +++ b/src/gui/image/qimagewriter.cpp @@ -58,7 +58,7 @@ object. Pass either a file name or a device pointer, and the image format to QImageWriter's constructor. You can then set several options, such as the gamma level (by calling setGamma()) - and quality (by calling setQuality()). canWrite() returns true if + and quality (by calling setQuality()). canWrite() returns \c true if QImageWriter can write the image (i.e., the image format is supported and the device is open for writing). Call write() to write the image to the device. @@ -554,7 +554,7 @@ void QImageWriter::setText(const QString &key, const QString &text) } /*! - Returns true if QImageWriter can write the image; i.e., the image + Returns \c true if QImageWriter can write the image; i.e., the image format is supported and the assigned device is open for reading. \sa write(), setDevice(), setFormat() @@ -580,7 +580,7 @@ bool QImageWriter::canWrite() const /*! Writes the image \a image to the assigned device or file - name. Returns true on success; otherwise returns false. If the + name. Returns \c true on success; otherwise returns \c false. If the operation fails, you can call error() to find the type of error that occurred, or errorString() to get a human readable description of the error. @@ -631,7 +631,7 @@ QString QImageWriter::errorString() const /*! \since 4.2 - Returns true if the writer supports \a option; otherwise returns + Returns \c true if the writer supports \a option; otherwise returns false. Different image formats support different options. Call this function to diff --git a/src/gui/image/qmovie.cpp b/src/gui/image/qmovie.cpp index 26e35c6db6..25d875ee11 100644 --- a/src/gui/image/qmovie.cpp +++ b/src/gui/image/qmovie.cpp @@ -777,8 +777,8 @@ QImage QMovie::currentImage() const } /*! - Returns true if the movie is valid (e.g., the image data is readable and - the image format is supported); otherwise returns false. + Returns \c true if the movie is valid (e.g., the image data is readable and + the image format is supported); otherwise returns \c false. */ bool QMovie::isValid() const { @@ -819,7 +819,7 @@ int QMovie::currentFrameNumber() const } /*! - Jumps to the next frame. Returns true on success; otherwise returns false. + Jumps to the next frame. Returns \c true on success; otherwise returns \c false. */ bool QMovie::jumpToNextFrame() { @@ -828,8 +828,8 @@ bool QMovie::jumpToNextFrame() } /*! - Jumps to frame number \a frameNumber. Returns true on success; otherwise - returns false. + Jumps to frame number \a frameNumber. Returns \c true on success; otherwise + returns \c false. */ bool QMovie::jumpToFrame(int frameNumber) { diff --git a/src/gui/image/qpicture.cpp b/src/gui/image/qpicture.cpp index e11d3bb019..ec89b405b5 100644 --- a/src/gui/image/qpicture.cpp +++ b/src/gui/image/qpicture.cpp @@ -191,7 +191,7 @@ int QPicture::devType() const /*! \fn bool QPicture::isNull() const - Returns true if the picture contains no data; otherwise returns + Returns \c true if the picture contains no data; otherwise returns false. */ @@ -256,7 +256,7 @@ 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 false. + 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. @@ -304,7 +304,7 @@ bool QPicture::load(QIODevice *dev, const char *format) /*! Saves a picture to the file specified by \a fileName and returns - true if successful; otherwise returns false. + true if successful; otherwise returns \c false. Please note that the \a format parameter has been deprecated and will have no effect. @@ -406,8 +406,8 @@ void QPicture::setBoundingRect(const QRect &r) } /*! - Replays the picture using \a painter, and returns true if - successful; otherwise returns false. + Replays the picture using \a painter, and returns \c true if + successful; otherwise returns \c false. This function does exactly the same as QPainter::drawPicture() with (x, y) = (0, 0). @@ -1836,8 +1836,8 @@ QList QPictureIO::outputFormats() /*! - Reads an picture into memory and returns true if the picture was - successfully read; otherwise returns false. + Reads an picture into memory and returns \c true if the picture was + successfully read; otherwise returns \c false. Before reading an picture you must set an IO device or a file name. If both an IO device and a file name have been set, the IO device @@ -1909,8 +1909,8 @@ bool QPictureIO::read() /*! - Writes an picture to an IO device and returns true if the picture was - successfully written; otherwise returns false. + Writes an picture to an IO device and returns \c true if the picture was + successfully written; otherwise returns \c false. Before writing an picture you must set an IO device or a file name. If both an IO device and a file name have been set, the IO device diff --git a/src/gui/image/qpictureformatplugin.cpp b/src/gui/image/qpictureformatplugin.cpp index 29d6912201..c87b9ba6ac 100644 --- a/src/gui/image/qpictureformatplugin.cpp +++ b/src/gui/image/qpictureformatplugin.cpp @@ -106,8 +106,8 @@ QPictureFormatPlugin::~QPictureFormatPlugin() /*! Loads the picture stored in the file called \a fileName, with the - given \a format, into *\a picture. Returns true on success; - otherwise returns false. + given \a format, into *\a picture. Returns \c true on success; + otherwise returns \c false. \sa savePicture() */ @@ -121,8 +121,8 @@ bool QPictureFormatPlugin::loadPicture(const QString &format, const QString &fil /*! Saves the given \a picture into the file called \a fileName, - using the specified \a format. Returns true on success; otherwise - returns false. + using the specified \a format. Returns \c true on success; otherwise + returns \c false. \sa loadPicture() */ diff --git a/src/gui/image/qpixmap.cpp b/src/gui/image/qpixmap.cpp index bb48a4b3a5..5f51358eb2 100644 --- a/src/gui/image/qpixmap.cpp +++ b/src/gui/image/qpixmap.cpp @@ -418,7 +418,7 @@ QPixmap::operator QVariant() const /*! \fn bool QPixmap::operator!() const - Returns true if this is a null pixmap; otherwise returns false. + Returns \c true if this is a null pixmap; otherwise returns \c false. \sa isNull() */ @@ -484,7 +484,7 @@ QMatrix QPixmap::trueMatrix(const QMatrix &m, int w, int h) /*! \fn bool QPixmap::isQBitmap() const - Returns true if this is a QBitmap; otherwise returns false. + Returns \c true if this is a QBitmap; otherwise returns \c false. */ bool QPixmap::isQBitmap() const @@ -495,7 +495,7 @@ bool QPixmap::isQBitmap() const /*! \fn bool QPixmap::isNull() const - Returns true if this is a null pixmap; otherwise returns false. + Returns \c true if this is a null pixmap; otherwise returns \c false. A null pixmap has zero width, zero height and no contents. You cannot draw in a null pixmap. @@ -740,7 +740,7 @@ QBitmap QPixmap::createMaskFromColor(const QColor &maskColor, Qt::MaskMode mode) /*! Loads a pixmap from the file with the given \a fileName. Returns true if the pixmap was successfully loaded; otherwise invalidates - the pixmap and returns false. + the pixmap and returns \c false. The loader attempts to read the pixmap using the specified \a format. If the \a format is not specified (which is the default), @@ -806,8 +806,8 @@ bool QPixmap::load(const QString &fileName, const char *format, Qt::ImageConvers \fn bool QPixmap::loadFromData(const uchar *data, uint len, const char *format, Qt::ImageConversionFlags flags) Loads a pixmap from the \a len first bytes of the given binary \a - data. Returns true if the pixmap was loaded successfully; - otherwise invalidates the pixmap and returns false. + data. Returns \c true if the pixmap was loaded successfully; + otherwise invalidates the pixmap and returns \c false. The loader attempts to read the pixmap using the specified \a format. If the \a format is not specified (which is the default), @@ -850,8 +850,8 @@ bool QPixmap::loadFromData(const uchar *buf, uint len, const char *format, Qt::I /*! Saves the pixmap to the file with the given \a fileName using the - specified image file \a format and \a quality factor. Returns true - if successful; otherwise returns false. + specified image file \a format and \a quality factor. Returns \c true + if successful; otherwise returns \c false. The \a quality factor must be in the range [0,100] or -1. Specify 0 to obtain small compressed files, 100 for large uncompressed @@ -1086,7 +1086,7 @@ bool QPixmap::isDetached() const Replaces this pixmap's data with the given \a image using the specified \a flags to control the conversion. The \a flags argument is a bitwise-OR of the \l{Qt::ImageConversionFlags}. - Passing 0 for \a flags sets all the default options. Returns true + Passing 0 for \a flags sets all the default options. Returns \c true if the result is that this pixmap is not null. Note: this function was part of Qt 3 support in Qt 4.6 and earlier. @@ -1292,8 +1292,8 @@ QPixmap QPixmap::transformed(const QMatrix &matrix, Qt::TransformationMode mode) and for direct pixel access and manipulation, while QPixmap is designed and optimized for showing images on screen. QBitmap is only a convenience class that inherits QPixmap, ensuring a depth - of 1. The isQBitmap() function returns true if a QPixmap object is - really a bitmap, otherwise returns false. Finally, the QPicture class + of 1. The isQBitmap() function returns \c true if a QPixmap object is + really a bitmap, otherwise returns \c false. Finally, the QPicture class is a paint device that records and replays QPainter commands. A QPixmap can easily be displayed on the screen using QLabel or @@ -1378,8 +1378,8 @@ QPixmap QPixmap::transformed(const QMatrix &matrix, Qt::TransformationMode mode) \li Alpha component \li - The hasAlphaChannel() returns true if the pixmap has a format that - respects the alpha channel, otherwise returns false. The hasAlpha(), + The hasAlphaChannel() returns \c true if the pixmap has a format that + respects the alpha channel, otherwise returns \c false. The hasAlpha(), setMask() and mask() functions are legacy and should not be used. They are potentially very slow. @@ -1457,8 +1457,8 @@ QPixmap QPixmap::transformed(const QMatrix &matrix, Qt::TransformationMode mode) */ /*! - Returns true if this pixmap has an alpha channel, \e or has a - mask, otherwise returns false. + Returns \c true if this pixmap has an alpha channel, \e or has a + mask, otherwise returns \c false. \sa hasAlphaChannel(), mask() */ @@ -1468,8 +1468,8 @@ bool QPixmap::hasAlpha() const } /*! - Returns true if the pixmap has a format that respects the alpha - channel, otherwise returns false. + Returns \c true if the pixmap has a format that respects the alpha + channel, otherwise returns \c false. \sa hasAlpha() */ diff --git a/src/gui/image/qpixmapcache.cpp b/src/gui/image/qpixmapcache.cpp index f4d2afed7a..dbfe46a455 100644 --- a/src/gui/image/qpixmapcache.cpp +++ b/src/gui/image/qpixmapcache.cpp @@ -132,7 +132,7 @@ QPixmapCache::Key::~Key() /*! \internal - Returns true if this key is the same as the given \a key; otherwise returns + Returns \c true if this key is the same as the given \a key; otherwise returns false. */ bool QPixmapCache::Key::operator ==(const Key &key) const @@ -234,7 +234,7 @@ QPMCache::~QPMCache() the timer is not restarted when the pixmap becomes unused, but it does restart once something else is added (i.e. the cache space is actually needed). - Returns true if any were removed. + Returns \c true if any were removed. */ bool QPMCache::flushDetachedPixmaps(bool nt) { @@ -493,7 +493,7 @@ bool QPixmapCache::find(const QString &key, QPixmap& pixmap) /*! Looks for a cached pixmap associated with the given \a key in the cache. If the pixmap is found, the function sets \a pixmap to that pixmap and - returns true; otherwise it leaves \a pixmap alone and returns false. + returns \c true; otherwise it leaves \a pixmap alone and returns \c false. \since 4.6 @@ -512,7 +512,7 @@ bool QPixmapCache::find(const QString &key, QPixmap* pixmap) /*! Looks for a cached pixmap associated with the given \a key in the cache. If the pixmap is found, the function sets \a pixmap to that pixmap and - returns true; otherwise it leaves \a pixmap alone and returns false. If + returns \c true; otherwise it leaves \a pixmap alone and returns \c false. If the pixmap is not found, it means that the \a key is no longer valid, so it will be released for the next insertion. @@ -543,8 +543,8 @@ bool QPixmapCache::find(const Key &key, QPixmap* pixmap) The oldest pixmaps (least recently accessed in the cache) are deleted when more space is needed. - The function returns true if the object was inserted into the - cache; otherwise it returns false. + The function returns \c true if the object was inserted into the + cache; otherwise it returns \c false. \sa setCacheLimit() */ @@ -576,8 +576,8 @@ QPixmapCache::Key QPixmapCache::insert(const QPixmap &pixmap) /*! Replaces the pixmap associated with the given \a key with the \a pixmap - specified. Returns true if the \a pixmap has been correctly inserted into - the cache; otherwise returns false. + specified. Returns \c true if the \a pixmap has been correctly inserted into + the cache; otherwise returns \c false. \sa setCacheLimit(), insert() -- cgit v1.2.3