summaryrefslogtreecommitdiffstats
path: root/src/corelib/tools/qsize.cpp
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/tools/qsize.cpp
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/corelib/tools/qsize.cpp')
-rw-r--r--src/corelib/tools/qsize.cpp38
1 files changed, 19 insertions, 19 deletions
diff --git a/src/corelib/tools/qsize.cpp b/src/corelib/tools/qsize.cpp
index 6faeb9af0e..b53eced298 100644
--- a/src/corelib/tools/qsize.cpp
+++ b/src/corelib/tools/qsize.cpp
@@ -62,8 +62,8 @@ QT_BEGIN_NAMESPACE
The isValid() function determines if a size is valid (a valid size
has both width and height greater than zero). The isEmpty()
- function returns true if either of the width and height is less
- than, or equal to, zero, while the isNull() function returns true
+ function returns \c true if either of the width and height is less
+ than, or equal to, zero, while the isNull() function returns \c true
only if both the width and the height is zero.
Use the expandedTo() function to retrieve a size which holds the
@@ -86,7 +86,7 @@ QT_BEGIN_NAMESPACE
\fn QSize::QSize()
Constructs a size with an invalid width and height (i.e., isValid()
- returns false).
+ returns \c false).
\sa isValid()
*/
@@ -102,7 +102,7 @@ QT_BEGIN_NAMESPACE
/*!
\fn bool QSize::isNull() const
- Returns true if both the width and height is 0; otherwise returns
+ Returns \c true if both the width and height is 0; otherwise returns
false.
\sa isValid(), isEmpty()
@@ -111,8 +111,8 @@ QT_BEGIN_NAMESPACE
/*!
\fn bool QSize::isEmpty() const
- Returns true if either of the width and height is less than or
- equal to 0; otherwise returns false.
+ Returns \c true if either of the width and height is less than or
+ equal to 0; otherwise returns \c false.
\sa isNull(), isValid()
*/
@@ -120,8 +120,8 @@ QT_BEGIN_NAMESPACE
/*!
\fn bool QSize::isValid() const
- Returns true if both the width and height is equal to or greater
- than 0; otherwise returns false.
+ Returns \c true if both the width and height is equal to or greater
+ than 0; otherwise returns \c false.
\sa isNull(), isEmpty()
*/
@@ -308,14 +308,14 @@ QSize QSize::scaled(const QSize &s, Qt::AspectRatioMode mode) const
\fn bool operator==(const QSize &s1, const QSize &s2)
\relates QSize
- Returns true if \a s1 and \a s2 are equal; otherwise returns false.
+ Returns \c true if \a s1 and \a s2 are equal; otherwise returns \c false.
*/
/*!
\fn bool operator!=(const QSize &s1, const QSize &s2)
\relates QSize
- Returns true if \a s1 and \a s2 are different; otherwise returns false.
+ Returns \c true if \a s1 and \a s2 are different; otherwise returns \c false.
*/
/*!
@@ -470,9 +470,9 @@ QDebug operator<<(QDebug dbg, const QSize &s) {
The isValid() function determines if a size is valid. A valid size
has both width and height greater than or equal to zero. The
- isEmpty() function returns true if either of the width and height
+ isEmpty() function returns \c true if either of the width and height
is \e less than (or equal to) zero, while the isNull() function
- returns true only if both the width and the height is zero.
+ returns \c true only if both the width and the height is zero.
Use the expandedTo() function to retrieve a size which holds the
maximum height and width of this size and a given
@@ -519,7 +519,7 @@ QDebug operator<<(QDebug dbg, const QSize &s) {
/*!
\fn bool QSizeF::isNull() const
- Returns true if both the width and height are +0.0; otherwise returns
+ Returns \c true if both the width and height are +0.0; otherwise returns
false.
\note Since this function treats +0.0 and -0.0 differently, sizes with
@@ -532,8 +532,8 @@ QDebug operator<<(QDebug dbg, const QSize &s) {
/*!
\fn bool QSizeF::isEmpty() const
- Returns true if either of the width and height is less than or
- equal to 0; otherwise returns false.
+ Returns \c true if either of the width and height is less than or
+ equal to 0; otherwise returns \c false.
\sa isNull(), isValid()
*/
@@ -541,8 +541,8 @@ QDebug operator<<(QDebug dbg, const QSize &s) {
/*!
\fn bool QSizeF::isValid() const
- Returns true if both the width and height is equal to or greater
- than 0; otherwise returns false.
+ Returns \c true if both the width and height is equal to or greater
+ than 0; otherwise returns \c false.
\sa isNull(), isEmpty()
*/
@@ -737,7 +737,7 @@ QSizeF QSizeF::scaled(const QSizeF &s, Qt::AspectRatioMode mode) const
\fn bool operator==(const QSizeF &s1, const QSizeF &s2)
\relates QSizeF
- Returns true if \a s1 and \a s2 are equal; otherwise returns
+ Returns \c true if \a s1 and \a s2 are equal; otherwise returns
false.
*/
@@ -745,7 +745,7 @@ QSizeF QSizeF::scaled(const QSizeF &s, Qt::AspectRatioMode mode) const
\fn bool operator!=(const QSizeF &s1, const QSizeF &s2)
\relates QSizeF
- Returns true if \a s1 and \a s2 are different; otherwise returns false.
+ Returns \c true if \a s1 and \a s2 are different; otherwise returns \c false.
*/
/*!