diff options
| author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:51:05 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-08 00:46:27 +0200 |
| commit | 4533cc994484a2308297e64e99af005fb4dca065 (patch) | |
| tree | bc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/gui | |
| parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff) | |
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 <oswald.buddenhagen@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/gui')
81 files changed, 617 insertions, 617 deletions
diff --git a/src/gui/accessible/qaccessible.cpp b/src/gui/accessible/qaccessible.cpp index e7827407f9..b8771ec583 100644 --- a/src/gui/accessible/qaccessible.cpp +++ b/src/gui/accessible/qaccessible.cpp @@ -727,7 +727,7 @@ QAccessibleInterface *QAccessible::accessibleInterface(Id id) /*! - Returns true if the platform requested accessibility information. + Returns \c true if the platform requested accessibility information. This function will return false until a tool such as a screen reader accessed the accessibility framework. It is still possible to use @@ -992,9 +992,9 @@ QPair< int, int > QAccessible::qAccessibleTextBoundaryHelper(const QTextCursor & /*! \fn bool QAccessibleInterface::isValid() const - Returns true if all the data necessary to use this interface + Returns \c true if all the data necessary to use this interface implementation is valid (e.g. all pointers are non-null); - otherwise returns false. + otherwise returns \c false. \sa object() */ @@ -2297,25 +2297,25 @@ QString QAccessibleTextInterface::textAtOffset(int offset, QAccessible::TextBoun /*! \fn virtual bool QAccessibleTableInterface::selectRow(int row) Selects \a row. This function might unselect all previously selected rows. - Returns true if the selection was successful. + Returns \c true if the selection was successful. */ /*! \fn virtual bool QAccessibleTableInterface::selectColumn(int column) Selects \a column. This function might unselect all previously selected columns. - Returns true if the selection was successful. + Returns \c true if the selection was successful. */ /*! \fn virtual bool QAccessibleTableInterface::unselectRow(int row) Unselects \a row, leaving other selected rows selected (if any). - Returns true if the selection was successful. + Returns \c true if the selection was successful. */ /*! \fn virtual bool QAccessibleTableInterface::unselectColumn(int column) Unselects \a column, leaving other selected columns selected (if any). - Returns true if the selection was successful. + Returns \c true if the selection was successful. */ /*! 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<QRgb> &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<QRgb> &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<QByteArray> 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() diff --git a/src/gui/itemmodels/qstandarditemmodel.cpp b/src/gui/itemmodels/qstandarditemmodel.cpp index 955d72f2ca..7341c4c6f6 100644 --- a/src/gui/itemmodels/qstandarditemmodel.cpp +++ b/src/gui/itemmodels/qstandarditemmodel.cpp @@ -1559,8 +1559,8 @@ void QStandardItem::insertColumns(int column, int count) \fn bool QStandardItemModel::insertRow(int row, const QModelIndex &parent) Inserts a single row before the given \a row in the child items of the - \a parent specified. Returns true if the row is inserted; otherwise - returns false. + \a parent specified. Returns \c true if the row is inserted; otherwise + returns \c false. \sa insertRows(), insertColumn(), removeRow() */ @@ -1569,8 +1569,8 @@ void QStandardItem::insertColumns(int column, int count) \fn bool QStandardItemModel::insertColumn(int column, const QModelIndex &parent) Inserts a single column before the given \a column in the child items of - the \a parent specified. Returns true if the column is inserted; otherwise - returns false. + the \a parent specified. Returns \c true if the column is inserted; otherwise + returns \c false. \sa insertColumns(), insertRow(), removeColumn() */ @@ -1672,7 +1672,7 @@ void QStandardItem::removeColumns(int column, int count) } /*! - Returns true if this item has any children; otherwise returns false. + Returns \c true if this item has any children; otherwise returns \c false. \sa rowCount(), columnCount(), child() */ @@ -1803,7 +1803,7 @@ QList<QStandardItem*> QStandardItem::takeColumn(int column) } /*! - Returns true if this item is less than \a other; otherwise returns false. + Returns \c true if this item is less than \a other; otherwise returns \c false. The default implementation uses the data for the item's sort role (see QStandardItemModel::sortRole) to perform the comparison if the item diff --git a/src/gui/kernel/qclipboard.cpp b/src/gui/kernel/qclipboard.cpp index f0b1f16ba2..3c2d36ce86 100644 --- a/src/gui/kernel/qclipboard.cpp +++ b/src/gui/kernel/qclipboard.cpp @@ -475,8 +475,8 @@ void QClipboard::setPixmap(const QPixmap &pixmap, Mode mode) /*! - Returns true if the clipboard supports mouse selection; otherwise - returns false. + Returns \c true if the clipboard supports mouse selection; otherwise + returns \c false. */ bool QClipboard::supportsSelection() const { @@ -484,8 +484,8 @@ bool QClipboard::supportsSelection() const } /*! - Returns true if the clipboard supports a separate search buffer; otherwise - returns false. + Returns \c true if the clipboard supports a separate search buffer; otherwise + returns \c false. */ bool QClipboard::supportsFindBuffer() const { @@ -493,8 +493,8 @@ bool QClipboard::supportsFindBuffer() const } /*! - Returns true if this clipboard object owns the clipboard data; - otherwise returns false. + Returns \c true if this clipboard object owns the clipboard data; + otherwise returns \c false. */ bool QClipboard::ownsClipboard() const { @@ -502,8 +502,8 @@ bool QClipboard::ownsClipboard() const } /*! - Returns true if this clipboard object owns the mouse selection - data; otherwise returns false. + Returns \c true if this clipboard object owns the mouse selection + data; otherwise returns \c false. */ bool QClipboard::ownsSelection() const { @@ -513,8 +513,8 @@ bool QClipboard::ownsSelection() const /*! \since 4.2 - Returns true if this clipboard object owns the find buffer data; - otherwise returns false. + Returns \c true if this clipboard object owns the find buffer data; + otherwise returns \c false. */ bool QClipboard::ownsFindBuffer() const { @@ -524,15 +524,15 @@ bool QClipboard::ownsFindBuffer() const /*! \internal \fn bool QClipboard::supportsMode(Mode mode) const; - Returns true if the clipboard supports the clipboard mode speacified by \a mode; - otherwise returns false. + Returns \c true if the clipboard supports the clipboard mode speacified by \a mode; + otherwise returns \c false. */ /*! \internal \fn bool QClipboard::ownsMode(Mode mode) const; - Returns true if the clipboard supports the clipboard data speacified by \a mode; - otherwise returns false. + Returns \c true if the clipboard supports the clipboard data speacified by \a mode; + otherwise returns \c false. */ /*! diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index e11c4671e6..ef9a3a1225 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -1028,8 +1028,8 @@ Qt::KeyboardModifiers QKeyEvent::modifiers() const \fn bool QKeyEvent::matches(QKeySequence::StandardKey key) const \since 4.2 - Returns true if the key event matches the given standard \a key; - otherwise returns false. + Returns \c true if the key event matches the given standard \a key; + otherwise returns \c false. */ bool QKeyEvent::matches(QKeySequence::StandardKey matchKey) const { @@ -1045,8 +1045,8 @@ bool QKeyEvent::matches(QKeySequence::StandardKey matchKey) const /*! \fn bool QKeyEvent::isAutoRepeat() const - Returns true if this event comes from an auto-repeating key; - returns false if it comes from an initial key press. + Returns \c true if this event comes from an auto-repeating key; + returns \c false if it comes from an initial key press. Note that if the event is a multiple-key compressed event that is partly due to auto-repeat, this function could return either true @@ -1113,14 +1113,14 @@ Qt::FocusReason QFocusEvent::reason() const /*! \fn bool QFocusEvent::gotFocus() const - Returns true if type() is QEvent::FocusIn; otherwise returns + Returns \c true if type() is QEvent::FocusIn; otherwise returns false. */ /*! \fn bool QFocusEvent::lostFocus() const - Returns true if type() is QEvent::FocusOut; otherwise returns + Returns \c true if type() is QEvent::FocusOut; otherwise returns false. */ @@ -1359,7 +1359,7 @@ QResizeEvent::~QResizeEvent() If the last top-level window is closed, the QApplication::lastWindowClosed() signal is emitted. - The isAccepted() function returns true if the event's receiver has + The isAccepted() function returns \c true if the event's receiver has agreed to close the widget; call accept() to agree to close the widget and call ignore() if the receiver of this event does not want the widget to be closed. @@ -2875,7 +2875,7 @@ QActionEvent::~QActionEvent() window manager controls, either by iconifying the window or by switching to another virtual desktop where the window isn't visible. The window will become hidden but not withdrawn. If the - window was iconified, QWidget::isMinimized() returns true. + window was iconified, QWidget::isMinimized() returns \c true. \sa QShowEvent */ @@ -2988,7 +2988,7 @@ QFileOpenEvent::~QFileOpenEvent() \fn bool QFileOpenEvent::openFile(QFile &file, QIODevice::OpenMode flags) const Opens a QFile on the \a file referenced by this event in the mode specified - by \a flags. Returns true if successful; otherwise returns false. + by \a flags. Returns \c true if successful; otherwise returns \c false. This is necessary as some files cannot be opened by name, but require specific information stored in this event. @@ -3428,7 +3428,7 @@ QDebug operator<<(QDebug dbg, const QEvent *e) { /*! \fn bool QShortcutEvent::isAmbiguous() const - Returns true if the key sequence that triggered the event is + Returns \c true if the key sequence that triggered the event is ambiguous. \sa QShortcut::activatedAmbiguously() diff --git a/src/gui/kernel/qguiapplication.cpp b/src/gui/kernel/qguiapplication.cpp index c7eefdbefa..47efc98474 100644 --- a/src/gui/kernel/qguiapplication.cpp +++ b/src/gui/kernel/qguiapplication.cpp @@ -645,7 +645,7 @@ void QGuiApplicationPrivate::hideModalWindow(QWindow *window) } /* - Returns true if \a window is blocked by a modal window. If \a + Returns \c true if \a window is blocked by a modal window. If \a blockingWindow is non-zero, *blockingWindow will be set to the blocking window (or to zero if \a window is not blocked). */ @@ -2520,8 +2520,8 @@ void QGuiApplication::setFont(const QFont &font) /*! \fn bool QGuiApplication::isRightToLeft() - Returns true if the application's layout direction is - Qt::RightToLeft; otherwise returns false. + Returns \c true if the application's layout direction is + Qt::RightToLeft; otherwise returns \c false. \sa layoutDirection(), isLeftToRight() */ @@ -2529,8 +2529,8 @@ void QGuiApplication::setFont(const QFont &font) /*! \fn bool QGuiApplication::isLeftToRight() - Returns true if the application's layout direction is - Qt::LeftToRight; otherwise returns false. + Returns \c true if the application's layout direction is + Qt::LeftToRight; otherwise returns \c false. \sa layoutDirection(), isRightToLeft() */ @@ -2552,7 +2552,7 @@ void QGuiApplicationPrivate::notifyActiveWindowChange(QWindow *) The default is true. - If this property is true, the applications quits when the last visible + If this property is \c true, the applications quits when the last visible primary window (i.e. window with no parent) is closed. \sa quit(), QWindow::close() @@ -2720,8 +2720,8 @@ void QGuiApplicationPrivate::setApplicationState(Qt::ApplicationState state) /*! \fn bool QGuiApplication::isSessionRestored() const - Returns true if the application has been restored from an earlier - \l{Session Management}{session}; otherwise returns false. + Returns \c true if the application has been restored from an earlier + \l{Session Management}{session}; otherwise returns \c false. \sa sessionId(), commitDataRequest(), saveStateRequest() */ @@ -2730,8 +2730,8 @@ void QGuiApplicationPrivate::setApplicationState(Qt::ApplicationState state) \since 5.0 \fn bool QGuiApplication::isSavingSession() const - Returns true if the application is currently saving the - \l{Session Management}{session}; otherwise returns false. + Returns \c true if the application is currently saving the + \l{Session Management}{session}; otherwise returns \c false. This is true when commitDataRequest() and saveStateRequest() are emitted, but also when the windows are closed afterwards by session management. @@ -3013,8 +3013,8 @@ void QGuiApplication::setDesktopSettingsAware(bool on) } /*! - Returns true if Qt is set to use the system's standard colors, fonts, etc.; - otherwise returns false. The default is true. + Returns \c true if Qt is set to use the system's standard colors, fonts, etc.; + otherwise returns \c false. The default is true. \sa setDesktopSettingsAware() */ diff --git a/src/gui/kernel/qkeysequence.cpp b/src/gui/kernel/qkeysequence.cpp index 1fcf1026d2..ead248074e 100644 --- a/src/gui/kernel/qkeysequence.cpp +++ b/src/gui/kernel/qkeysequence.cpp @@ -879,7 +879,7 @@ int QKeySequence::count() const /*! - Returns true if the key sequence is empty; otherwise returns + Returns \c true if the key sequence is empty; otherwise returns false. */ bool QKeySequence::isEmpty() const @@ -1372,14 +1372,14 @@ QKeySequence &QKeySequence::operator=(const QKeySequence &other) /*! \fn bool QKeySequence::operator!=(const QKeySequence &other) const - Returns true if this key sequence is not equal to the \a other - key sequence; otherwise returns false. + Returns \c true if this key sequence is not equal to the \a other + key sequence; otherwise returns \c false. */ /*! - Returns true if this key sequence is equal to the \a other - key sequence; otherwise returns false. + Returns \c true if this key sequence is equal to the \a other + key sequence; otherwise returns \c false. */ bool QKeySequence::operator==(const QKeySequence &other) const { @@ -1393,7 +1393,7 @@ bool QKeySequence::operator==(const QKeySequence &other) const /*! Provides an arbitrary comparison of this key sequence and \a other key sequence. All that is guaranteed is that the - operator returns false if both key sequences are equal and + operator returns \c false if both key sequences are equal and that (ks1 \< ks2) == !( ks2 \< ks1) if the key sequences are not equal. @@ -1413,8 +1413,8 @@ bool QKeySequence::operator< (const QKeySequence &other) const /*! \fn bool QKeySequence::operator> (const QKeySequence &other) const - Returns true if this key sequence is larger than the \a other key - sequence; otherwise returns false. + Returns \c true if this key sequence is larger than the \a other key + sequence; otherwise returns \c false. \sa operator==(), operator!=(), operator<(), operator<=(), operator>=() */ @@ -1422,8 +1422,8 @@ bool QKeySequence::operator< (const QKeySequence &other) const /*! \fn bool QKeySequence::operator<= (const QKeySequence &other) const - Returns true if this key sequence is smaller or equal to the - \a other key sequence; otherwise returns false. + Returns \c true if this key sequence is smaller or equal to the + \a other key sequence; otherwise returns \c false. \sa operator==(), operator!=(), operator<(), operator>(), operator>=() */ @@ -1431,8 +1431,8 @@ bool QKeySequence::operator< (const QKeySequence &other) const /*! \fn bool QKeySequence::operator>= (const QKeySequence &other) const - Returns true if this key sequence is larger or equal to the - \a other key sequence; otherwise returns false. + Returns \c true if this key sequence is larger or equal to the + \a other key sequence; otherwise returns \c false. \sa operator==(), operator!=(), operator<(), operator>(), operator<=() */ diff --git a/src/gui/kernel/qopenglcontext.cpp b/src/gui/kernel/qopenglcontext.cpp index 9f03020c22..ab782fac34 100644 --- a/src/gui/kernel/qopenglcontext.cpp +++ b/src/gui/kernel/qopenglcontext.cpp @@ -184,7 +184,7 @@ void QOpenGLVersionProfile::setProfile(QSurfaceFormat::OpenGLContextProfile prof } /*! - Returns true if profiles are supported by the OpenGL version returned by version(). Only + Returns \c true if profiles are supported by the OpenGL version returned by version(). Only OpenGL versions >= 3.2 support profiles. \sa profile(), version() @@ -196,7 +196,7 @@ bool QOpenGLVersionProfile::hasProfiles() const } /*! - Returns true is the OpenGL version returned by version() contains deprecated functions + Returns \c true is the OpenGL version returned by version() contains deprecated functions and does not support profiles i.e. if the OpenGL version is <= 3.1. */ bool QOpenGLVersionProfile::isLegacyVersion() const @@ -205,7 +205,7 @@ bool QOpenGLVersionProfile::isLegacyVersion() const } /*! - Returns true if the version number is valid. Note that for a default constructed + Returns \c true if the version number is valid. Note that for a default constructed QOpenGLVersionProfile object this function will return false. \sa setVersion(), version() @@ -380,7 +380,7 @@ QOpenGLContext* QOpenGLContext::currentContext() } /*! - Returns true if the \a first and \a second contexts are sharing OpenGL resources. + Returns \c true if the \a first and \a second contexts are sharing OpenGL resources. */ bool QOpenGLContext::areSharing(QOpenGLContext *first, QOpenGLContext *second) { @@ -472,7 +472,7 @@ void QOpenGLContext::setScreen(QScreen *screen) and/or hardware only supports version 3.2 Core profile contexts then you will get a 3.2 Core profile context. - Returns true if the native context was successfully created and is ready to + Returns \c true if the native context was successfully created and is ready to be used with makeCurrent(), swapBuffers(), etc. \sa makeCurrent(), destroy(), format() @@ -698,7 +698,7 @@ QSet<QByteArray> QOpenGLContext::extensions() const } /*! - Returns true if this OpenGL context supports the specified OpenGL + Returns \c true if this OpenGL context supports the specified OpenGL \a extension, false otherwise. The context or a sharing context must be current. @@ -737,7 +737,7 @@ GLuint QOpenGLContext::defaultFramebufferObject() const /*! Makes the context current in the current thread, against the given - \a surface. Returns true if successful. + \a surface. Returns \c true if successful. If \a surface is 0 this is equivalent to calling doneCurrent(). diff --git a/src/gui/kernel/qpalette.cpp b/src/gui/kernel/qpalette.cpp index 00ab74e4e4..f284c20af5 100644 --- a/src/gui/kernel/qpalette.cpp +++ b/src/gui/kernel/qpalette.cpp @@ -763,8 +763,8 @@ void QPalette::setBrush(ColorGroup cg, ColorRole cr, const QBrush &b) /*! \since 4.2 - Returns true if the ColorGroup \a cg and ColorRole \a cr has been - set previously on this palette; otherwise returns false. + Returns \c true if the ColorGroup \a cg and ColorRole \a cr has been + set previously on this palette; otherwise returns \c false. \sa setBrush() */ @@ -795,8 +795,8 @@ void QPalette::detach() /*! \fn bool QPalette::operator!=(const QPalette &p) const - Returns true (slowly) if this palette is different from \a p; - otherwise returns false (usually quickly). + Returns \c true (slowly) if this palette is different from \a p; + otherwise returns \c false (usually quickly). \note The current ColorGroup is not taken into account when comparing palettes @@ -805,8 +805,8 @@ void QPalette::detach() */ /*! - Returns true (usually quickly) if this palette is equal to \a p; - otherwise returns false (slowly). + Returns \c true (usually quickly) if this palette is equal to \a p; + otherwise returns \c false (slowly). \note The current ColorGroup is not taken into account when comparing palettes @@ -829,8 +829,8 @@ bool QPalette::operator==(const QPalette &p) const /*! \fn bool QPalette::isEqual(ColorGroup cg1, ColorGroup cg2) const - Returns true (usually quickly) if color group \a cg1 is equal to - \a cg2; otherwise returns false. + Returns \c true (usually quickly) if color group \a cg1 is equal to + \a cg2; otherwise returns \c false. */ bool QPalette::isEqual(QPalette::ColorGroup group1, QPalette::ColorGroup group2) const { @@ -1010,9 +1010,9 @@ QDataStream &operator>>(QDataStream &s, QPalette &p) #endif //QT_NO_DATASTREAM /*! - Returns true if this palette and \a p are copies of each other, + Returns \c true if this palette and \a p are copies of each other, i.e. one of them was created as a copy of the other and neither - was subsequently modified; otherwise returns false. This is much + was subsequently modified; otherwise returns \c false. This is much stricter than equality. \sa operator=(), operator==() diff --git a/src/gui/kernel/qplatforminputcontext.cpp b/src/gui/kernel/qplatforminputcontext.cpp index 1cddccaab6..656c0d0fba 100644 --- a/src/gui/kernel/qplatforminputcontext.cpp +++ b/src/gui/kernel/qplatforminputcontext.cpp @@ -165,7 +165,7 @@ void QPlatformInputContext::emitKeyboardRectChanged() /*! This function can be reimplemented to return true whenever input method is animating - shown or hidden. Default implementation returns false. + shown or hidden. Default implementation returns \c false. */ bool QPlatformInputContext::isAnimating() const { @@ -197,7 +197,7 @@ void QPlatformInputContext::hideInputPanel() } /*! - Returns input panel visibility status. Default implementation returns false. + Returns input panel visibility status. Default implementation returns \c false. */ bool QPlatformInputContext::isInputPanelVisible() const { @@ -244,7 +244,7 @@ void QPlatformInputContext::setFocusObject(QObject *object) } /*! - Returns true if current focus object supports input method events. + Returns \c true if current focus object supports input method events. */ bool QPlatformInputContext::inputMethodAccepted() const { diff --git a/src/gui/kernel/qplatformintegration.cpp b/src/gui/kernel/qplatformintegration.cpp index 22d6746ce0..49ac7836cb 100644 --- a/src/gui/kernel/qplatformintegration.cpp +++ b/src/gui/kernel/qplatformintegration.cpp @@ -221,14 +221,14 @@ QPlatformServices *QPlatformIntegration::services() const libraries. \value NonFullScreenWindows The platform supports top-level windows which do not - fill the screen. The default implementation returns true. Returning false for + fill the screen. The default implementation returns \c true. Returning false for this will cause all windows, including dialogs and popups, to be resized to fill the screen. \value WindowManagement The platform is based on a system that performs window management. This includes the typical desktop platforms. Can be set to false on platforms where no window management is available, meaning for example that windows - are never repositioned by the window manager. The default implementation returns true. + are never repositioned by the window manager. The default implementation returns \c true. */ /*! diff --git a/src/gui/kernel/qplatformscreenpageflipper.cpp b/src/gui/kernel/qplatformscreenpageflipper.cpp index dacc041c99..8665adc463 100644 --- a/src/gui/kernel/qplatformscreenpageflipper.cpp +++ b/src/gui/kernel/qplatformscreenpageflipper.cpp @@ -110,7 +110,7 @@ QPlatformScreenPageFlipper::QPlatformScreenPageFlipper(QObject *parent) Implemented in subclasses to display \a buffer directly on the screen. Returns \c true if it is possible to display the buffer, and \c false if the buffer cannot be displayed. - If this function returns true, the buffer must not be modified or destroyed before the + If this function returns \c true, the buffer must not be modified or destroyed before the bufferReleased() signal is emitted. The signal bufferDisplayed() is emitted when the buffer is displayed on the screen. The two signals may be emitted in either order. diff --git a/src/gui/kernel/qplatformsharedgraphicscache.cpp b/src/gui/kernel/qplatformsharedgraphicscache.cpp index e008dde868..23224008b9 100644 --- a/src/gui/kernel/qplatformsharedgraphicscache.cpp +++ b/src/gui/kernel/qplatformsharedgraphicscache.cpp @@ -243,7 +243,7 @@ QT_BEGIN_NAMESPACE /*! \fn bool QPlatformSharedGraphicsCache::requestBatchStarted() const - Returns true if a request batch has previously been started using beginRequestBatch() + Returns \c true if a request batch has previously been started using beginRequestBatch() and not yet stopped using endRequestBatch(). \sa beginRequestBatch(), endRequestBatch() @@ -278,7 +278,7 @@ QT_BEGIN_NAMESPACE /*! \fn bool QPlatformSharedGraphicsCache::dereferenceBuffer(void *bufferId) - Removed a previously registered reference to the buffer \a bufferId. Returns true if there + Removed a previously registered reference to the buffer \a bufferId. Returns \c true if there are still more references to the buffer in question, or false if this was the last reference (in which case the buffer may have been deleted in the cache.) diff --git a/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp b/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp index b47b657361..5d7ff7864d 100644 --- a/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp +++ b/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp @@ -135,12 +135,12 @@ QPlatformSystemTrayIcon::~QPlatformSystemTrayIcon() /*! \fn bool QPlatformSystemTrayIcon::isSystemTrayAvailable() const - Returns true if the system tray is available on the platform. + Returns \c true if the system tray is available on the platform. */ /*! \fn bool QPlatformSystemTrayIcon::supportsMessages() const - Returns true if the system tray supports messages on the platform. + Returns \c true if the system tray supports messages on the platform. */ /*! diff --git a/src/gui/kernel/qplatformwindow.cpp b/src/gui/kernel/qplatformwindow.cpp index 4c0d68e7c1..ac82d56241 100644 --- a/src/gui/kernel/qplatformwindow.cpp +++ b/src/gui/kernel/qplatformwindow.cpp @@ -167,7 +167,7 @@ bool QPlatformWindow::isExposed() const } /*! - Returns true if the window should appear active from a style perspective. + Returns \c true if the window should appear active from a style perspective. This function can make platform-specific isActive checks, such as checking if the QWindow is embedded in an active native window. @@ -178,7 +178,7 @@ bool QPlatformWindow::isActive() const } /*! - Returns true if the window is a descendant of an embedded non-Qt window. + Returns \c true if the window is a descendant of an embedded non-Qt window. Example of an embedded non-Qt window is the parent window of an in-process QAxServer. If \a parentWindow is nonzero, only check if the window is embedded in the diff --git a/src/gui/kernel/qscreen.cpp b/src/gui/kernel/qscreen.cpp index 558eca6b1d..2573f76374 100644 --- a/src/gui/kernel/qscreen.cpp +++ b/src/gui/kernel/qscreen.cpp @@ -579,8 +579,8 @@ QRect QScreen::mapBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b, cons } /*! - Convenience function that returns true if \a o is either portrait or inverted portrait; - otherwise returns false. + Convenience function that returns \c true if \a o is either portrait or inverted portrait; + otherwise returns \c false. Qt::PrimaryOrientation is interpreted as the screen's primaryOrientation(). */ @@ -591,8 +591,8 @@ bool QScreen::isPortrait(Qt::ScreenOrientation o) const } /*! - Convenience function that returns true if \a o is either landscape or inverted landscape; - otherwise returns false. + Convenience function that returns \c true if \a o is either landscape or inverted landscape; + otherwise returns \c false. Qt::PrimaryOrientation is interpreted as the screen's primaryOrientation(). */ diff --git a/src/gui/kernel/qsessionmanager.cpp b/src/gui/kernel/qsessionmanager.cpp index c46dd5f55a..b9ef35854c 100644 --- a/src/gui/kernel/qsessionmanager.cpp +++ b/src/gui/kernel/qsessionmanager.cpp @@ -181,7 +181,7 @@ QString QSessionManager::sessionKey() const /*! Asks the session manager for permission to interact with the user. Returns - true if interaction is permitted; otherwise returns false. + true if interaction is permitted; otherwise returns \c false. The rationale behind this mechanism is to make it possible to synchronize user interaction during a shutdown. Advanced session managers may ask all @@ -215,7 +215,7 @@ bool QSessionManager::allowsInteraction() } /*! - Returns true if error interaction is permitted; otherwise returns false. + Returns \c true if error interaction is permitted; otherwise returns \c false. This is similar to allowsInteraction(), but also enables the application to tell the user about any errors that occur. Session managers may give error @@ -386,8 +386,8 @@ void QSessionManager::setManagerProperty(const QString &name, } /*! - Returns true if the session manager is currently performing a second - session management phase; otherwise returns false. + Returns \c true if the session manager is currently performing a second + session management phase; otherwise returns \c false. \sa requestPhase2() */ diff --git a/src/gui/kernel/qsurfaceformat.cpp b/src/gui/kernel/qsurfaceformat.cpp index 9b8ed4a289..b2abed7812 100644 --- a/src/gui/kernel/qsurfaceformat.cpp +++ b/src/gui/kernel/qsurfaceformat.cpp @@ -254,7 +254,7 @@ QSurfaceFormat::~QSurfaceFormat() /*! \fn bool QSurfaceFormat::stereo() const - Returns true if stereo buffering is enabled; otherwise returns + Returns \c true if stereo buffering is enabled; otherwise returns false. Stereo buffering is disabled by default. \sa setStereo() @@ -325,7 +325,7 @@ void QSurfaceFormat::setOption(QSurfaceFormat::FormatOptions opt) } /*! - Returns true if format option \a opt is set; otherwise returns false. + Returns \c true if format option \a opt is set; otherwise returns \c false. \sa setOption() */ @@ -383,7 +383,7 @@ QSurfaceFormat::SwapBehavior QSurfaceFormat::swapBehavior() const } /*! - Returns true if the alpha buffer size is greater than zero. + Returns \c true if the alpha buffer size is greater than zero. This means that the surface might be used with per pixel translucency effects. @@ -607,7 +607,7 @@ void QSurfaceFormat::setVersion(int major, int minor) } /*! - Returns true if all the options of the two QSurfaceFormat objects + Returns \c true if all the options of the two QSurfaceFormat objects \a a and \a b are equal. \relates QSurfaceFormat @@ -629,8 +629,8 @@ bool operator==(const QSurfaceFormat& a, const QSurfaceFormat& b) } /*! - Returns false if all the options of the two QSurfaceFormat objects - \a a and \a b are equal; otherwise returns true. + Returns \c false if all the options of the two QSurfaceFormat objects + \a a and \a b are equal; otherwise returns \c true. \relates QSurfaceFormat */ diff --git a/src/gui/kernel/qwindow.cpp b/src/gui/kernel/qwindow.cpp index 12ea4df1c9..f2e60e0ff3 100644 --- a/src/gui/kernel/qwindow.cpp +++ b/src/gui/kernel/qwindow.cpp @@ -126,8 +126,8 @@ QT_BEGIN_NAMESPACE to a window with type QSurface::RasterSurface, and QOpenGLContext for rendering with OpenGL to a window with type QSurface::OpenGLSurface. - The application can start rendering as soon as isExposed() returns true, - and can keep rendering until it isExposed() returns false. To find out when + The application can start rendering as soon as isExposed() returns \c true, + and can keep rendering until it isExposed() returns \c false. To find out when isExposed() changes, reimplement exposeEvent(). The window will always get a resize event before the first expose event. @@ -903,7 +903,7 @@ bool QWindow::isExposed() const */ /*! - Returns true if the window should appear active from a style perspective. + Returns \c true if the window should appear active from a style perspective. This is the case for the window that has input focus as well as windows that are in the same parent / transient parent chain as the focus window. @@ -1067,7 +1067,7 @@ QWindow *QWindow::transientParent() const */ /*! - Returns true if the window is an ancestor of the given \a child. If \a mode + Returns \c true if the window is an ancestor of the given \a child. If \a mode is IncludeTransients, then transient parents are also considered ancestors. */ bool QWindow::isAncestorOf(const QWindow *child, AncestorMode mode) const @@ -1728,7 +1728,7 @@ void QWindow::showNormal() Close the window. This closes the window, effectively calling destroy(), and potentially - quitting the application. Returns true on success, false if it has a parent + quitting the application. Returns \c true on success, false if it has a parent window (in which case the top level window should be closed instead). \sa destroy(), QGuiApplication::quitOnLastWindowClosed() diff --git a/src/gui/math3d/qgenericmatrix.cpp b/src/gui/math3d/qgenericmatrix.cpp index 575cd0bf61..1ccafa051b 100644 --- a/src/gui/math3d/qgenericmatrix.cpp +++ b/src/gui/math3d/qgenericmatrix.cpp @@ -101,7 +101,7 @@ QT_BEGIN_NAMESPACE /*! \fn bool QGenericMatrix::isIdentity() const - Returns true if this matrix is the identity; false otherwise. + Returns \c true if this matrix is the identity; false otherwise. \sa setToIdentity() */ @@ -153,13 +153,13 @@ QT_BEGIN_NAMESPACE /*! \fn bool QGenericMatrix::operator==(const QGenericMatrix<N, M, T>& other) const - Returns true if this matrix is identical to \a other; false otherwise. + Returns \c true if this matrix is identical to \a other; false otherwise. */ /*! \fn bool QGenericMatrix::operator!=(const QGenericMatrix<N, M, T>& other) const - Returns true if this matrix is not identical to \a other; false otherwise. + Returns \c true if this matrix is not identical to \a other; false otherwise. */ /*! diff --git a/src/gui/math3d/qmatrix4x4.cpp b/src/gui/math3d/qmatrix4x4.cpp index 11132e84bb..0b3c5b4cb9 100644 --- a/src/gui/math3d/qmatrix4x4.cpp +++ b/src/gui/math3d/qmatrix4x4.cpp @@ -300,7 +300,7 @@ QMatrix4x4::QMatrix4x4(const QTransform& transform) /*! \fn bool QMatrix4x4::isIdentity() const - Returns true if this matrix is the identity; false otherwise. + Returns \c true if this matrix is the identity; false otherwise. \sa setToIdentity() */ @@ -634,14 +634,14 @@ QMatrix4x4& QMatrix4x4::operator/=(float divisor) /*! \fn bool QMatrix4x4::operator==(const QMatrix4x4& other) const - Returns true if this matrix is identical to \a other; false otherwise. + Returns \c true if this matrix is identical to \a other; false otherwise. This operator uses an exact floating-point comparison. */ /*! \fn bool QMatrix4x4::operator!=(const QMatrix4x4& other) const - Returns true if this matrix is not identical to \a other; false otherwise. + Returns \c true if this matrix is not identical to \a other; false otherwise. This operator uses an exact floating-point comparison. */ @@ -792,7 +792,7 @@ QMatrix4x4 operator/(const QMatrix4x4& matrix, float divisor) \fn bool qFuzzyCompare(const QMatrix4x4& m1, const QMatrix4x4& m2) \relates QMatrix4x4 - Returns true if \a m1 and \a m2 are equal, allowing for a small + Returns \c true if \a m1 and \a m2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise. */ diff --git a/src/gui/math3d/qquaternion.cpp b/src/gui/math3d/qquaternion.cpp index d042d9812a..d721674eb6 100644 --- a/src/gui/math3d/qquaternion.cpp +++ b/src/gui/math3d/qquaternion.cpp @@ -133,16 +133,16 @@ QT_BEGIN_NAMESPACE /*! \fn bool QQuaternion::isNull() const - Returns true if the x, y, z, and scalar components of this - quaternion are set to 0.0; otherwise returns false. + Returns \c true if the x, y, z, and scalar components of this + quaternion are set to 0.0; otherwise returns \c false. */ /*! \fn bool QQuaternion::isIdentity() const - Returns true if the x, y, and z components of this + Returns \c true if the x, y, and z components of this quaternion are set to 0.0, and the scalar component is set - to 1.0; otherwise returns false. + to 1.0; otherwise returns \c false. */ /*! @@ -394,7 +394,7 @@ QQuaternion QQuaternion::fromAxisAndAngle \fn bool operator==(const QQuaternion &q1, const QQuaternion &q2) \relates QQuaternion - Returns true if \a q1 is equal to \a q2; otherwise returns false. + Returns \c true if \a q1 is equal to \a q2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -402,7 +402,7 @@ QQuaternion QQuaternion::fromAxisAndAngle \fn bool operator!=(const QQuaternion &q1, const QQuaternion &q2) \relates QQuaternion - Returns true if \a q1 is not equal to \a q2; otherwise returns false. + Returns \c true if \a q1 is not equal to \a q2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -482,7 +482,7 @@ QQuaternion QQuaternion::fromAxisAndAngle \fn bool qFuzzyCompare(const QQuaternion& q1, const QQuaternion& q2) \relates QQuaternion - Returns true if \a q1 and \a q2 are equal, allowing for a small + Returns \c true if \a q1 and \a q2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise. */ diff --git a/src/gui/math3d/qvector2d.cpp b/src/gui/math3d/qvector2d.cpp index 7446d27dab..a56e23eb72 100644 --- a/src/gui/math3d/qvector2d.cpp +++ b/src/gui/math3d/qvector2d.cpp @@ -124,8 +124,8 @@ QVector2D::QVector2D(const QVector4D& vector) /*! \fn bool QVector2D::isNull() const - Returns true if the x and y coordinates are set to 0.0, - otherwise returns false. + Returns \c true if the x and y coordinates are set to 0.0, + otherwise returns \c false. */ /*! @@ -335,7 +335,7 @@ float QVector2D::dotProduct(const QVector2D& v1, const QVector2D& v2) \fn bool operator==(const QVector2D &v1, const QVector2D &v2) \relates QVector2D - Returns true if \a v1 is equal to \a v2; otherwise returns false. + Returns \c true if \a v1 is equal to \a v2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -343,7 +343,7 @@ float QVector2D::dotProduct(const QVector2D& v1, const QVector2D& v2) \fn bool operator!=(const QVector2D &v1, const QVector2D &v2) \relates QVector2D - Returns true if \a v1 is not equal to \a v2; otherwise returns false. + Returns \c true if \a v1 is not equal to \a v2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -418,7 +418,7 @@ float QVector2D::dotProduct(const QVector2D& v1, const QVector2D& v2) \fn bool qFuzzyCompare(const QVector2D& v1, const QVector2D& v2) \relates QVector2D - Returns true if \a v1 and \a v2 are equal, allowing for a small + Returns \c true if \a v1 and \a v2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise. */ diff --git a/src/gui/math3d/qvector3d.cpp b/src/gui/math3d/qvector3d.cpp index 226483c227..7e3ed7c61b 100644 --- a/src/gui/math3d/qvector3d.cpp +++ b/src/gui/math3d/qvector3d.cpp @@ -144,8 +144,8 @@ QVector3D::QVector3D(const QVector4D& vector) /*! \fn bool QVector3D::isNull() const - Returns true if the x, y, and z coordinates are set to 0.0, - otherwise returns false. + Returns \c true if the x, y, and z coordinates are set to 0.0, + otherwise returns \c false. */ /*! @@ -438,7 +438,7 @@ float QVector3D::distanceToLine \fn bool operator==(const QVector3D &v1, const QVector3D &v2) \relates QVector3D - Returns true if \a v1 is equal to \a v2; otherwise returns false. + Returns \c true if \a v1 is equal to \a v2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -446,7 +446,7 @@ float QVector3D::distanceToLine \fn bool operator!=(const QVector3D &v1, const QVector3D &v2) \relates QVector3D - Returns true if \a v1 is not equal to \a v2; otherwise returns false. + Returns \c true if \a v1 is not equal to \a v2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -524,7 +524,7 @@ float QVector3D::distanceToLine \fn bool qFuzzyCompare(const QVector3D& v1, const QVector3D& v2) \relates QVector3D - Returns true if \a v1 and \a v2 are equal, allowing for a small + Returns \c true if \a v1 and \a v2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise. */ diff --git a/src/gui/math3d/qvector4d.cpp b/src/gui/math3d/qvector4d.cpp index 2247e95d5e..691551367f 100644 --- a/src/gui/math3d/qvector4d.cpp +++ b/src/gui/math3d/qvector4d.cpp @@ -157,8 +157,8 @@ QVector4D::QVector4D(const QVector3D& vector, float wpos) /*! \fn bool QVector4D::isNull() const - Returns true if the x, y, z, and w coordinates are set to 0.0, - otherwise returns false. + Returns \c true if the x, y, z, and w coordinates are set to 0.0, + otherwise returns \c false. */ /*! @@ -378,7 +378,7 @@ float QVector4D::dotProduct(const QVector4D& v1, const QVector4D& v2) \fn bool operator==(const QVector4D &v1, const QVector4D &v2) \relates QVector4D - Returns true if \a v1 is equal to \a v2; otherwise returns false. + Returns \c true if \a v1 is equal to \a v2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -386,7 +386,7 @@ float QVector4D::dotProduct(const QVector4D& v1, const QVector4D& v2) \fn bool operator!=(const QVector4D &v1, const QVector4D &v2) \relates QVector4D - Returns true if \a v1 is not equal to \a v2; otherwise returns false. + Returns \c true if \a v1 is not equal to \a v2; otherwise returns \c false. This operator uses an exact floating-point comparison. */ @@ -463,7 +463,7 @@ float QVector4D::dotProduct(const QVector4D& v1, const QVector4D& v2) \fn bool qFuzzyCompare(const QVector4D& v1, const QVector4D& v2) \relates QVector4D - Returns true if \a v1 and \a v2 are equal, allowing for a small + Returns \c true if \a v1 and \a v2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise. */ diff --git a/src/gui/opengl/qopenglbuffer.cpp b/src/gui/opengl/qopenglbuffer.cpp index d70f326415..b832cefd70 100644 --- a/src/gui/opengl/qopenglbuffer.cpp +++ b/src/gui/opengl/qopenglbuffer.cpp @@ -259,7 +259,7 @@ namespace { } /*! - Creates the buffer object in the OpenGL server. Returns true if + Creates the buffer object in the OpenGL server. Returns \c true if the object was created; false otherwise. This function must be called with a current QOpenGLContext. @@ -294,7 +294,7 @@ bool QOpenGLBuffer::create() } /*! - Returns true if this buffer has been created; false otherwise. + Returns \c true if this buffer has been created; false otherwise. \sa create(), destroy() */ @@ -322,7 +322,7 @@ void QOpenGLBuffer::destroy() /*! Reads the \a count bytes in this buffer starting at \a offset - into \a data. Returns true on success; false if reading from + into \a data. Returns \c true on success; false if reading from the buffer is not supported. Buffer reading is not supported under OpenGL/ES. @@ -403,7 +403,7 @@ void QOpenGLBuffer::allocate(const void *data, int count) /*! Binds the buffer associated with this object to the current - OpenGL context. Returns false if binding was not possible, usually because + OpenGL context. Returns \c false if binding was not possible, usually because type() is not supported on this OpenGL implementation. The buffer must be bound to the same QOpenGLContext current when create() @@ -533,7 +533,7 @@ void *QOpenGLBuffer::map(QOpenGLBuffer::Access access) /*! Unmaps the buffer after it was mapped into the application's - memory space with a previous call to map(). Returns true if + memory space with a previous call to map(). Returns \c true if the unmap succeeded; false otherwise. It is assumed that this buffer has been bound to the current context, diff --git a/src/gui/opengl/qopengldebug.cpp b/src/gui/opengl/qopengldebug.cpp index 3920b75a05..90d062f4dd 100644 --- a/src/gui/opengl/qopengldebug.cpp +++ b/src/gui/opengl/qopengldebug.cpp @@ -997,7 +997,7 @@ QOpenGLDebugMessage QOpenGLDebugMessage::createThirdPartyMessage(const QString & } /*! - Returns true if this debug message is equal to \a debugMessage, or false + Returns \c true if this debug message is equal to \a debugMessage, or false otherwise. Two debugging messages are equal if they have the same textual message, the same id, the same source, the same type and the same severity. @@ -1016,7 +1016,7 @@ bool QOpenGLDebugMessage::operator==(const QOpenGLDebugMessage &debugMessage) co /*! \fn bool QOpenGLDebugMessage::operator!=(const QOpenGLDebugMessage &debugMessage) const - Returns true if this message is different from \a debugMessage, or false + Returns \c true if this message is different from \a debugMessage, or false otherwise. \sa operator==() @@ -1317,7 +1317,7 @@ QOpenGLDebugLogger::~QOpenGLDebugLogger() initialized object; note that in this case the object must not be logging when you call this function. - Returns true if the logger is successfully initialized; false otherwise. + Returns \c true if the logger is successfully initialized; false otherwise. \sa QOpenGLContext */ @@ -1383,7 +1383,7 @@ bool QOpenGLDebugLogger::initialize() } /*! - Returns true if this object is currently logging, false otherwise. + Returns \c true if this object is currently logging, false otherwise. \sa startLogging() */ diff --git a/src/gui/opengl/qopenglengineshadermanager.cpp b/src/gui/opengl/qopenglengineshadermanager.cpp index 5d8634e696..7c3c309ea5 100644 --- a/src/gui/opengl/qopenglengineshadermanager.cpp +++ b/src/gui/opengl/qopenglengineshadermanager.cpp @@ -661,7 +661,7 @@ QOpenGLShaderProgram* QOpenGLEngineShaderManager::blitProgram() // Select & use the correct shader program using the current state. -// Returns true if program needed changing. +// Returns \c true if program needed changing. bool QOpenGLEngineShaderManager::useCorrectShaderProg() { if (!shaderProgNeedsChanging) diff --git a/src/gui/opengl/qopenglframebufferobject.cpp b/src/gui/opengl/qopenglframebufferobject.cpp index 8d7b525929..c06ba40b47 100644 --- a/src/gui/opengl/qopenglframebufferobject.cpp +++ b/src/gui/opengl/qopenglframebufferobject.cpp @@ -238,7 +238,7 @@ void QOpenGLFramebufferObjectFormat::setMipmap(bool enabled) } /*! - Returns true if mipmapping is enabled. + Returns \c true if mipmapping is enabled. \sa setMipmap() */ @@ -320,8 +320,8 @@ GLenum QOpenGLFramebufferObjectFormat::internalTextureFormat() const } /*! - Returns true if all the options of this framebuffer object format - are the same as \a other; otherwise returns false. + Returns \c true if all the options of this framebuffer object format + are the same as \a other; otherwise returns \c false. */ bool QOpenGLFramebufferObjectFormat::operator==(const QOpenGLFramebufferObjectFormat& other) const { @@ -332,8 +332,8 @@ bool QOpenGLFramebufferObjectFormat::operator==(const QOpenGLFramebufferObjectFo } /*! - Returns false if all the options of this framebuffer object format - are the same as \a other; otherwise returns true. + Returns \c false if all the options of this framebuffer object format + are the same as \a other; otherwise returns \c true. */ bool QOpenGLFramebufferObjectFormat::operator!=(const QOpenGLFramebufferObjectFormat& other) const { @@ -877,7 +877,7 @@ QOpenGLFramebufferObject::~QOpenGLFramebufferObject() /*! \fn bool QOpenGLFramebufferObject::isValid() const - Returns true if the framebuffer object is valid. + Returns \c true if the framebuffer object is valid. The framebuffer can become invalid if the initialization process fails, the user attaches an invalid buffer to the framebuffer @@ -903,7 +903,7 @@ bool QOpenGLFramebufferObject::isValid() const Switches rendering from the default, windowing system provided framebuffer to this framebuffer object. - Returns true upon success, false otherwise. + Returns \c true upon success, false otherwise. \sa release() */ @@ -931,7 +931,7 @@ bool QOpenGLFramebufferObject::bind() Switches rendering back to the default, windowing system provided framebuffer. - Returns true upon success, false otherwise. + Returns \c true upon success, false otherwise. \sa bind() */ @@ -1069,7 +1069,7 @@ QImage QOpenGLFramebufferObject::toImage() const Switches rendering back to the default, windowing system provided framebuffer. - Returns true upon success, false otherwise. + Returns \c true upon success, false otherwise. \sa bind(), release() */ @@ -1093,8 +1093,8 @@ bool QOpenGLFramebufferObject::bindDefault() /*! \fn bool QOpenGLFramebufferObject::hasOpenGLFramebufferObjects() - Returns true if the OpenGL \c{GL_EXT_framebuffer_object} extension - is present on this system; otherwise returns false. + Returns \c true if the OpenGL \c{GL_EXT_framebuffer_object} extension + is present on this system; otherwise returns \c false. */ bool QOpenGLFramebufferObject::hasOpenGLFramebufferObjects() { @@ -1154,7 +1154,7 @@ void QOpenGLFramebufferObject::setAttachment(QOpenGLFramebufferObject::Attachmen } /*! - Returns true if the framebuffer object is currently bound to a context, + Returns \c true if the framebuffer object is currently bound to a context, otherwise false is returned. */ @@ -1168,8 +1168,8 @@ bool QOpenGLFramebufferObject::isBound() const /*! \fn bool QOpenGLFramebufferObject::hasOpenGLFramebufferBlit() - Returns true if the OpenGL \c{GL_EXT_framebuffer_blit} extension - is present on this system; otherwise returns false. + Returns \c true if the OpenGL \c{GL_EXT_framebuffer_blit} extension + is present on this system; otherwise returns \c false. \sa blitFramebuffer() */ diff --git a/src/gui/opengl/qopenglfunctions.cpp b/src/gui/opengl/qopenglfunctions.cpp index 60591a34d2..a4ed74637c 100644 --- a/src/gui/opengl/qopenglfunctions.cpp +++ b/src/gui/opengl/qopenglfunctions.cpp @@ -403,7 +403,7 @@ QOpenGLFunctions::OpenGLFeatures QOpenGLFunctions::openGLFeatures() const } /*! - Returns true if \a feature is present on this system's OpenGL + Returns \c true if \a feature is present on this system's OpenGL implementation; false otherwise. It is assumed that the QOpenGLContext associated with this function @@ -441,7 +441,7 @@ QOpenGLExtensions::OpenGLExtensions QOpenGLExtensions::openGLExtensions() } /*! - Returns true if \a extension is present on this system's OpenGL + Returns \c true if \a extension is present on this system's OpenGL implementation; false otherwise. It is assumed that the QOpenGLContext associated with this extension diff --git a/src/gui/opengl/qopenglpaintdevice.cpp b/src/gui/opengl/qopenglpaintdevice.cpp index f0e7e4953f..fa392d16aa 100644 --- a/src/gui/opengl/qopenglpaintdevice.cpp +++ b/src/gui/opengl/qopenglpaintdevice.cpp @@ -348,7 +348,7 @@ void QOpenGLPaintDevice::setPaintFlipped(bool flipped) } /*! - Returns true if painting is flipped around the Y-axis. + Returns \c true if painting is flipped around the Y-axis. \sa setPaintFlipped() */ diff --git a/src/gui/opengl/qopenglshaderprogram.cpp b/src/gui/opengl/qopenglshaderprogram.cpp index c0e250b0fa..ecc38b902c 100644 --- a/src/gui/opengl/qopenglshaderprogram.cpp +++ b/src/gui/opengl/qopenglshaderprogram.cpp @@ -397,7 +397,7 @@ static const char redefineHighp[] = /*! Sets the \a source code for this shader and compiles it. - Returns true if the source was successfully compiled, false otherwise. + Returns \c true if the source was successfully compiled, false otherwise. \sa compileSourceFile() */ @@ -459,7 +459,7 @@ bool QOpenGLShader::compileSourceCode(const char *source) \overload Sets the \a source code for this shader and compiles it. - Returns true if the source was successfully compiled, false otherwise. + Returns \c true if the source was successfully compiled, false otherwise. \sa compileSourceFile() */ @@ -472,7 +472,7 @@ bool QOpenGLShader::compileSourceCode(const QByteArray& source) \overload Sets the \a source code for this shader and compiles it. - Returns true if the source was successfully compiled, false otherwise. + Returns \c true if the source was successfully compiled, false otherwise. \sa compileSourceFile() */ @@ -483,7 +483,7 @@ bool QOpenGLShader::compileSourceCode(const QString& source) /*! Sets the source code for this shader to the contents of \a fileName - and compiles it. Returns true if the file could be opened and the + and compiles it. Returns \c true if the file could be opened and the source compiled, false otherwise. \sa compileSourceCode() @@ -524,7 +524,7 @@ QByteArray QOpenGLShader::sourceCode() const } /*! - Returns true if this shader has been compiled; false otherwise. + Returns \c true if this shader has been compiled; false otherwise. \sa compileSourceCode(), compileSourceFile() */ @@ -668,7 +668,7 @@ bool QOpenGLShaderProgram::init() } /*! - Adds a compiled \a shader to this shader program. Returns true + Adds a compiled \a shader to this shader program. Returns \c true if the shader could be added, or false otherwise. Ownership of the \a shader object remains with the caller. @@ -705,7 +705,7 @@ bool QOpenGLShaderProgram::addShader(QOpenGLShader *shader) /*! Compiles \a source as a shader of the specified \a type and - adds it to this shader program. Returns true if compilation + adds it to this shader program. Returns \c true if compilation was successful, false otherwise. The compilation errors and warnings will be made available via log(). @@ -735,7 +735,7 @@ bool QOpenGLShaderProgram::addShaderFromSourceCode(QOpenGLShader::ShaderType typ \overload Compiles \a source as a shader of the specified \a type and - adds it to this shader program. Returns true if compilation + adds it to this shader program. Returns \c true if compilation was successful, false otherwise. The compilation errors and warnings will be made available via log(). @@ -755,7 +755,7 @@ bool QOpenGLShaderProgram::addShaderFromSourceCode(QOpenGLShader::ShaderType typ \overload Compiles \a source as a shader of the specified \a type and - adds it to this shader program. Returns true if compilation + adds it to this shader program. Returns \c true if compilation was successful, false otherwise. The compilation errors and warnings will be made available via log(). @@ -773,7 +773,7 @@ bool QOpenGLShaderProgram::addShaderFromSourceCode(QOpenGLShader::ShaderType typ /*! Compiles the contents of \a fileName as a shader of the specified - \a type and adds it to this shader program. Returns true if + \a type and adds it to this shader program. Returns \c true if compilation was successful, false otherwise. The compilation errors and warnings will be made available via log(). @@ -865,7 +865,7 @@ void QOpenGLShaderProgram::removeAllShaders() /*! Links together the shaders that were added to this program with - addShader(). Returns true if the link was successful or + addShader(). Returns \c true if the link was successful or false otherwise. If the link failed, the error messages can be retrieved with log(). @@ -922,7 +922,7 @@ bool QOpenGLShaderProgram::link() } /*! - Returns true if this shader program has been linked; false otherwise. + Returns \c true if this shader program has been linked; false otherwise. \sa link() */ @@ -948,7 +948,7 @@ QString QOpenGLShaderProgram::log() const Binds this shader program to the active QOpenGLContext and makes it the current shader program. Any previously bound shader program is released. This is equivalent to calling \c{glUseProgram()} on - programId(). Returns true if the program was successfully bound; + programId(). Returns \c true if the program was successfully bound; false otherwise. If the shader program has not yet been linked, or it needs to be re-linked, this function will call link(). @@ -3195,7 +3195,7 @@ QVector<float> QOpenGLShaderProgram::defaultInnerTessellationLevels() const /*! - Returns true if shader programs written in the OpenGL Shading + Returns \c true if shader programs written in the OpenGL Shading Language (GLSL) are supported on this system; false otherwise. The \a context is used to resolve the GLSL extensions. @@ -3227,7 +3227,7 @@ void QOpenGLShaderProgram::shaderDestroyed() } /*! - Returns true if shader programs of type \a type are supported on + Returns \c true if shader programs of type \a type are supported on this system; false otherwise. The \a context is used to resolve the GLSL extensions. diff --git a/src/gui/opengl/qopengltexture.cpp b/src/gui/opengl/qopengltexture.cpp index a6e1c2953d..fcd556e892 100644 --- a/src/gui/opengl/qopengltexture.cpp +++ b/src/gui/opengl/qopengltexture.cpp @@ -1449,7 +1449,7 @@ void QOpenGLTexture::destroy() } /*! - Returns true if the underlying OpenGL texture object has been created. + Returns \c true if the underlying OpenGL texture object has been created. \sa create(), destroy(), textureId() */ @@ -1532,7 +1532,7 @@ void QOpenGLTexture::release(uint unit, TextureUnitReset reset) } /*! - Returns true if this texture is bound to the corresponding target + Returns \c true if this texture is bound to the corresponding target of the currently active texture unit. \sa bind(), release() @@ -1545,7 +1545,7 @@ bool QOpenGLTexture::isBound() const } /*! - Returns true if this texture is bound to the corresponding target + Returns \c true if this texture is bound to the corresponding target of texture unit \a unit. \sa bind(), release() @@ -2012,7 +2012,7 @@ void QOpenGLTexture::allocateStorage() } /*! - Returns true if server-side storage for this texture as been + Returns \c true if server-side storage for this texture as been allocated. The texture format, dimensions, mipmap levels and array layers @@ -2076,7 +2076,7 @@ QOpenGLTexture *QOpenGLTexture::createTextureView(Target target, } /*! - Returns true if this texture object is actually a view onto another + Returns \c true if this texture object is actually a view onto another texture object. \sa createTextureView() @@ -2227,7 +2227,7 @@ void QOpenGLTexture::setCompressedData(int dataSize, void *data, } /*! - Returns true if your OpenGL implementation and version supports the texture + Returns \c true if your OpenGL implementation and version supports the texture feature \a feature. */ bool QOpenGLTexture::hasFeature(Feature feature) diff --git a/src/gui/opengl/qopengltimerquery.cpp b/src/gui/opengl/qopengltimerquery.cpp index 38e988c4df..c5c3d42e5d 100644 --- a/src/gui/opengl/qopengltimerquery.cpp +++ b/src/gui/opengl/qopengltimerquery.cpp @@ -330,7 +330,7 @@ QOpenGLTimerQuery::~QOpenGLTimerQuery() Creates the underlying OpenGL timer query object. There must be a valid OpenGL context that supports query objects current for this function to succeed. - Returns true if the OpenGL timer query object was successfully created. + Returns \c true if the OpenGL timer query object was successfully created. */ bool QOpenGLTimerQuery::create() { @@ -349,8 +349,8 @@ void QOpenGLTimerQuery::destroy() } /*! - Returns true if the underlying OpenGL query object has been created. If this - returns true and the associated OpenGL context is current, then you are able to issue + Returns \c true if the underlying OpenGL query object has been created. If this + returns \c true and the associated OpenGL context is current, then you are able to issue queries with this object. */ bool QOpenGLTimerQuery::isCreated() const @@ -428,7 +428,7 @@ GLuint64 QOpenGLTimerQuery::waitForTimestamp() const } /*! - Returns true if the OpenGL timer query result is available. + Returns \c true if the OpenGL timer query result is available. This function is non-blocking and ideally should be used to check for the availability of the query result before calling waitForResult(). @@ -757,7 +757,7 @@ int QOpenGLTimeMonitor::sampleCount() const to track the amount of time taken to execute OpenGL commands between successive calls to recordSample(). - Returns true if the OpenGL timer query objects could be created. + Returns \c true if the OpenGL timer query objects could be created. \sa destroy(), setSampleCount(), recordSample() */ @@ -779,8 +779,8 @@ void QOpenGLTimeMonitor::destroy() } /*! - Returns true if the underlying OpenGL query objects have been created. If this - returns true and the associated OpenGL context is current, then you are able to record + Returns \c true if the underlying OpenGL query objects have been created. If this + returns \c true and the associated OpenGL context is current, then you are able to record time samples with this object. */ bool QOpenGLTimeMonitor::isCreated() const @@ -814,7 +814,7 @@ int QOpenGLTimeMonitor::recordSample() } /*! - Returns true if the OpenGL timer query results are available. + Returns \c true if the OpenGL timer query results are available. \sa waitForSamples(), waitForIntervals() */ diff --git a/src/gui/opengl/qopenglvertexarrayobject.cpp b/src/gui/opengl/qopenglvertexarrayobject.cpp index eb7a42f749..16ed79ac10 100644 --- a/src/gui/opengl/qopenglvertexarrayobject.cpp +++ b/src/gui/opengl/qopenglvertexarrayobject.cpp @@ -371,7 +371,7 @@ QOpenGLVertexArrayObject::~QOpenGLVertexArrayObject() Creates the underlying OpenGL vertex array object. There must be a valid OpenGL context that supports vertex array objects current for this function to succeed. - Returns true if the OpenGL vertex array object was successfully created. + Returns \c true if the OpenGL vertex array object was successfully created. */ bool QOpenGLVertexArrayObject::create() { @@ -390,8 +390,8 @@ void QOpenGLVertexArrayObject::destroy() } /*! - Returns true is the underlying OpenGL vertex array object has been created. If this - returns true and the associated OpenGL context is current, then you are able to bind() + Returns \c true is the underlying OpenGL vertex array object has been created. If this + returns \c true and the associated OpenGL context is current, then you are able to bind() this object. */ bool QOpenGLVertexArrayObject::isCreated() const diff --git a/src/gui/opengl/qtriangulator.cpp b/src/gui/opengl/qtriangulator.cpp index d3c80e264f..77da009bf5 100644 --- a/src/gui/opengl/qtriangulator.cpp +++ b/src/gui/opengl/qtriangulator.cpp @@ -347,7 +347,7 @@ bool QIntersectionPoint::operator == (const QIntersectionPoint &other) const return upperLeft == other.upperLeft && xOffset == other.xOffset && yOffset == other.yOffset; } -// Returns true if this point is on the infinite line passing through 'u' and 'v'. +// Returns \c true if this point is on the infinite line passing through 'u' and 'v'. bool QIntersectionPoint::isOnLine(const QPodPoint &u, const QPodPoint &v) const { // TODO: Make code path for coordinates with more than 21 bits. diff --git a/src/gui/painting/qbackingstore.cpp b/src/gui/painting/qbackingstore.cpp index 3a36762502..c44be64fb1 100644 --- a/src/gui/painting/qbackingstore.cpp +++ b/src/gui/painting/qbackingstore.cpp @@ -194,7 +194,7 @@ QSize QBackingStore::size() const Scrolls the given \a area \a dx pixels to the right and \a dy downward; both \a dx and \a dy may be negative. - Returns true if the area was scrolled successfully; false otherwise. + Returns \c true if the area was scrolled successfully; false otherwise. */ bool QBackingStore::scroll(const QRegion &area, int dx, int dy) { diff --git a/src/gui/painting/qbrush.cpp b/src/gui/painting/qbrush.cpp index 4ec47fa4a9..d8dfae1e2c 100644 --- a/src/gui/painting/qbrush.cpp +++ b/src/gui/painting/qbrush.cpp @@ -306,7 +306,7 @@ struct QBrushDataPointerDeleter the style is a gradient. The same is the case if the style is Qt::TexturePattern style unless the current texture is a QBitmap. - The isOpaque() function returns true if the brush is fully opaque + The isOpaque() function returns \c true if the brush is fully opaque otherwise false. A brush is considered opaque if: \list @@ -830,7 +830,7 @@ Q_GUI_EXPORT bool qt_isExtendedRadialGradient(const QBrush &brush) } /*! - Returns true if the brush is fully opaque otherwise false. A brush + Returns \c true if the brush is fully opaque otherwise false. A brush is considered opaque if: \list @@ -912,8 +912,8 @@ void QBrush::setTransform(const QTransform &matrix) /*! \fn bool QBrush::operator!=(const QBrush &brush) const - Returns true if the brush is different from the given \a brush; - otherwise returns false. + Returns \c true if the brush is different from the given \a brush; + otherwise returns \c false. Two brushes are different if they have different styles, colors or transforms or different pixmaps or gradients depending on the style. @@ -924,8 +924,8 @@ void QBrush::setTransform(const QTransform &matrix) /*! \fn bool QBrush::operator==(const QBrush &brush) const - Returns true if the brush is equal to the given \a brush; - otherwise returns false. + Returns \c true if the brush is equal to the given \a brush; + otherwise returns \c false. Two brushes are equal if they have equal styles, colors and transforms and equal pixmaps or gradients depending on the style. @@ -1491,15 +1491,15 @@ void QGradient::setInterpolationMode(InterpolationMode mode) \fn bool QGradient::operator!=(const QGradient &gradient) const \since 4.2 - Returns true if the gradient is the same as the other \a gradient - specified; otherwise returns false. + Returns \c true if the gradient is the same as the other \a gradient + specified; otherwise returns \c false. \sa operator==() */ /*! - Returns true if the gradient is the same as the other \a gradient - specified; otherwise returns false. + Returns \c true if the gradient is the same as the other \a gradient + specified; otherwise returns \c false. \sa operator!=() */ diff --git a/src/gui/painting/qcolor.cpp b/src/gui/painting/qcolor.cpp index c93320c491..706273c151 100644 --- a/src/gui/painting/qcolor.cpp +++ b/src/gui/painting/qcolor.cpp @@ -489,7 +489,7 @@ QColor::QColor(Spec spec) /*! \fn bool QColor::isValid() const - Returns true if the color is valid; otherwise returns false. + Returns \c true if the color is valid; otherwise returns \c false. */ /*! @@ -557,7 +557,7 @@ void QColor::setNamedColor(const QString &name) /*! \since 4.7 - Returns true if the \a name is a valid color name and can + Returns \c true if the \a name is a valid color name and can be used to construct a valid QColor object, otherwise returns false. @@ -2338,8 +2338,8 @@ QColor &QColor::operator=(Qt::GlobalColor color) } /*! - Returns true if this color has the same RGB and alpha values as \a color; - otherwise returns false. + Returns \c true if this color has the same RGB and alpha values as \a color; + otherwise returns \c false. */ bool QColor::operator==(const QColor &color) const { @@ -2366,8 +2366,8 @@ bool QColor::operator==(const QColor &color) const } /*! - Returns true if this color has a different RGB and alpha values from - \a color; otherwise returns false. + Returns \c true if this color has a different RGB and alpha values from + \a color; otherwise returns \c false. */ bool QColor::operator!=(const QColor &color) const { return !operator==(color); } diff --git a/src/gui/painting/qmatrix.cpp b/src/gui/painting/qmatrix.cpp index fe09e5568d..c44c89c8ee 100644 --- a/src/gui/painting/qmatrix.cpp +++ b/src/gui/painting/qmatrix.cpp @@ -82,9 +82,9 @@ QT_BEGIN_NAMESPACE transformed into a \e polygon (mapped to the coordinate system defined by \e this matrix), using the mapToPolygon() function. - QMatrix provides the isIdentity() function which returns true if + QMatrix provides the isIdentity() function which returns \c true if the matrix is the identity matrix, and the isInvertible() function - which returns true if the matrix is non-singular (i.e. AB = BA = + which returns \c true if the matrix is non-singular (i.e. AB = BA = I). The inverted() function returns an inverted copy of \e this matrix if it is invertible (otherwise it returns the identity matrix). In addition, QMatrix provides the determinant() function @@ -817,8 +817,8 @@ void QMatrix::reset() /*! \fn bool QMatrix::isIdentity() const - Returns true if the matrix is the identity matrix, otherwise - returns false. + Returns \c true if the matrix is the identity matrix, otherwise + returns \c false. \sa reset() */ @@ -919,7 +919,7 @@ QMatrix &QMatrix::rotate(qreal a) /*! \fn bool QMatrix::isInvertible() const - Returns true if the matrix is invertible, otherwise returns false. + Returns \c true if the matrix is invertible, otherwise returns \c false. \sa inverted() */ @@ -966,8 +966,8 @@ QMatrix QMatrix::inverted(bool *invertible) const /*! \fn bool QMatrix::operator==(const QMatrix &matrix) const - Returns true if this matrix is equal to the given \a matrix, - otherwise returns false. + Returns \c true if this matrix is equal to the given \a matrix, + otherwise returns \c false. */ bool QMatrix::operator==(const QMatrix &m) const @@ -983,8 +983,8 @@ bool QMatrix::operator==(const QMatrix &m) const /*! \fn bool QMatrix::operator!=(const QMatrix &matrix) const - Returns true if this matrix is not equal to the given \a matrix, - otherwise returns false. + Returns \c true if this matrix is not equal to the given \a matrix, + otherwise returns \c false. */ bool QMatrix::operator!=(const QMatrix &m) const @@ -1159,7 +1159,7 @@ QDebug operator<<(QDebug dbg, const QMatrix &m) \brief The qFuzzyCompare function is for comparing two matrices using a fuzziness factor. - Returns true if \a m1 and \a m2 are equal, allowing for a small + Returns \c true if \a m1 and \a m2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise. */ diff --git a/src/gui/painting/qpaintdevice.qdoc b/src/gui/painting/qpaintdevice.qdoc index 993b23850e..150ba10955 100644 --- a/src/gui/painting/qpaintdevice.qdoc +++ b/src/gui/painting/qpaintdevice.qdoc @@ -149,9 +149,9 @@ /*! \fn bool QPaintDevice::paintingActive() const - Returns true if the device is currently being painted on, i.e. someone has + Returns \c true if the device is currently being painted on, i.e. someone has called QPainter::begin() but not yet called QPainter::end() for - this device; otherwise returns false. + this device; otherwise returns \c false. \sa QPainter::isActive() */ diff --git a/src/gui/painting/qpaintengine.cpp b/src/gui/painting/qpaintengine.cpp index aa175c2d65..f1eaea0f6b 100644 --- a/src/gui/painting/qpaintengine.cpp +++ b/src/gui/painting/qpaintengine.cpp @@ -392,8 +392,8 @@ void QPaintEngine::drawPolygon(const QPoint *points, int pointCount, PolygonDraw /*! \fn bool QPaintEngine::isActive() const - Returns true if the paint engine is actively drawing; otherwise - returns false. + Returns \c true if the paint engine is actively drawing; otherwise + returns \c false. \sa setActive() */ @@ -657,8 +657,8 @@ void QPaintEngine::drawImage(const QRectF &r, const QImage &image, const QRectF /*! \fn bool QPaintEngine::hasFeature(PaintEngineFeatures feature) const - Returns true if the paint engine supports the specified \a - feature; otherwise returns false. + Returns \c true if the paint engine supports the specified \a + feature; otherwise returns \c false. */ /*! @@ -666,7 +666,7 @@ void QPaintEngine::drawImage(const QRectF &r, const QImage &image, const QRectF \internal - Returns true if the paint engine is a QPaintEngineEx derivative. + Returns \c true if the paint engine is a QPaintEngineEx derivative. */ /*! diff --git a/src/gui/painting/qpaintengine_raster.cpp b/src/gui/painting/qpaintengine_raster.cpp index 824dbf7ae8..4a26da104d 100644 --- a/src/gui/painting/qpaintengine_raster.cpp +++ b/src/gui/painting/qpaintengine_raster.cpp @@ -2887,7 +2887,7 @@ bool QRasterPaintEngine::drawCachedGlyphs(int numGlyphs, const glyph_t *glyphs, /*! - * Returns true if the rectangle is completely within the current clip + * Returns \c true if the rectangle is completely within the current clip * state of the paint engine. */ bool QRasterPaintEnginePrivate::isUnclipped_normalized(const QRect &r) const diff --git a/src/gui/painting/qpainter.cpp b/src/gui/painting/qpainter.cpp index b315017d6d..4c02abdfd5 100644 --- a/src/gui/painting/qpainter.cpp +++ b/src/gui/painting/qpainter.cpp @@ -241,7 +241,7 @@ QTransform QPainterPrivate::hidpiScaleTransform() const /* \internal - Returns true if using a shared painter; otherwise false. + Returns \c true if using a shared painter; otherwise false. */ bool QPainterPrivate::attachPainterPrivate(QPainter *q, QPaintDevice *pdev) { @@ -1510,8 +1510,8 @@ QPaintDevice *QPainter::device() const } /*! - Returns true if begin() has been called and end() has not yet been - called; otherwise returns false. + Returns \c true if begin() has been called and end() has not yet been + called; otherwise returns \c false. \sa begin(), QPaintDevice::paintingActive() */ @@ -1660,8 +1660,8 @@ void QPainter::restore() \fn bool QPainter::begin(QPaintDevice *device) - Begins painting the paint \a device and returns true if - successful; otherwise returns false. + Begins painting the paint \a device and returns \c true if + successful; otherwise returns \c false. Notice that all painter settings (setPen(), setBrush() etc.) are reset to default values when begin() is called. @@ -1856,7 +1856,7 @@ bool QPainter::begin(QPaintDevice *pd) don't normally need to call this since it is called by the destructor. - Returns true if the painter is no longer active; otherwise returns false. + Returns \c true if the painter is no longer active; otherwise returns \c false. \sa begin(), isActive() */ @@ -2420,7 +2420,7 @@ const QBrush &QPainter::background() const /*! - Returns true if clipping has been set; otherwise returns false. + Returns \c true if clipping has been set; otherwise returns \c false. \sa setClipping(), {QPainter#Clipping}{Clipping} */ @@ -3058,7 +3058,7 @@ void QPainter::setWorldMatrixEnabled(bool enable) /*! \since 4.2 - Returns true if world transformation is enabled; otherwise returns + Returns \c true if world transformation is enabled; otherwise returns false. \sa setWorldMatrixEnabled(), worldTransform(), {Coordinate System} @@ -7078,13 +7078,13 @@ QPainter::RenderHints QPainter::renderHints() const \fn bool QPainter::testRenderHint(RenderHint hint) const \since 4.3 - Returns true if \a hint is set; otherwise returns false. + Returns \c true if \a hint is set; otherwise returns \c false. \sa renderHints(), setRenderHint() */ /*! - Returns true if view transformation is enabled; otherwise returns + Returns \c true if view transformation is enabled; otherwise returns false. \sa setViewTransformEnabled(), worldTransform() diff --git a/src/gui/painting/qpainterpath.cpp b/src/gui/painting/qpainterpath.cpp index 1e36cd224a..156e411154 100644 --- a/src/gui/painting/qpainterpath.cpp +++ b/src/gui/painting/qpainterpath.cpp @@ -395,8 +395,8 @@ static void qt_debug_path(const QPainterPath &path) \fn bool QPainterPath::Element::operator==(const Element &other) const \since 4.2 - Returns true if this element is equal to \a other; - otherwise returns false. + Returns \c true if this element is equal to \a other; + otherwise returns \c false. \sa operator!=() */ @@ -405,8 +405,8 @@ static void qt_debug_path(const QPainterPath &path) \fn bool QPainterPath::Element::operator!=(const Element &other) const \since 4.2 - Returns true if this element is not equal to \a other; - otherwise returns false. + Returns \c true if this element is not equal to \a other; + otherwise returns \c false. \sa operator==() */ @@ -414,7 +414,7 @@ static void qt_debug_path(const QPainterPath &path) /*! \fn bool QPainterPath::Element::isCurveTo () const - Returns true if the element is a curve, otherwise returns false. + Returns \c true if the element is a curve, otherwise returns \c false. \sa type, QPainterPath::CurveToElement */ @@ -422,7 +422,7 @@ static void qt_debug_path(const QPainterPath &path) /*! \fn bool QPainterPath::Element::isLineTo () const - Returns true if the element is a line, otherwise returns false. + Returns \c true if the element is a line, otherwise returns \c false. \sa type, QPainterPath::LineToElement */ @@ -430,8 +430,8 @@ static void qt_debug_path(const QPainterPath &path) /*! \fn bool QPainterPath::Element::isMoveTo () const - Returns true if the element is moving the current position, - otherwise returns false. + Returns \c true if the element is moving the current position, + otherwise returns \c false. \sa type, QPainterPath::MoveToElement */ @@ -1485,8 +1485,8 @@ QRectF QPainterPath::controlPointRect() const /*! \fn bool QPainterPath::isEmpty() const - Returns true if either there are no elements in this path, or if the only - element is a MoveToElement; otherwise returns false. + Returns \c true if either there are no elements in this path, or if the only + element is a MoveToElement; otherwise returns \c false. \sa elementCount() */ @@ -1806,8 +1806,8 @@ static void qt_painterpath_isect_curve(const QBezier &bezier, const QPointF &pt, /*! \fn bool QPainterPath::contains(const QPointF &point) const - Returns true if the given \a point is inside the path, otherwise - returns false. + Returns \c true if the given \a point is inside the path, otherwise + returns \c false. \sa intersects() */ @@ -1982,7 +1982,7 @@ static bool qt_isect_curve_vertical(const QBezier &bezier, qreal x, qreal y1, qr } /* - Returns true if any lines or curves cross the four edges in of rect + Returns \c true if any lines or curves cross the four edges in of rect */ static bool qt_painterpath_check_crossing(const QPainterPath *path, const QRectF &rect) { @@ -2040,8 +2040,8 @@ static bool qt_painterpath_check_crossing(const QPainterPath *path, const QRectF /*! \fn bool QPainterPath::intersects(const QRectF &rectangle) const - Returns true if any point in the given \a rectangle intersects the - path; otherwise returns false. + Returns \c true if any point in the given \a rectangle intersects the + path; otherwise returns \c false. There is an intersection if any of the lines making up the rectangle crosses a part of the path or if any part of the @@ -2149,8 +2149,8 @@ QPainterPath QPainterPath::translated(qreal dx, qreal dy) const /*! \fn bool QPainterPath::contains(const QRectF &rectangle) const - Returns true if the given \a rectangle is inside the path, - otherwise returns false. + Returns \c true if the given \a rectangle is inside the path, + otherwise returns \c false. */ bool QPainterPath::contains(const QRectF &rect) const { @@ -2233,7 +2233,7 @@ static inline bool epsilonCompare(const QPointF &a, const QPointF &b, const QSiz } /*! - Returns true if this painterpath is equal to the given \a path. + Returns \c true if this painterpath is equal to the given \a path. Note that comparing paths may involve a per element comparison which can be slow for complex paths. @@ -2268,7 +2268,7 @@ bool QPainterPath::operator==(const QPainterPath &path) const } /*! - Returns true if this painter path differs from the given \a path. + Returns \c true if this painter path differs from the given \a path. Note that comparing paths may involve a per element comparison which can be slow for complex paths. @@ -3330,8 +3330,8 @@ QPainterPath QPainterPath::simplified() const /*! \since 4.3 - Returns true if the current path intersects at any point the given path \a p. - Also returns true if the current path contains or is contained by any part of \a p. + Returns \c true if the current path intersects at any point the given path \a p. + Also returns \c true if the current path contains or is contained by any part of \a p. Set operations on paths will treat the paths as areas. Non-closed paths will be treated as implicitly closed. @@ -3351,8 +3351,8 @@ bool QPainterPath::intersects(const QPainterPath &p) const /*! \since 4.3 - Returns true if the given path \a p is contained within - the current path. Returns false if any edges of the current path and + Returns \c true if the given path \a p is contained within + the current path. Returns \c false if any edges of the current path and \a p intersect. Set operations on paths will treat the paths as areas. Non-closed diff --git a/src/gui/painting/qpen.cpp b/src/gui/painting/qpen.cpp index a7c4a0eae1..6a3eacd67a 100644 --- a/src/gui/painting/qpen.cpp +++ b/src/gui/painting/qpen.cpp @@ -778,7 +778,7 @@ void QPen::setBrush(const QBrush &brush) /*! - Returns true if the pen has a solid fill, otherwise false. + Returns \c true if the pen has a solid fill, otherwise false. \sa style(), dashPattern() */ @@ -789,7 +789,7 @@ bool QPen::isSolid() const /*! - Returns true if the pen is cosmetic; otherwise returns false. + Returns \c true if the pen is cosmetic; otherwise returns \c false. Cosmetic pens are used to draw strokes that have a constant width regardless of any transformations applied to the QPainter they are @@ -827,7 +827,7 @@ void QPen::setCosmetic(bool cosmetic) /*! \fn bool QPen::operator!=(const QPen &pen) const - Returns true if the pen is different from the given \a pen; + Returns \c true if the pen is different from the given \a pen; otherwise false. Two pens are different if they have different styles, widths or colors. @@ -837,7 +837,7 @@ void QPen::setCosmetic(bool cosmetic) /*! \fn bool QPen::operator==(const QPen &pen) const - Returns true if the pen is equal to the given \a pen; otherwise + Returns \c true if the pen is equal to the given \a pen; otherwise false. Two pens are equal if they have equal styles, widths and colors. diff --git a/src/gui/painting/qplatformbackingstore.cpp b/src/gui/painting/qplatformbackingstore.cpp index 74e9af19ab..feec0c7f3d 100644 --- a/src/gui/painting/qplatformbackingstore.cpp +++ b/src/gui/painting/qplatformbackingstore.cpp @@ -135,7 +135,7 @@ void QPlatformBackingStore::endPaint() Scrolls the given \a area \a dx pixels to the right and \a dy downward; both \a dx and \a dy may be negative. - Returns true if the area was scrolled successfully; false otherwise. + Returns \c true if the area was scrolled successfully; false otherwise. */ bool QPlatformBackingStore::scroll(const QRegion &area, int dx, int dy) { diff --git a/src/gui/painting/qpolygon.cpp b/src/gui/painting/qpolygon.cpp index 34215b53b0..ef8fc28f12 100644 --- a/src/gui/painting/qpolygon.cpp +++ b/src/gui/painting/qpolygon.cpp @@ -642,7 +642,7 @@ QPolygonF QPolygonF::translated(const QPointF &offset) const /*! \fn bool QPolygonF::isClosed() const - Returns true if the polygon is closed; otherwise returns false. + Returns \c true if the polygon is closed; otherwise returns \c false. A polygon is said to be closed if its start point and end point are equal. @@ -824,8 +824,8 @@ QDebug operator<<(QDebug dbg, const QPolygonF &a) \fn bool QPolygonF::containsPoint(const QPointF &point, Qt::FillRule fillRule) const - Returns true if the given \a point is inside the polygon according to - the specified \a fillRule; otherwise returns false. + Returns \c true if the given \a point is inside the polygon according to + the specified \a fillRule; otherwise returns \c false. */ bool QPolygonF::containsPoint(const QPointF &pt, Qt::FillRule fillRule) const { @@ -855,8 +855,8 @@ bool QPolygonF::containsPoint(const QPointF &pt, Qt::FillRule fillRule) const \since 4.3 \fn bool QPolygon::containsPoint(const QPoint &point, Qt::FillRule fillRule) const - Returns true if the given \a point is inside the polygon according to - the specified \a fillRule; otherwise returns false. + Returns \c true if the given \a point is inside the polygon according to + the specified \a fillRule; otherwise returns \c false. */ bool QPolygon::containsPoint(const QPoint &pt, Qt::FillRule fillRule) const { diff --git a/src/gui/painting/qregion.cpp b/src/gui/painting/qregion.cpp index 913daee3e1..f58cd1c428 100644 --- a/src/gui/painting/qregion.cpp +++ b/src/gui/painting/qregion.cpp @@ -591,8 +591,8 @@ QRegion& QRegion::operator^=(const QRegion &r) /*! \fn bool QRegion::operator!=(const QRegion &other) const - Returns true if this region is different from the \a other region; - otherwise returns false. + Returns \c true if this region is different from the \a other region; + otherwise returns \c false. */ /*! @@ -606,7 +606,7 @@ QRegion::operator QVariant() const /*! \fn bool QRegion::operator==(const QRegion &r) const - Returns true if the region is equal to \a r; otherwise returns + Returns \c true if the region is equal to \a r; otherwise returns false. */ @@ -659,8 +659,8 @@ inline bool rect_intersects(const QRect &r1, const QRect &r2) /*! \since 4.2 - Returns true if this region intersects with \a region, otherwise - returns false. + Returns \c true if this region intersects with \a region, otherwise + returns \c false. */ bool QRegion::intersects(const QRegion ®ion) const { @@ -686,8 +686,8 @@ bool QRegion::intersects(const QRegion ®ion) const \fn bool QRegion::intersects(const QRect &rect) const \since 4.2 - Returns true if this region intersects with \a rect, otherwise - returns false. + Returns \c true if this region intersects with \a rect, otherwise + returns \c false. */ @@ -712,7 +712,7 @@ QRegion QRegion::intersect(const QRect &r) const /*! \fn bool QRegion::isEmpty() const - Returns true if the region is empty; otherwise returns false. An + Returns \c true if the region is empty; otherwise returns \c false. An empty region is a region that contains no points. Example: @@ -723,7 +723,7 @@ QRegion QRegion::intersect(const QRect &r) const \fn bool QRegion::isNull() const \since 5.0 - Returns true if the region is empty; otherwise returns false. An + Returns \c true if the region is empty; otherwise returns \c false. An empty region is a region that contains no points. This function is the same as isEmpty @@ -733,16 +733,16 @@ QRegion QRegion::intersect(const QRect &r) const /*! \fn bool QRegion::contains(const QPoint &p) const - Returns true if the region contains the point \a p; otherwise - returns false. + Returns \c true if the region contains the point \a p; otherwise + returns \c false. */ /*! \fn bool QRegion::contains(const QRect &r) const \overload - Returns true if the region overlaps the rectangle \a r; otherwise - returns false. + Returns \c true if the region overlaps the rectangle \a r; otherwise + returns \c false. */ /*! @@ -1099,7 +1099,7 @@ struct QRegionPrivate { void intersect(const QRect &r); /* - * Returns true if r is guaranteed to be fully contained in this region. + * Returns \c true if r is guaranteed to be fully contained in this region. * A false return value does not guarantee the opposite. */ inline bool contains(const QRegionPrivate &r) const { @@ -1113,7 +1113,7 @@ struct QRegionPrivate { } /* - * Returns true if this region is guaranteed to be fully contained in r. + * Returns \c true if this region is guaranteed to be fully contained in r. */ inline bool within(const QRect &r1) const { const QRect &r2 = extents; @@ -4167,7 +4167,7 @@ QRect QRegion::boundingRect() const } /*! \internal - Returns true if \a rect is guaranteed to be fully contained in \a region. + Returns \c true if \a rect is guaranteed to be fully contained in \a region. A false return value does not guarantee the opposite. */ Q_GUI_EXPORT diff --git a/src/gui/painting/qstroker.cpp b/src/gui/painting/qstroker.cpp index 2a5cf49d53..d6ac03fe28 100644 --- a/src/gui/painting/qstroker.cpp +++ b/src/gui/painting/qstroker.cpp @@ -627,7 +627,7 @@ void QStroker::joinPoints(qfixed focal_x, qfixed focal_y, const QLineF &nextLine /* Strokes a subpath side using the \a it as source. Results are put into - \a stroke. The function returns true if the subpath side was closed. + \a stroke. The function returns \c true if the subpath side was closed. If \a capFirst is true, we will use capPoints instead of joinPoints to connect the first segment, other segments will be joined using joinPoints. This is to put capping in order... diff --git a/src/gui/painting/qtransform.cpp b/src/gui/painting/qtransform.cpp index a07b5def5d..30673d90fe 100644 --- a/src/gui/painting/qtransform.cpp +++ b/src/gui/painting/qtransform.cpp @@ -125,9 +125,9 @@ QT_BEGIN_NAMESPACE transformed into a \e polygon (mapped to the coordinate system defined by \e this matrix), using the mapToPolygon() function. - QTransform provides the isIdentity() function which returns true if + QTransform provides the isIdentity() function which returns \c true if the matrix is the identity matrix, and the isInvertible() function - which returns true if the matrix is non-singular (i.e. AB = BA = + which returns \c true if the matrix is non-singular (i.e. AB = BA = I). The inverted() function returns an inverted copy of \e this matrix if it is invertible (otherwise it returns the identity matrix), and adjoint() returns the matrix's classical adjoint. @@ -763,8 +763,8 @@ QTransform & QTransform::rotateRadians(qreal a, Qt::Axis axis) /*! \fn bool QTransform::operator==(const QTransform &matrix) const - Returns true if this matrix is equal to the given \a matrix, - otherwise returns false. + Returns \c true if this matrix is equal to the given \a matrix, + otherwise returns \c false. */ bool QTransform::operator==(const QTransform &o) const { @@ -781,8 +781,8 @@ bool QTransform::operator==(const QTransform &o) const /*! \fn bool QTransform::operator!=(const QTransform &matrix) const - Returns true if this matrix is not equal to the given \a matrix, - otherwise returns false. + Returns \c true if this matrix is not equal to the given \a matrix, + otherwise returns \c false. */ bool QTransform::operator!=(const QTransform &o) const { @@ -1718,7 +1718,7 @@ QPolygon QTransform::mapToPolygon(const QRect &rect) const /*! Creates a transformation matrix, \a trans, that maps a unit square - to a four-sided polygon, \a quad. Returns true if the transformation + to a four-sided polygon, \a quad. Returns \c true if the transformation is constructed or false if such a transformation does not exist. \sa quadToSquare(), quadToQuad() @@ -1783,7 +1783,7 @@ bool QTransform::squareToQuad(const QPolygonF &quad, QTransform &trans) \fn bool QTransform::quadToSquare(const QPolygonF &quad, QTransform &trans) Creates a transformation matrix, \a trans, that maps a four-sided polygon, - \a quad, to a unit square. Returns true if the transformation is constructed + \a quad, to a unit square. Returns \c true if the transformation is constructed or false if such a transformation does not exist. \sa squareToQuad(), quadToQuad() @@ -1802,7 +1802,7 @@ bool QTransform::quadToSquare(const QPolygonF &quad, QTransform &trans) /*! Creates a transformation matrix, \a trans, that maps a four-sided polygon, \a one, to another four-sided polygon, \a two. - Returns true if the transformation is possible; otherwise returns + Returns \c true if the transformation is possible; otherwise returns false. This is a convenience method combining quadToSquare() and @@ -2098,7 +2098,7 @@ QTransform::operator QVariant() const /*! \fn bool QTransform::isInvertible() const - Returns true if the matrix is invertible, otherwise returns false. + Returns \c true if the matrix is invertible, otherwise returns \c false. \sa inverted() */ @@ -2221,8 +2221,8 @@ QTransform::operator QVariant() const /*! \fn bool QTransform::isIdentity() const - Returns true if the matrix is the identity matrix, otherwise - returns false. + Returns \c true if the matrix is the identity matrix, otherwise + returns \c false. \sa reset() */ @@ -2230,15 +2230,15 @@ QTransform::operator QVariant() const /*! \fn bool QTransform::isAffine() const - Returns true if the matrix represent an affine transformation, - otherwise returns false. + Returns \c true if the matrix represent an affine transformation, + otherwise returns \c false. */ /*! \fn bool QTransform::isScaling() const - Returns true if the matrix represents a scaling - transformation, otherwise returns false. + Returns \c true if the matrix represents a scaling + transformation, otherwise returns \c false. \sa reset() */ @@ -2246,8 +2246,8 @@ QTransform::operator QVariant() const /*! \fn bool QTransform::isRotating() const - Returns true if the matrix represents some kind of a - rotating transformation, otherwise returns false. + Returns \c true if the matrix represents some kind of a + rotating transformation, otherwise returns \c false. \note A rotation transformation of 180 degrees and/or 360 degrees is treated as a scaling transformation. @@ -2257,8 +2257,8 @@ QTransform::operator QVariant() const /*! \fn bool QTransform::isTranslating() const - Returns true if the matrix represents a translating - transformation, otherwise returns false. + Returns \c true if the matrix represents a translating + transformation, otherwise returns \c false. \sa reset() */ @@ -2269,7 +2269,7 @@ QTransform::operator QVariant() const \relates QTransform \since 4.6 - Returns true if \a t1 and \a t2 are equal, allowing for a small + Returns \c true if \a t1 and \a t2 are equal, allowing for a small fuzziness factor for floating-point comparisons; false otherwise. */ diff --git a/src/gui/text/qcssparser.cpp b/src/gui/text/qcssparser.cpp index 9c7a57df3d..edf10169b1 100644 --- a/src/gui/text/qcssparser.cpp +++ b/src/gui/text/qcssparser.cpp @@ -1141,7 +1141,7 @@ static bool setFontWeightFromValue(const QCss::Value &value, QFont *font) /** \internal * parse the font family from the values (starting from index \a start) * and set it the \a font - * The function returns true if a family was extracted. + * The function returns \c true if a family was extracted. */ static bool setFontFamilyFromValues(const QVector<QCss::Value> &values, QFont *font, int start = 0) { diff --git a/src/gui/text/qfont.cpp b/src/gui/text/qfont.cpp index 2a9cac352d..a410004c06 100644 --- a/src/gui/text/qfont.cpp +++ b/src/gui/text/qfont.cpp @@ -355,7 +355,7 @@ QFontEngineData::~QFontEngineData() attributes, or if no matching font exists, Qt will use the closest matching installed font. The attributes of the font that is actually used are retrievable from a QFontInfo object. If the - window system provides an exact match exactMatch() returns true. + window system provides an exact match exactMatch() returns \c true. Use QFontMetrics to get measurements, e.g. the pixel length of a string using QFontMetrics::width(). @@ -1049,7 +1049,7 @@ int QFont::pixelSize() const /*! \fn bool QFont::italic() const - Returns true if the style() of the font is not QFont::StyleNormal + Returns \c true if the style() of the font is not QFont::StyleNormal \sa setItalic(), style() */ @@ -1139,8 +1139,8 @@ void QFont::setWeight(int weight) /*! \fn bool QFont::bold() const - Returns true if weight() is a value greater than - \l{Weight}{QFont::Normal}; otherwise returns false. + Returns \c true if weight() is a value greater than + \l{Weight}{QFont::Normal}; otherwise returns \c false. \sa weight(), setBold(), QFontInfo::bold() */ @@ -1158,7 +1158,7 @@ void QFont::setWeight(int weight) */ /*! - Returns true if underline has been set; otherwise returns false. + Returns \c true if underline has been set; otherwise returns \c false. \sa setUnderline() */ @@ -1185,7 +1185,7 @@ void QFont::setUnderline(bool enable) } /*! - Returns true if overline has been set; otherwise returns false. + Returns \c true if overline has been set; otherwise returns \c false. \sa setOverline() */ @@ -1211,7 +1211,7 @@ void QFont::setOverline(bool enable) } /*! - Returns true if strikeout has been set; otherwise returns false. + Returns \c true if strikeout has been set; otherwise returns \c false. \sa setStrikeOut() */ @@ -1238,7 +1238,7 @@ void QFont::setStrikeOut(bool enable) } /*! - Returns true if fixed pitch has been set; otherwise returns false. + Returns \c true if fixed pitch has been set; otherwise returns \c false. \sa setFixedPitch(), QFontInfo::fixedPitch() */ @@ -1266,7 +1266,7 @@ void QFont::setFixedPitch(bool enable) } /*! - Returns true if kerning should be used when drawing text with this font. + Returns \c true if kerning should be used when drawing text with this font. \sa setKerning() */ @@ -1671,7 +1671,7 @@ void QFont::setRawMode(bool enable) } /*! - Returns true if a window system font exactly matching the settings + Returns \c true if a window system font exactly matching the settings of this font is available. \sa QFontInfo @@ -1686,7 +1686,7 @@ bool QFont::exactMatch() const } /*! - Returns true if this font is equal to \a f; otherwise returns + Returns \c true if this font is equal to \a f; otherwise returns false. Two QFonts are considered equal if their font attributes are @@ -1714,7 +1714,7 @@ bool QFont::operator==(const QFont &f) const /*! Provides an arbitrary comparison of this font and font \a f. - All that is guaranteed is that the operator returns false if both + All that is guaranteed is that the operator returns \c false if both fonts are equal and that (f1 \< f2) == !(f2 \< f1) if the fonts are not equal. @@ -1750,8 +1750,8 @@ bool QFont::operator<(const QFont &f) const /*! - Returns true if this font is different from \a f; otherwise - returns false. + Returns \c true if this font is different from \a f; otherwise + returns \c false. Two QFonts are considered to be different if their font attributes are different. If rawMode() is enabled for both fonts, only the @@ -1773,7 +1773,7 @@ QFont::operator QVariant() const } /*! - Returns true if this font and \a f are copies of each other, i.e. + Returns \c true if this font and \a f are copies of each other, i.e. one of them was created as a copy of the other and neither has been modified since. This is much stricter than equality. @@ -1785,8 +1785,8 @@ bool QFont::isCopyOf(const QFont & f) const } /*! - Returns true if raw mode is used for font name matching; otherwise - returns false. + Returns \c true if raw mode is used for font name matching; otherwise + returns \c false. \sa setRawMode(), rawName() */ @@ -2470,8 +2470,8 @@ int QFontInfo::weight() const /*! \fn bool QFontInfo::bold() const - Returns true if weight() would return a value greater than - QFont::Normal; otherwise returns false. + Returns \c true if weight() would return a value greater than + QFont::Normal; otherwise returns \c false. \sa weight(), QFont::bold() */ @@ -2556,7 +2556,7 @@ QFont::StyleHint QFontInfo::styleHint() const } /*! - Returns true if the font is a raw mode font; otherwise returns + Returns \c true if the font is a raw mode font; otherwise returns false. If it is a raw mode font, all other functions in QFontInfo will @@ -2571,8 +2571,8 @@ bool QFontInfo::rawMode() const } /*! - Returns true if the matched window system font is exactly the same - as the one specified by the font; otherwise returns false. + Returns \c true if the matched window system font is exactly the same + as the one specified by the font; otherwise returns \c false. \sa QFont::exactMatch() */ diff --git a/src/gui/text/qfontdatabase.cpp b/src/gui/text/qfontdatabase.cpp index 6703f66e29..ff050d1758 100644 --- a/src/gui/text/qfontdatabase.cpp +++ b/src/gui/text/qfontdatabase.cpp @@ -1238,8 +1238,8 @@ QStringList QFontDatabase::styles(const QString &family) const } /*! - Returns true if the font that has family \a family and style \a - style is fixed pitch; otherwise returns false. + Returns \c true if the font that has family \a family and style \a + style is fixed pitch; otherwise returns \c false. */ bool QFontDatabase::isFixedPitch(const QString &family, @@ -1259,8 +1259,8 @@ bool QFontDatabase::isFixedPitch(const QString &family, } /*! - Returns true if the font that has family \a family and style \a - style is a scalable bitmap font; otherwise returns false. Scaling + Returns \c true if the font that has family \a family and style \a + style is a scalable bitmap font; otherwise returns \c false. Scaling a bitmap font usually produces an unattractive hardly readable result, because the pixels of the font are scaled. If you need to scale a bitmap font it is better to scale it to one of the fixed @@ -1303,9 +1303,9 @@ bool QFontDatabase::isBitmapScalable(const QString &family, /*! - Returns true if the font that has family \a family and style \a - style is smoothly scalable; otherwise returns false. If this - function returns true, it's safe to scale this font to any size, + Returns \c true if the font that has family \a family and style \a + style is smoothly scalable; otherwise returns \c false. If this + function returns \c true, it's safe to scale this font to any size, and the result will always look attractive. \sa isScalable(), isBitmapScalable() @@ -1342,8 +1342,8 @@ bool QFontDatabase::isSmoothlyScalable(const QString &family, const QString &sty } /*! - Returns true if the font that has family \a family and style \a - style is scalable; otherwise returns false. + Returns \c true if the font that has family \a family and style \a + style is scalable; otherwise returns \c false. \sa isBitmapScalable(), isSmoothlyScalable() */ @@ -1532,8 +1532,8 @@ QList<int> QFontDatabase::standardSizes() /*! - Returns true if the font that has family \a family and style \a - style is italic; otherwise returns false. + Returns \c true if the font that has family \a family and style \a + style is italic; otherwise returns \c false. \sa weight(), bold() */ @@ -1565,8 +1565,8 @@ bool QFontDatabase::italic(const QString &family, const QString &style) const /*! - Returns true if the font that has family \a family and style \a - style is bold; otherwise returns false. + Returns \c true if the font that has family \a family and style \a + style is bold; otherwise returns \c false. \sa italic(), weight() */ @@ -2144,8 +2144,8 @@ QFont QFontDatabase::systemFont(QFontDatabase::SystemFont type) \since 4.2 Removes the previously loaded application font identified by \a - id. Returns true if unloading of the font succeeded; otherwise - returns false. + id. Returns \c true if unloading of the font succeeded; otherwise + returns \c false. \sa removeAllApplicationFonts(), addApplicationFont(), addApplicationFontFromData() @@ -2158,8 +2158,8 @@ QFont QFontDatabase::systemFont(QFontDatabase::SystemFont type) Removes all application-local fonts previously added using addApplicationFont() and addApplicationFontFromData(). - Returns true if unloading of the fonts succeeded; otherwise - returns false. + Returns \c true if unloading of the fonts succeeded; otherwise + returns \c false. \sa removeApplicationFont(), addApplicationFont(), addApplicationFontFromData() */ @@ -2169,12 +2169,12 @@ QFont QFontDatabase::systemFont(QFontDatabase::SystemFont type) \since 4.4 \deprecated - Returns true if font rendering is supported outside the GUI + Returns \c true if font rendering is supported outside the GUI thread, false otherwise. In other words, a return value of false means that all QPainter::drawText() calls outside the GUI thread will not produce readable output. - As of 5.0, always returns true. + As of 5.0, always returns \c true. \sa {Thread-Support in Qt Modules#Painting In Threads}{Painting In Threads} */ diff --git a/src/gui/text/qfontmetrics.cpp b/src/gui/text/qfontmetrics.cpp index 1d0a1c1078..58c9addec1 100644 --- a/src/gui/text/qfontmetrics.cpp +++ b/src/gui/text/qfontmetrics.cpp @@ -229,8 +229,8 @@ QFontMetrics &QFontMetrics::operator=(const QFontMetrics &fm) */ /*! - Returns true if \a other is equal to this object; otherwise - returns false. + Returns \c true if \a other is equal to this object; otherwise + returns \c false. Two font metrics are considered equal if they were constructed from the same QFont and the paint devices they were constructed @@ -246,7 +246,7 @@ bool QFontMetrics::operator ==(const QFontMetrics &other) const /*! \fn bool QFontMetrics::operator !=(const QFontMetrics &other) const - Returns true if \a other is not equal to this object; otherwise returns false. + Returns \c true if \a other is not equal to this object; otherwise returns \c false. Two font metrics are considered equal if they were constructed from the same QFont and the paint devices they were constructed @@ -405,8 +405,8 @@ int QFontMetrics::averageCharWidth() const } /*! - Returns true if character \a ch is a valid character in the font; - otherwise returns false. + Returns \c true if character \a ch is a valid character in the font; + otherwise returns \c false. */ bool QFontMetrics::inFont(QChar ch) const { @@ -419,8 +419,8 @@ bool QFontMetrics::inFont(QChar ch) const } /*! - Returns true if the character \a ucs4 encoded in UCS-4/UTF-32 is a valid - character in the font; otherwise returns false. + Returns \c true if the character \a ucs4 encoded in UCS-4/UTF-32 is a valid + character in the font; otherwise returns \c false. */ bool QFontMetrics::inFontUcs4(uint ucs4) const { @@ -1097,8 +1097,8 @@ QFontMetricsF &QFontMetricsF::operator=(const QFontMetricsF &fm) } /*! - Returns true if the font metrics are equal to the \a other font - metrics; otherwise returns false. + Returns \c true if the font metrics are equal to the \a other font + metrics; otherwise returns \c false. Two font metrics are considered equal if they were constructed from the same QFont and the paint devices they were constructed for are @@ -1113,8 +1113,8 @@ bool QFontMetricsF::operator ==(const QFontMetricsF &other) const \fn bool QFontMetricsF::operator !=(const QFontMetricsF &other) const \overload - Returns true if the font metrics are not equal to the \a other font - metrics; otherwise returns false. + Returns \c true if the font metrics are not equal to the \a other font + metrics; otherwise returns \c false. \sa operator==() */ @@ -1271,8 +1271,8 @@ qreal QFontMetricsF::averageCharWidth() const } /*! - Returns true if character \a ch is a valid character in the font; - otherwise returns false. + Returns \c true if character \a ch is a valid character in the font; + otherwise returns \c false. */ bool QFontMetricsF::inFont(QChar ch) const { @@ -1287,8 +1287,8 @@ bool QFontMetricsF::inFont(QChar ch) const /*! \fn bool QFontMetricsF::inFontUcs4(uint ch) const - Returns true if the character given by \a ch, encoded in UCS-4/UTF-32, - is a valid character in the font; otherwise returns false. + Returns \c true if the character given by \a ch, encoded in UCS-4/UTF-32, + is a valid character in the font; otherwise returns \c false. */ bool QFontMetricsF::inFontUcs4(uint ucs4) const { diff --git a/src/gui/text/qglyphrun.cpp b/src/gui/text/qglyphrun.cpp index d35247ecf4..aba991ba2b 100644 --- a/src/gui/text/qglyphrun.cpp +++ b/src/gui/text/qglyphrun.cpp @@ -162,8 +162,8 @@ QGlyphRun &QGlyphRun::operator=(const QGlyphRun &other) */ /*! - Compares \a other to this QGlyphRun object. Returns true if the list of glyph indexes, - the list of positions and the font are all equal, otherwise returns false. + Compares \a other to this QGlyphRun object. Returns \c true if the list of glyph indexes, + the list of positions and the font are all equal, otherwise returns \c false. */ bool QGlyphRun::operator==(const QGlyphRun &other) const { @@ -194,8 +194,8 @@ bool QGlyphRun::operator==(const QGlyphRun &other) const /*! \fn bool QGlyphRun::operator!=(const QGlyphRun &other) const - Compares \a other to this QGlyphRun object. Returns true if any of the list of glyph - indexes, the list of positions or the font are different, otherwise returns false. + Compares \a other to this QGlyphRun object. Returns \c true if any of the list of glyph + indexes, the list of positions or the font are different, otherwise returns \c false. */ /*! @@ -309,7 +309,7 @@ void QGlyphRun::setRawData(const quint32 *glyphIndexArray, const QPointF *glyphP } /*! - Returns true if this QGlyphRun should be painted with an overline decoration. + Returns \c true if this QGlyphRun should be painted with an overline decoration. \sa setOverline(), flags() */ @@ -330,7 +330,7 @@ void QGlyphRun::setOverline(bool overline) } /*! - Returns true if this QGlyphRun should be painted with an underline decoration. + Returns \c true if this QGlyphRun should be painted with an underline decoration. \sa setUnderline(), flags() */ @@ -351,7 +351,7 @@ void QGlyphRun::setUnderline(bool underline) } /*! - Returns true if this QGlyphRun should be painted with a strike out decoration. + Returns \c true if this QGlyphRun should be painted with a strike out decoration. \sa setStrikeOut(), flags() */ @@ -372,7 +372,7 @@ void QGlyphRun::setStrikeOut(bool strikeOut) } /*! - Returns true if this QGlyphRun contains glyphs that are painted from the right to the left. + Returns \c true if this QGlyphRun contains glyphs that are painted from the right to the left. \since 5.0 \sa setRightToLeft(), flags() @@ -501,7 +501,7 @@ QRectF QGlyphRun::boundingRect() const } /*! - Returns true if the QGlyphRun does not contain any glyphs. + Returns \c true if the QGlyphRun does not contain any glyphs. \since 5.0 */ diff --git a/src/gui/text/qplatformfontdatabase.cpp b/src/gui/text/qplatformfontdatabase.cpp index 7dab89b366..7076fba41b 100644 --- a/src/gui/text/qplatformfontdatabase.cpp +++ b/src/gui/text/qplatformfontdatabase.cpp @@ -217,8 +217,8 @@ void QSupportedWritingSystems::setSupported(QFontDatabase::WritingSystem writing } /*! - Returns true if the writing system specified by \a writingSystem is - supported; otherwise returns false. + Returns \c true if the writing system specified by \a writingSystem is + supported; otherwise returns \c false. */ bool QSupportedWritingSystems::supported(QFontDatabase::WritingSystem writingSystem) const { diff --git a/src/gui/text/qrawfont.cpp b/src/gui/text/qrawfont.cpp index f52b46eeae..b1b910422c 100644 --- a/src/gui/text/qrawfont.cpp +++ b/src/gui/text/qrawfont.cpp @@ -210,7 +210,7 @@ QRawFont &QRawFont::operator=(const QRawFont &other) */ /*! - Returns true if the QRawFont is valid and false otherwise. + Returns \c true if the QRawFont is valid and false otherwise. */ bool QRawFont::isValid() const { @@ -300,7 +300,7 @@ QPainterPath QRawFont::pathForGlyph(quint32 glyphIndex) const } /*! - Returns true if this QRawFont is equal to \a other. Otherwise, returns false. + Returns \c true if this QRawFont is equal to \a other. Otherwise, returns \c false. */ bool QRawFont::operator==(const QRawFont &other) const { @@ -310,7 +310,7 @@ bool QRawFont::operator==(const QRawFont &other) const /*! \fn bool QRawFont::operator!=(const QRawFont &other) const - Returns true if this QRawFont is not equal to \a other. Otherwise, returns false. + Returns \c true if this QRawFont is not equal to \a other. Otherwise, returns \c false. */ /*! @@ -668,7 +668,7 @@ QList<QFontDatabase::WritingSystem> QRawFont::supportedWritingSystems() const } /*! - Returns true if the font has a glyph that corresponds to the given \a character. + Returns \c true if the font has a glyph that corresponds to the given \a character. \sa supportedWritingSystems() */ @@ -680,7 +680,7 @@ bool QRawFont::supportsCharacter(QChar character) const /*! \overload - Returns true if the font has a glyph that corresponds to the UCS-4 encoded character \a ucs4. + Returns \c true if the font has a glyph that corresponds to the UCS-4 encoded character \a ucs4. \sa supportedWritingSystems() */ diff --git a/src/gui/text/qstatictext.cpp b/src/gui/text/qstatictext.cpp index cd88e3bbe4..b153219136 100644 --- a/src/gui/text/qstatictext.cpp +++ b/src/gui/text/qstatictext.cpp @@ -112,7 +112,7 @@ QT_BEGIN_NAMESPACE For extra convenience, it is possible to apply formatting to the text using the HTML subset supported by QTextDocument. QStaticText will attempt to guess the format of the input text using - Qt::mightBeRichText(), and interpret it as rich text if this function returns true. To force + Qt::mightBeRichText(), and interpret it as rich text if this function returns \c true. To force QStaticText to display its contents as either plain text or rich text, use the function QStaticText::setTextFormat() and pass in, respectively, Qt::PlainText and Qt::RichText. @@ -233,7 +233,7 @@ QStaticText &QStaticText::operator=(const QStaticText &other) */ /*! - Compares \a other to this QStaticText. Returns true if the texts, fonts and text widths + Compares \a other to this QStaticText. Returns \c true if the texts, fonts and text widths are equal. */ bool QStaticText::operator==(const QStaticText &other) const @@ -245,7 +245,7 @@ bool QStaticText::operator==(const QStaticText &other) const } /*! - Compares \a other to this QStaticText. Returns true if the texts, fonts or maximum sizes + Compares \a other to this QStaticText. Returns \c true if the texts, fonts or maximum sizes are different. */ bool QStaticText::operator!=(const QStaticText &other) const diff --git a/src/gui/text/qtextcursor.cpp b/src/gui/text/qtextcursor.cpp index 39fca795c9..d12f3cccd8 100644 --- a/src/gui/text/qtextcursor.cpp +++ b/src/gui/text/qtextcursor.cpp @@ -920,7 +920,7 @@ QTextLayout *QTextCursorPrivate::blockLayout(QTextBlock &block) const{ hasSelection(), clearSelection(), and removeSelectedText(). If the position() is at the start of a block atBlockStart() - returns true; and if it is at the end of a block atBlockEnd() returns + returns \c true; and if it is at the end of a block atBlockEnd() returns true. The format of the current character is returned by charFormat(), and the format of the current block is returned by blockFormat(). @@ -1134,7 +1134,7 @@ QTextCursor::~QTextCursor() } /*! - Returns true if the cursor is null; otherwise returns false. A null + Returns \c true if the cursor is null; otherwise returns \c false. A null cursor is created by the default constructor. */ bool QTextCursor::isNull() const @@ -1222,8 +1222,8 @@ int QTextCursor::anchor() const \fn bool QTextCursor::movePosition(MoveOperation operation, MoveMode mode, int n) Moves the cursor by performing the given \a operation \a n times, using the specified - \a mode, and returns true if all operations were completed successfully; otherwise - returns false. + \a mode, and returns \c true if all operations were completed successfully; otherwise + returns \c false. For example, if this function is repeatedly used to seek to the end of the next word, it will eventually fail when the end of the document is reached. @@ -1280,8 +1280,8 @@ bool QTextCursor::movePosition(MoveOperation op, MoveMode mode, int n) /*! \since 4.4 - Returns true if the cursor does visual navigation; otherwise - returns false. + Returns \c true if the cursor does visual navigation; otherwise + returns \c false. Visual navigation means skipping over hidden text paragraphs. The default is false. @@ -1582,7 +1582,7 @@ void QTextCursor::select(SelectionType selection) } /*! - Returns true if the cursor contains a selection; otherwise returns false. + Returns \c true if the cursor contains a selection; otherwise returns \c false. */ bool QTextCursor::hasSelection() const { @@ -1591,8 +1591,8 @@ bool QTextCursor::hasSelection() const /*! - Returns true if the cursor contains a selection that is not simply a - range from selectionStart() to selectionEnd(); otherwise returns false. + Returns \c true if the cursor contains a selection that is not simply a + range from selectionStart() to selectionEnd(); otherwise returns \c false. Complex selections are ones that span at least two cells in a table; their extent is specified by selectedTableCells(). @@ -1946,8 +1946,8 @@ void QTextCursor::mergeCharFormat(const QTextCharFormat &modifier) } /*! - Returns true if the cursor is at the start of a block; otherwise - returns false. + Returns \c true if the cursor is at the start of a block; otherwise + returns \c false. \sa atBlockEnd(), atStart() */ @@ -1960,8 +1960,8 @@ bool QTextCursor::atBlockStart() const } /*! - Returns true if the cursor is at the end of a block; otherwise - returns false. + Returns \c true if the cursor is at the end of a block; otherwise + returns \c false. \sa atBlockStart(), atEnd() */ @@ -1974,8 +1974,8 @@ bool QTextCursor::atBlockEnd() const } /*! - Returns true if the cursor is at the start of the document; - otherwise returns false. + Returns \c true if the cursor is at the start of the document; + otherwise returns \c false. \sa atBlockStart(), atEnd() */ @@ -1990,8 +1990,8 @@ bool QTextCursor::atStart() const /*! \since 4.6 - Returns true if the cursor is at the end of the document; - otherwise returns false. + Returns \c true if the cursor is at the end of the document; + otherwise returns \c false. \sa atStart(), atBlockEnd() */ @@ -2344,8 +2344,8 @@ void QTextCursor::insertImage(const QImage &image, const QString &name) /*! \fn bool QTextCursor::operator!=(const QTextCursor &other) const - Returns true if the \a other cursor is at a different position in - the document as this cursor; otherwise returns false. + Returns \c true if the \a other cursor is at a different position in + the document as this cursor; otherwise returns \c false. */ bool QTextCursor::operator!=(const QTextCursor &rhs) const { @@ -2355,8 +2355,8 @@ bool QTextCursor::operator!=(const QTextCursor &rhs) const /*! \fn bool QTextCursor::operator<(const QTextCursor &other) const - Returns true if the \a other cursor is positioned later in the - document than this cursor; otherwise returns false. + Returns \c true if the \a other cursor is positioned later in the + document than this cursor; otherwise returns \c false. */ bool QTextCursor::operator<(const QTextCursor &rhs) const { @@ -2374,7 +2374,7 @@ bool QTextCursor::operator<(const QTextCursor &rhs) const /*! \fn bool QTextCursor::operator<=(const QTextCursor &other) const - Returns true if the \a other cursor is positioned later or at the + Returns \c true if the \a other cursor is positioned later or at the same position in the document as this cursor; otherwise returns false. */ @@ -2394,8 +2394,8 @@ bool QTextCursor::operator<=(const QTextCursor &rhs) const /*! \fn bool QTextCursor::operator==(const QTextCursor &other) const - Returns true if the \a other cursor is at the same position in the - document as this cursor; otherwise returns false. + Returns \c true if the \a other cursor is at the same position in the + document as this cursor; otherwise returns \c false. */ bool QTextCursor::operator==(const QTextCursor &rhs) const { @@ -2411,7 +2411,7 @@ bool QTextCursor::operator==(const QTextCursor &rhs) const /*! \fn bool QTextCursor::operator>=(const QTextCursor &other) const - Returns true if the \a other cursor is positioned earlier or at the + Returns \c true if the \a other cursor is positioned earlier or at the same position in the document as this cursor; otherwise returns false. */ @@ -2431,8 +2431,8 @@ bool QTextCursor::operator>=(const QTextCursor &rhs) const /*! \fn bool QTextCursor::operator>(const QTextCursor &other) const - Returns true if the \a other cursor is positioned earlier in the - document than this cursor; otherwise returns false. + Returns \c true if the \a other cursor is positioned earlier in the + document than this cursor; otherwise returns \c false. */ bool QTextCursor::operator>(const QTextCursor &rhs) const { @@ -2514,7 +2514,7 @@ void QTextCursor::endEditBlock() } /*! - Returns true if this cursor and \a other are copies of each other, i.e. + Returns \c true if this cursor and \a other are copies of each other, i.e. one of them was created as a copy of the other and neither has moved since. This is much stricter than equality. diff --git a/src/gui/text/qtextdocument.cpp b/src/gui/text/qtextdocument.cpp index b83af30f7f..03602712cc 100644 --- a/src/gui/text/qtextdocument.cpp +++ b/src/gui/text/qtextdocument.cpp @@ -74,8 +74,8 @@ QT_BEGIN_NAMESPACE Q_CORE_EXPORT unsigned int qt_int_sqrt(unsigned int n); /*! - Returns true if the string \a text is likely to be rich text; - otherwise returns false. + Returns \c true if the string \a text is likely to be rich text; + otherwise returns \c false. This function uses a fast and therefore simple heuristic. It mainly checks whether there is something that looks like a tag @@ -356,7 +356,7 @@ QTextDocument *QTextDocument::clone(QObject *parent) const } /*! - Returns true if the document is empty; otherwise returns false. + Returns \c true if the document is empty; otherwise returns \c false. */ bool QTextDocument::isEmpty() const { @@ -605,7 +605,7 @@ void QTextDocument::markContentsDirty(int from, int length) and pixel-rounding. This means that WYSIWYG text layout becomes possible because the width scales much more linearly based on paintdevice metrics than it would otherwise. - By default, this property is false. + By default, this property is \c false. */ void QTextDocument::setUseDesignMetrics(bool b) @@ -987,7 +987,7 @@ QString QTextDocument::defaultStyleSheet() const /*! - Returns true if undo is available; otherwise returns false. + Returns \c true if undo is available; otherwise returns \c false. \sa isRedoAvailable(), availableUndoSteps() */ @@ -998,7 +998,7 @@ bool QTextDocument::isUndoAvailable() const } /*! - Returns true if redo is available; otherwise returns false. + Returns \c true if redo is available; otherwise returns \c false. \sa isUndoAvailable(), availableRedoSteps() */ @@ -1612,7 +1612,7 @@ QFont QTextDocument::defaultFont() const \property QTextDocument::modified \brief whether the document has been modified by the user - By default, this property is false. + By default, this property is \c false. \sa modificationChanged() */ diff --git a/src/gui/text/qtextdocumentfragment.cpp b/src/gui/text/qtextdocumentfragment.cpp index 37f58a7512..df67fb581a 100644 --- a/src/gui/text/qtextdocumentfragment.cpp +++ b/src/gui/text/qtextdocumentfragment.cpp @@ -352,7 +352,7 @@ QTextDocumentFragment::~QTextDocumentFragment() } /*! - Returns true if the fragment is empty; otherwise returns false. + Returns \c true if the fragment is empty; otherwise returns \c false. */ bool QTextDocumentFragment::isEmpty() const { diff --git a/src/gui/text/qtextdocumentwriter.cpp b/src/gui/text/qtextdocumentwriter.cpp index a294bceacc..1722a791b9 100644 --- a/src/gui/text/qtextdocumentwriter.cpp +++ b/src/gui/text/qtextdocumentwriter.cpp @@ -88,7 +88,7 @@ public: later. Call write() to write the document to the device. If the document is - successfully written, this function returns true. However, if an error + successfully written, this function returns \c true. However, if an error occurs when writing the document, it will return false. Call supportedDocumentFormats() for a list of formats that @@ -245,7 +245,7 @@ QString QTextDocumentWriter::fileName () const /*! Writes the given \a document to the assigned device or file and - returns true if successful; otherwise returns false. + returns \c true if successful; otherwise returns \c false. */ bool QTextDocumentWriter::write(const QTextDocument *document) { @@ -304,7 +304,7 @@ bool QTextDocumentWriter::write(const QTextDocument *document) /*! Writes the document fragment specified by \a fragment to the assigned device - or file and returns true if successful; otherwise returns false. + or file and returns \c true if successful; otherwise returns \c false. */ bool QTextDocumentWriter::write(const QTextDocumentFragment &fragment) { diff --git a/src/gui/text/qtextformat.cpp b/src/gui/text/qtextformat.cpp index 4f8a25c5a8..2389427da0 100644 --- a/src/gui/text/qtextformat.cpp +++ b/src/gui/text/qtextformat.cpp @@ -116,14 +116,14 @@ QT_BEGIN_NAMESPACE /*! \fn bool QTextLength::operator==(const QTextLength &other) const - Returns true if this text length is the same as the \a other text + Returns \c true if this text length is the same as the \a other text length. */ /*! \fn bool QTextLength::operator!=(const QTextLength &other) const - Returns true if this text length is different from the \a other text + Returns \c true if this text length is different from the \a other text length. */ @@ -701,55 +701,55 @@ Q_GUI_EXPORT QDataStream &operator>>(QDataStream &stream, QTextFormat &fmt) /*! \fn bool QTextFormat::isValid() const - Returns true if the format is valid (i.e. is not - InvalidFormat); otherwise returns false. + Returns \c true if the format is valid (i.e. is not + InvalidFormat); otherwise returns \c false. */ /*! \fn bool QTextFormat::isCharFormat() const - Returns true if this text format is a \c CharFormat; otherwise - returns false. + Returns \c true if this text format is a \c CharFormat; otherwise + returns \c false. */ /*! \fn bool QTextFormat::isBlockFormat() const - Returns true if this text format is a \c BlockFormat; otherwise - returns false. + Returns \c true if this text format is a \c BlockFormat; otherwise + returns \c false. */ /*! \fn bool QTextFormat::isListFormat() const - Returns true if this text format is a \c ListFormat; otherwise - returns false. + Returns \c true if this text format is a \c ListFormat; otherwise + returns \c false. */ /*! \fn bool QTextFormat::isTableFormat() const - Returns true if this text format is a \c TableFormat; otherwise - returns false. + Returns \c true if this text format is a \c TableFormat; otherwise + returns \c false. */ /*! \fn bool QTextFormat::isFrameFormat() const - Returns true if this text format is a \c FrameFormat; otherwise - returns false. + Returns \c true if this text format is a \c FrameFormat; otherwise + returns \c false. */ /*! \fn bool QTextFormat::isImageFormat() const - Returns true if this text format is an image format; otherwise - returns false. + Returns \c true if this text format is an image format; otherwise + returns \c false. */ @@ -757,8 +757,8 @@ Q_GUI_EXPORT QDataStream &operator>>(QDataStream &stream, QTextFormat &fmt) \fn bool QTextFormat::isTableCellFormat() const \since 4.4 - Returns true if this text format is a \c TableCellFormat; otherwise - returns false. + Returns \c true if this text format is a \c TableCellFormat; otherwise + returns \c false. */ @@ -1200,8 +1200,8 @@ void QTextFormat::setObjectIndex(int o) } /*! - Returns true if the text format has a property with the given \a - propertyId; otherwise returns false. + Returns \c true if the text format has a property with the given \a + propertyId; otherwise returns \c false. \sa properties(), Property */ @@ -1241,7 +1241,7 @@ int QTextFormat::propertyCount() const /*! \fn bool QTextFormat::operator!=(const QTextFormat &other) const - Returns true if this text format is different from the \a other text + Returns \c true if this text format is different from the \a other text format. */ @@ -1249,7 +1249,7 @@ int QTextFormat::propertyCount() const /*! \fn bool QTextFormat::operator==(const QTextFormat &other) const - Returns true if this text format is the same as the \a other text + Returns \c true if this text format is the same as the \a other text format. */ bool QTextFormat::operator==(const QTextFormat &rhs) const @@ -1365,7 +1365,7 @@ QTextCharFormat::QTextCharFormat(const QTextFormat &fmt) /*! \fn bool QTextCharFormat::isValid() const - Returns true if this character format is valid; otherwise returns + Returns \c true if this character format is valid; otherwise returns false. */ @@ -1437,8 +1437,8 @@ QTextCharFormat::QTextCharFormat(const QTextFormat &fmt) /*! \fn bool QTextCharFormat::fontItalic() const - Returns true if the text format's font is italic; otherwise - returns false. + Returns \c true if the text format's font is italic; otherwise + returns \c false. \sa font() */ @@ -1457,8 +1457,8 @@ QTextCharFormat::QTextCharFormat(const QTextFormat &fmt) /*! \fn bool QTextCharFormat::fontUnderline() const - Returns true if the text format's font is underlined; otherwise - returns false. + Returns \c true if the text format's font is underlined; otherwise + returns \c false. \sa font() */ @@ -1502,8 +1502,8 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) /*! \fn bool QTextCharFormat::fontOverline() const - Returns true if the text format's font is overlined; otherwise - returns false. + Returns \c true if the text format's font is overlined; otherwise + returns \c false. \sa font() */ @@ -1523,8 +1523,8 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) /*! \fn bool QTextCharFormat::fontStrikeOut() const - Returns true if the text format's font is struck out (has a horizontal line - drawn through it); otherwise returns false. + Returns \c true if the text format's font is struck out (has a horizontal line + drawn through it); otherwise returns \c false. \sa font() */ @@ -1591,7 +1591,7 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) /*! \since 4.5 \fn bool QTextCharFormat::fontKerning() const - Returns true if the font kerning is enabled. + Returns \c true if the font kerning is enabled. \sa setFontKerning() \sa font() @@ -1611,8 +1611,8 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) /*! \fn bool QTextCharFormat::fontFixedPitch() const - Returns true if the text format's font is fixed pitch; otherwise - returns false. + Returns \c true if the text format's font is fixed pitch; otherwise + returns \c false. \sa font() */ @@ -1712,8 +1712,8 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) /*! \fn bool QTextCharFormat::isAnchor() const - Returns true if the text is formatted as an anchor; otherwise - returns false. + Returns \c true if the text is formatted as an anchor; otherwise + returns \c false. \sa setAnchor(), setAnchorHref(), setAnchorNames() */ @@ -2031,7 +2031,7 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const /*! \fn QTextBlockFormat::isValid() const - Returns true if this block format is valid; otherwise returns + Returns \c true if this block format is valid; otherwise returns false. */ @@ -2249,8 +2249,8 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const /*! \fn bool QTextBlockFormat::nonBreakableLines() const - Returns true if the lines in the paragraph are non-breakable; - otherwise returns false. + Returns \c true if the lines in the paragraph are non-breakable; + otherwise returns \c false. \sa setNonBreakableLines() */ @@ -2350,8 +2350,8 @@ QTextListFormat::QTextListFormat(const QTextFormat &fmt) /*! \fn bool QTextListFormat::isValid() const - Returns true if this list format is valid; otherwise - returns false. + Returns \c true if this list format is valid; otherwise + returns \c false. */ /*! @@ -2530,7 +2530,7 @@ QTextFrameFormat::QTextFrameFormat(const QTextFormat &fmt) /*! \fn QTextFrameFormat::isValid() const - Returns true if the format description is valid; otherwise returns false. + Returns \c true if the format description is valid; otherwise returns \c false. */ /*! @@ -2837,8 +2837,8 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt) /*! \fn bool QTextTableFormat::isValid() const - Returns true if this table format is valid; otherwise - returns false. + Returns \c true if this table format is valid; otherwise + returns \c false. */ @@ -3018,7 +3018,7 @@ QTextImageFormat::QTextImageFormat(const QTextFormat &fmt) /*! \fn bool QTextImageFormat::isValid() const - Returns true if this image format is valid; otherwise returns false. + Returns \c true if this image format is valid; otherwise returns \c false. */ @@ -3264,7 +3264,7 @@ QTextImageFormat::QTextImageFormat(const QTextFormat &fmt) \fn bool QTextTableCellFormat::isValid() const \since 4.4 - Returns true if this table cell format is valid; otherwise returns false. + Returns \c true if this table cell format is valid; otherwise returns \c false. */ /*! diff --git a/src/gui/text/qtextlayout.cpp b/src/gui/text/qtextlayout.cpp index eed6758cc9..e10a7dbe10 100644 --- a/src/gui/text/qtextlayout.cpp +++ b/src/gui/text/qtextlayout.cpp @@ -130,7 +130,7 @@ QT_BEGIN_NAMESPACE /*! \fn bool QTextInlineObject::isValid() const - Returns true if this inline object is valid; otherwise returns + Returns \c true if this inline object is valid; otherwise returns false. */ @@ -543,8 +543,8 @@ void QTextLayout::setCacheEnabled(bool enable) } /*! - Returns true if the complete layout information is cached; otherwise - returns false. + Returns \c true if the complete layout information is cached; otherwise + returns \c false. \sa setCacheEnabled() */ @@ -728,7 +728,7 @@ int QTextLayout::leftCursorPosition(int oldPos) const } /*!/ - Returns true if position \a pos is a valid cursor position. + Returns \c true if position \a pos is a valid cursor position. In a Unicode context some positions in the text are not valid cursor positions, because the position is inside a Unicode @@ -1325,7 +1325,7 @@ void QTextLayout::drawCursor(QPainter *p, const QPointF &pos, int cursorPosition /*! \fn bool QTextLine::isValid() const - Returns true if this text line is valid; otherwise returns false. + Returns \c true if this text line is valid; otherwise returns \c false. */ /*! @@ -1459,8 +1459,8 @@ void QTextLine::setLeadingIncluded(bool included) /*! \since 4.6 - Returns true if positive leading is included into the line's height; - otherwise returns false. + Returns \c true if positive leading is included into the line's height; + otherwise returns \c false. By default, leading is not included. diff --git a/src/gui/text/qtextlist.cpp b/src/gui/text/qtextlist.cpp index 108501fdb3..f969f66006 100644 --- a/src/gui/text/qtextlist.cpp +++ b/src/gui/text/qtextlist.cpp @@ -106,7 +106,7 @@ public: \fn bool QTextList::isEmpty() const \obsolete - Returns true if the list has no items; otherwise returns false. + Returns \c true if the list has no items; otherwise returns \c false. \b{Note:} Empty lists are automatically deleted by the QTextDocument that owns them. diff --git a/src/gui/text/qtextobject.cpp b/src/gui/text/qtextobject.cpp index 8465dcdaad..d1a39c6ab6 100644 --- a/src/gui/text/qtextobject.cpp +++ b/src/gui/text/qtextobject.cpp @@ -369,14 +369,14 @@ QTextFrameLayoutData::~QTextFrameLayoutData() \fn bool QTextFrame::iterator::operator==(const iterator &other) const Retuns true if the iterator is the same as the \a other iterator; - otherwise returns false. + otherwise returns \c false. */ /*! \fn bool QTextFrame::iterator::operator!=(const iterator &other) const Retuns true if the iterator is different from the \a other iterator; - otherwise returns false. + otherwise returns \c false. */ /*! @@ -617,7 +617,7 @@ void QTextFramePrivate::remove_me() /*! \fn bool QTextFrame::iterator::atEnd() const - Returns true if the current item is the last item in the text frame. + Returns \c true if the current item is the last item in the text frame. */ /*! @@ -896,7 +896,7 @@ QTextBlockUserData::~QTextBlockUserData() /*! \fn bool QTextBlock::isValid() const - Returns true if this text block is valid; otherwise returns false. + Returns \c true if this text block is valid; otherwise returns \c false. */ bool QTextBlock::isValid() const @@ -913,21 +913,21 @@ bool QTextBlock::isValid() const /*! \fn bool QTextBlock::operator==(const QTextBlock &other) const - Returns true if this text block is the same as the \a other text + Returns \c true if this text block is the same as the \a other text block. */ /*! \fn bool QTextBlock::operator!=(const QTextBlock &other) const - Returns true if this text block is different from the \a other + Returns \c true if this text block is different from the \a other text block. */ /*! \fn bool QTextBlock::operator<(const QTextBlock &other) const - Returns true if this text block occurs before the \a other text + Returns \c true if this text block occurs before the \a other text block in the document. */ @@ -975,21 +975,21 @@ bool QTextBlock::isValid() const /*! \fn bool QTextBlock::iterator::atEnd() const - Returns true if the current item is the last item in the text block. + Returns \c true if the current item is the last item in the text block. */ /*! \fn bool QTextBlock::iterator::operator==(const iterator &other) const Retuns true if this iterator is the same as the \a other iterator; - otherwise returns false. + otherwise returns \c false. */ /*! \fn bool QTextBlock::iterator::operator!=(const iterator &other) const Retuns true if this iterator is different from the \a other iterator; - otherwise returns false. + otherwise returns \c false. */ /*! @@ -1047,8 +1047,8 @@ int QTextBlock::length() const } /*! - Returns true if the given \a position is located within the text - block; otherwise returns false. + Returns \c true if the given \a position is located within the text + block; otherwise returns \c false. */ bool QTextBlock::contains(int position) const { @@ -1372,7 +1372,7 @@ void QTextBlock::setRevision(int rev) /*! \since 4.4 - Returns true if the block is visible; otherwise returns false. + Returns \c true if the block is visible; otherwise returns \c false. \sa setVisible() */ @@ -1651,21 +1651,21 @@ QTextBlock::iterator &QTextBlock::iterator::operator--() /*! \fn bool QTextFragment::isValid() const - Returns true if this is a valid text fragment (i.e. has a valid - position in a document); otherwise returns false. + Returns \c true if this is a valid text fragment (i.e. has a valid + position in a document); otherwise returns \c false. */ /*! \fn bool QTextFragment::operator==(const QTextFragment &other) const - Returns true if this text fragment is the same (at the same - position) as the \a other text fragment; otherwise returns false. + Returns \c true if this text fragment is the same (at the same + position) as the \a other text fragment; otherwise returns \c false. */ /*! \fn bool QTextFragment::operator!=(const QTextFragment &other) const - Returns true if this text fragment is different (at a different + Returns \c true if this text fragment is different (at a different position) from the \a other text fragment; otherwise returns false. */ @@ -1673,8 +1673,8 @@ QTextBlock::iterator &QTextBlock::iterator::operator--() /*! \fn bool QTextFragment::operator<(const QTextFragment &other) const - Returns true if this text fragment appears earlier in the document - than the \a other text fragment; otherwise returns false. + Returns \c true if this text fragment appears earlier in the document + than the \a other text fragment; otherwise returns \c false. */ /*! @@ -1747,8 +1747,8 @@ int QTextFragment::length() const } /*! - Returns true if the text fragment contains the text at the given - \a position in the document; otherwise returns false. + Returns \c true if the text fragment contains the text at the given + \a position in the document; otherwise returns \c false. */ bool QTextFragment::contains(int position) const { diff --git a/src/gui/text/qtextoption.cpp b/src/gui/text/qtextoption.cpp index 1284207307..836e85889e 100644 --- a/src/gui/text/qtextoption.cpp +++ b/src/gui/text/qtextoption.cpp @@ -118,8 +118,8 @@ QTextOption::QTextOption(const QTextOption &o) /*! \fn QTextOption &QTextOption::operator=(const QTextOption &other) - Returns true if the text option is the same as the \a other text option; - otherwise returns false. + Returns \c true if the text option is the same as the \a other text option; + otherwise returns \c false. */ QTextOption &QTextOption::operator=(const QTextOption &o) { @@ -248,8 +248,8 @@ QList<QTextOption::Tab> QTextOption::tabs() const /*! \fn bool QTextOption::useDesignMetrics() const - Returns true if the layout uses design rather than device metrics; - otherwise returns false. + Returns \c true if the layout uses design rather than device metrics; + otherwise returns \c false. \sa setUseDesignMetrics() */ @@ -409,15 +409,15 @@ QList<QTextOption::Tab> QTextOption::tabs() const /*! \fn bool Tab::operator==(const Tab &other) const - Returns true if tab \a other is equal to this tab; - otherwise returns false. + Returns \c true if tab \a other is equal to this tab; + otherwise returns \c false. */ /*! \fn bool Tab::operator!=(const Tab &other) const - Returns true if tab \a other is not equal to this tab; - otherwise returns false. + Returns \c true if tab \a other is not equal to this tab; + otherwise returns \c false. */ /*! diff --git a/src/gui/text/qtexttable.cpp b/src/gui/text/qtexttable.cpp index 879c3ddc70..d77cbf9671 100644 --- a/src/gui/text/qtexttable.cpp +++ b/src/gui/text/qtexttable.cpp @@ -217,7 +217,7 @@ int QTextTableCell::columnSpan() const /*! \fn bool QTextTableCell::isValid() const - Returns true if this is a valid table cell; otherwise returns + Returns \c true if this is a valid table cell; otherwise returns false. */ @@ -303,15 +303,15 @@ QTextFrame::iterator QTextTableCell::end() const /*! \fn QTextCursor QTextTableCell::operator==(const QTextTableCell &other) const - Returns true if this cell object and the \a other cell object - describe the same cell; otherwise returns false. + Returns \c true if this cell object and the \a other cell object + describe the same cell; otherwise returns \c false. */ /*! \fn QTextCursor QTextTableCell::operator!=(const QTextTableCell &other) const - Returns true if this cell object and the \a other cell object - describe different cells; otherwise returns false. + Returns \c true if this cell object and the \a other cell object + describe different cells; otherwise returns \c false. */ /*! diff --git a/src/gui/text/qzip.cpp b/src/gui/text/qzip.cpp index 151b0bcfeb..dee56d18f7 100644 --- a/src/gui/text/qzip.cpp +++ b/src/gui/text/qzip.cpp @@ -899,7 +899,7 @@ QIODevice* QZipReader::device() const } /*! - Returns true if the user can read the file; otherwise returns false. + Returns \c true if the user can read the file; otherwise returns \c false. */ bool QZipReader::isReadable() const { @@ -907,7 +907,7 @@ bool QZipReader::isReadable() const } /*! - Returns true if the file exists; otherwise returns false. + Returns \c true if the file exists; otherwise returns \c false. */ bool QZipReader::exists() const { @@ -1194,7 +1194,7 @@ QIODevice* QZipWriter::device() const } /*! - Returns true if the user can write to the archive; otherwise returns false. + Returns \c true if the user can write to the archive; otherwise returns \c false. */ bool QZipWriter::isWritable() const { @@ -1202,7 +1202,7 @@ bool QZipWriter::isWritable() const } /*! - Returns true if the file exists; otherwise returns false. + Returns \c true if the file exists; otherwise returns \c false. */ bool QZipWriter::exists() const { diff --git a/src/gui/util/qdesktopservices.cpp b/src/gui/util/qdesktopservices.cpp index f5895414a9..87146118db 100644 --- a/src/gui/util/qdesktopservices.cpp +++ b/src/gui/util/qdesktopservices.cpp @@ -151,7 +151,7 @@ void QOpenUrlHandlerRegistry::handlerDestroyed(QObject *handler) /*! Opens the given \a url in the appropriate Web browser for the user's desktop - environment, and returns true if successful; otherwise returns false. + environment, and returns \c true if successful; otherwise returns \c false. If the URL is a reference to a local file (i.e., the URL scheme is "file") then it will be opened with a suitable application instead of a Web browser. |