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/kernel/qsurfaceformat.cpp | |
| 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/kernel/qsurfaceformat.cpp')
| -rw-r--r-- | src/gui/kernel/qsurfaceformat.cpp | 12 |
1 files changed, 6 insertions, 6 deletions
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 */ |