summaryrefslogtreecommitdiffstats
path: root/src/gui/kernel/qopenglcontext.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/gui/kernel/qopenglcontext.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/gui/kernel/qopenglcontext.cpp')
-rw-r--r--src/gui/kernel/qopenglcontext.cpp14
1 files changed, 7 insertions, 7 deletions
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().