summaryrefslogtreecommitdiffstats
path: root/src/opengl
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/opengl
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/opengl')
-rw-r--r--src/opengl/gl2paintengineex/qglengineshadermanager.cpp2
-rw-r--r--src/opengl/qgl.cpp84
-rw-r--r--src/opengl/qglbuffer.cpp10
-rw-r--r--src/opengl/qglcolormap.cpp4
-rw-r--r--src/opengl/qglframebufferobject.cpp28
-rw-r--r--src/opengl/qglfunctions.cpp2
-rw-r--r--src/opengl/qglpixelbuffer.cpp14
-rw-r--r--src/opengl/qglshaderprogram.cpp30
8 files changed, 87 insertions, 87 deletions
diff --git a/src/opengl/gl2paintengineex/qglengineshadermanager.cpp b/src/opengl/gl2paintengineex/qglengineshadermanager.cpp
index cdb60f8900..a89d37bc5d 100644
--- a/src/opengl/gl2paintengineex/qglengineshadermanager.cpp
+++ b/src/opengl/gl2paintengineex/qglengineshadermanager.cpp
@@ -654,7 +654,7 @@ QGLShaderProgram* QGLEngineShaderManager::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 QGLEngineShaderManager::useCorrectShaderProg()
{
if (!shaderProgNeedsChanging)
diff --git a/src/opengl/qgl.cpp b/src/opengl/qgl.cpp
index f1ce2cfae3..c96200fe1b 100644
--- a/src/opengl/qgl.cpp
+++ b/src/opengl/qgl.cpp
@@ -422,7 +422,7 @@ QGLFormat::~QGLFormat()
/*!
\fn bool QGLFormat::doubleBuffer() const
- Returns true if double buffering is enabled; otherwise returns
+ Returns \c true if double buffering is enabled; otherwise returns
false. Double buffering is enabled by default.
\sa setDoubleBuffer()
@@ -456,7 +456,7 @@ void QGLFormat::setDoubleBuffer(bool enable)
/*!
\fn bool QGLFormat::depth() const
- Returns true if the depth buffer is enabled; otherwise returns
+ Returns \c true if the depth buffer is enabled; otherwise returns
false. The depth buffer is enabled by default.
\sa setDepth(), setDepthBufferSize()
@@ -486,7 +486,7 @@ void QGLFormat::setDepth(bool enable)
/*!
\fn bool QGLFormat::rgba() const
- Returns true if RGBA color mode is set. Returns false if color
+ Returns \c true if RGBA color mode is set. Returns \c false if color
index mode is set. The default color mode is RGBA.
\sa setRgba()
@@ -517,8 +517,8 @@ void QGLFormat::setRgba(bool enable)
/*!
\fn bool QGLFormat::alpha() const
- Returns true if the alpha buffer in the framebuffer is enabled;
- otherwise returns false. The alpha buffer is disabled by default.
+ Returns \c true if the alpha buffer in the framebuffer is enabled;
+ otherwise returns \c false. The alpha buffer is disabled by default.
\sa setAlpha(), setAlphaBufferSize()
*/
@@ -545,8 +545,8 @@ void QGLFormat::setAlpha(bool enable)
/*!
\fn bool QGLFormat::accum() const
- Returns true if the accumulation buffer is enabled; otherwise
- returns false. The accumulation buffer is disabled by default.
+ Returns \c true if the accumulation buffer is enabled; otherwise
+ returns \c false. The accumulation buffer is disabled by default.
\sa setAccum(), setAccumBufferSize()
*/
@@ -572,7 +572,7 @@ void QGLFormat::setAccum(bool enable)
/*!
\fn bool QGLFormat::stencil() const
- Returns true if the stencil buffer is enabled; otherwise returns
+ Returns \c true if the stencil buffer is enabled; otherwise returns
false. The stencil buffer is enabled by default.
\sa setStencil(), setStencilBufferSize()
@@ -599,7 +599,7 @@ void QGLFormat::setStencil(bool enable)
/*!
\fn bool QGLFormat::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()
@@ -626,7 +626,7 @@ void QGLFormat::setStereo(bool enable)
/*!
\fn bool QGLFormat::directRendering() const
- Returns true if direct rendering is enabled; otherwise returns
+ Returns \c true if direct rendering is enabled; otherwise returns
false.
Direct rendering is enabled by default.
@@ -655,8 +655,8 @@ void QGLFormat::setDirectRendering(bool enable)
/*!
\fn bool QGLFormat::sampleBuffers() const
- Returns true if multisample buffer support is enabled; otherwise
- returns false.
+ Returns \c true if multisample buffer support is enabled; otherwise
+ returns \c false.
The multisample buffer is disabled by default.
@@ -742,7 +742,7 @@ int QGLFormat::swapInterval() const
/*!
\fn bool QGLFormat::hasOverlay() const
- Returns true if overlay plane is enabled; otherwise returns false.
+ Returns \c true if overlay plane is enabled; otherwise returns \c false.
Overlay is disabled by default.
@@ -814,7 +814,7 @@ void QGLFormat::setOption(QGL::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()
*/
@@ -1107,8 +1107,8 @@ QGLFormat::OpenGLContextProfile QGLFormat::profile() const
/*!
\fn bool QGLFormat::hasOpenGL()
- Returns true if the window system has any OpenGL support;
- otherwise returns false.
+ Returns \c true if the window system has any OpenGL support;
+ otherwise returns \c false.
\warning This function must not be called until the QApplication
object has been created.
@@ -1119,8 +1119,8 @@ QGLFormat::OpenGLContextProfile QGLFormat::profile() const
/*!
\fn bool QGLFormat::hasOpenGLOverlays()
- Returns true if the window system supports OpenGL overlays;
- otherwise returns false.
+ Returns \c true if the window system supports OpenGL overlays;
+ otherwise returns \c false.
\warning This function must not be called until the QApplication
object has been created.
@@ -1459,8 +1459,8 @@ void QGLFormat::setDefaultOverlayFormat(const QGLFormat &f)
/*!
- Returns true if all the options of the two QGLFormat objects
- \a a and \a b are equal; otherwise returns false.
+ Returns \c true if all the options of the two QGLFormat objects
+ \a a and \a b are equal; otherwise returns \c false.
\relates QGLFormat
*/
@@ -1511,8 +1511,8 @@ QDebug operator<<(QDebug dbg, const QGLFormat &f)
/*!
- Returns false if all the options of the two QGLFormat objects
- \a a and \a b are equal; otherwise returns true.
+ Returns \c false if all the options of the two QGLFormat objects
+ \a a and \a b are equal; otherwise returns \c true.
\relates QGLFormat
*/
@@ -2903,8 +2903,8 @@ void QGLContext::setDevice(QPaintDevice *pDev)
/*!
\fn bool QGLContext::isValid() const
- Returns true if a GL rendering context has been successfully
- created; otherwise returns false.
+ Returns \c true if a GL rendering context has been successfully
+ created; otherwise returns \c false.
*/
/*!
@@ -2917,16 +2917,16 @@ void QGLContext::setDevice(QPaintDevice *pDev)
/*!
\fn bool QGLContext::isSharing() const
- Returns true if this context is sharing its GL context with
+ Returns \c true if this context is sharing its GL context with
another QGLContext, otherwise false is returned. Note that context
sharing might not be supported between contexts with different
formats.
*/
/*!
- Returns true if \a context1 and \a context2 are sharing their
+ Returns \c true if \a context1 and \a context2 are sharing their
GL resources such as textures, shader programs, etc;
- otherwise returns false.
+ otherwise returns \c false.
\since 4.6
*/
@@ -2940,15 +2940,15 @@ bool QGLContext::areSharing(const QGLContext *context1, const QGLContext *contex
/*!
\fn bool QGLContext::deviceIsPixmap() const
- Returns true if the paint device of this context is a pixmap;
- otherwise returns false.
+ Returns \c true if the paint device of this context is a pixmap;
+ otherwise returns \c false.
*/
/*!
\fn bool QGLContext::windowCreated() const
- Returns true if a window has been created for this context;
- otherwise returns false.
+ Returns \c true if a window has been created for this context;
+ otherwise returns \c false.
\sa setWindowCreated()
*/
@@ -2975,9 +2975,9 @@ bool QGLContext::areSharing(const QGLContext *context1, const QGLContext *contex
/*!
\fn bool QGLContext::initialized() const
- Returns true if this context has been initialized, i.e. if
+ Returns \c true if this context has been initialized, i.e. if
QGLWidget::initializeGL() has been performed on it; otherwise
- returns false.
+ returns \c false.
\sa setInitialized()
*/
@@ -3021,9 +3021,9 @@ bool QGLContext::areSharing(const QGLContext *context1, const QGLContext *contex
/*!
- Creates the GL context. Returns true if it was successful in
+ Creates the GL context. Returns \c true if it was successful in
creating a valid GL rendering context on the paint device
- specified in the constructor; otherwise returns false (i.e. the
+ specified in the constructor; otherwise returns \c false (i.e. the
context is invalid).
If the OpenGL implementation on your system does not support the requested
@@ -3627,8 +3627,8 @@ QGLWidget::~QGLWidget()
/*!
\fn bool QGLWidget::doubleBuffer() const
- Returns true if the contained GL rendering context has double
- buffering; otherwise returns false.
+ Returns \c true if the contained GL rendering context has double
+ buffering; otherwise returns \c false.
\sa QGLFormat::doubleBuffer()
*/
@@ -3651,8 +3651,8 @@ QGLWidget::~QGLWidget()
/*!
\fn bool QGLWidget::autoBufferSwap() const
- Returns true if the widget is doing automatic GL buffer swapping;
- otherwise returns false.
+ Returns \c true if the widget is doing automatic GL buffer swapping;
+ otherwise returns \c false.
\sa setAutoBufferSwap()
*/
@@ -3668,8 +3668,8 @@ QGLWidget::~QGLWidget()
/*!
\fn bool QGLWidget::isValid() const
- Returns true if the widget has a valid GL rendering context;
- otherwise returns false. A widget will be invalid if the system
+ Returns \c true if the widget has a valid GL rendering context;
+ otherwise returns \c false. A widget will be invalid if the system
has no \l{QGLFormat::hasOpenGL()}{OpenGL support}.
*/
@@ -3682,7 +3682,7 @@ bool QGLWidget::isValid() const
/*!
\fn bool QGLWidget::isSharing() const
- Returns true if this widget's GL context is shared with another GL
+ Returns \c true if this widget's GL context is shared with another GL
context, otherwise false is returned. Context sharing might not be
possible if the widgets use different formats.
diff --git a/src/opengl/qglbuffer.cpp b/src/opengl/qglbuffer.cpp
index e10bc010c5..1c9545990f 100644
--- a/src/opengl/qglbuffer.cpp
+++ b/src/opengl/qglbuffer.cpp
@@ -267,7 +267,7 @@ namespace {
}
/*!
- Creates the buffer object in the GL server. Returns true if
+ Creates the buffer object in the GL server. Returns \c true if
the object was created; false otherwise.
This function must be called with a current QGLContext.
@@ -307,7 +307,7 @@ bool QGLBuffer::create()
#define ctx QGLContext::currentContext()
/*!
- Returns true if this buffer has been created; false otherwise.
+ Returns \c true if this buffer has been created; false otherwise.
\sa create(), destroy()
*/
@@ -333,7 +333,7 @@ void QGLBuffer::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.
@@ -414,7 +414,7 @@ void QGLBuffer::allocate(const void *data, int count)
/*!
Binds the buffer associated with this object to the current
- GL context. Returns false if binding was not possible, usually because
+ GL context. Returns \c false if binding was not possible, usually because
type() is not supported on this GL implementation.
The buffer must be bound to the same QGLContext current when create()
@@ -551,7 +551,7 @@ void *QGLBuffer::map(QGLBuffer::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/opengl/qglcolormap.cpp b/src/opengl/qglcolormap.cpp
index a10b1bfbbc..576e2c6552 100644
--- a/src/opengl/qglcolormap.cpp
+++ b/src/opengl/qglcolormap.cpp
@@ -229,8 +229,8 @@ QColor QGLColormap::entryColor(int idx) const
}
/*!
- Returns true if the colormap is empty or it is not in use
- by a QGLWidget; otherwise returns false.
+ Returns \c true if the colormap is empty or it is not in use
+ by a QGLWidget; otherwise returns \c false.
A colormap with no color values set is considered to be empty.
For historical reasons, a colormap that has color values set
diff --git a/src/opengl/qglframebufferobject.cpp b/src/opengl/qglframebufferobject.cpp
index 8210b218ec..fa3f653aee 100644
--- a/src/opengl/qglframebufferobject.cpp
+++ b/src/opengl/qglframebufferobject.cpp
@@ -249,7 +249,7 @@ void QGLFramebufferObjectFormat::setMipmap(bool enabled)
/*!
\since 4.8
- Returns true if mipmapping is enabled.
+ Returns \c true if mipmapping is enabled.
\sa setMipmap()
*/
@@ -331,8 +331,8 @@ GLenum QGLFramebufferObjectFormat::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 QGLFramebufferObjectFormat::operator==(const QGLFramebufferObjectFormat& other) const
{
@@ -343,8 +343,8 @@ bool QGLFramebufferObjectFormat::operator==(const QGLFramebufferObjectFormat& ot
}
/*!
- 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 QGLFramebufferObjectFormat::operator!=(const QGLFramebufferObjectFormat& other) const
{
@@ -946,7 +946,7 @@ QGLFramebufferObject::~QGLFramebufferObject()
/*!
\fn bool QGLFramebufferObject::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
@@ -972,7 +972,7 @@ bool QGLFramebufferObject::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()
*/
@@ -1004,7 +1004,7 @@ bool QGLFramebufferObject::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()
*/
@@ -1125,7 +1125,7 @@ QPaintEngine *QGLFramebufferObject::paintEngine() 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()
*/
@@ -1152,8 +1152,8 @@ bool QGLFramebufferObject::bindDefault()
/*!
\fn bool QGLFramebufferObject::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 QGLFramebufferObject::hasOpenGLFramebufferObjects()
{
@@ -1277,7 +1277,7 @@ QGLFramebufferObject::Attachment QGLFramebufferObject::attachment() const
/*!
\since 4.5
- 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.
*/
@@ -1293,8 +1293,8 @@ bool QGLFramebufferObject::isBound() const
\since 4.6
- 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/opengl/qglfunctions.cpp b/src/opengl/qglfunctions.cpp
index 3d3bc0e947..2e8caa30f6 100644
--- a/src/opengl/qglfunctions.cpp
+++ b/src/opengl/qglfunctions.cpp
@@ -323,7 +323,7 @@ QGLFunctions::OpenGLFeatures QGLFunctions::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 QGLContext associated with this function
diff --git a/src/opengl/qglpixelbuffer.cpp b/src/opengl/qglpixelbuffer.cpp
index e5e7de0fff..bcb2dd53db 100644
--- a/src/opengl/qglpixelbuffer.cpp
+++ b/src/opengl/qglpixelbuffer.cpp
@@ -213,7 +213,7 @@ QGLPixelBuffer::~QGLPixelBuffer()
/*! \fn bool QGLPixelBuffer::makeCurrent()
Makes this pbuffer the current OpenGL rendering context. Returns
- true on success; otherwise returns false.
+ true on success; otherwise returns \c false.
\sa QGLContext::makeCurrent(), doneCurrent()
*/
@@ -242,8 +242,8 @@ bool QGLPixelBuffer::makeCurrent()
/*! \fn bool QGLPixelBuffer::doneCurrent()
- Makes no context the current OpenGL context. Returns true on
- success; otherwise returns false.
+ Makes no context the current OpenGL context. Returns \c true on
+ success; otherwise returns \c false.
*/
bool QGLPixelBuffer::doneCurrent()
@@ -278,7 +278,7 @@ QGLContext *QGLPixelBuffer::context() const
/*! \fn bool QGLPixelBuffer::bindToDynamicTexture(GLuint texture_id)
Binds the texture specified by \a texture_id to this pbuffer.
- Returns true on success; otherwise returns false.
+ Returns \c true on success; otherwise returns \c false.
The texture must be of the same size and format as the pbuffer.
@@ -312,8 +312,8 @@ QGLContext *QGLPixelBuffer::context() const
/*! \fn bool QGLPixelBuffer::hasOpenGLPbuffers()
- Returns true if the OpenGL \c pbuffer extension is present on
- this system; otherwise returns false.
+ Returns \c true if the OpenGL \c pbuffer extension is present on
+ this system; otherwise returns \c false.
*/
/*!
@@ -406,7 +406,7 @@ Qt::HANDLE QGLPixelBuffer::handle() const
}
/*!
- Returns true if this pbuffer is valid; otherwise returns false.
+ Returns \c true if this pbuffer is valid; otherwise returns \c false.
*/
bool QGLPixelBuffer::isValid() const
{
diff --git a/src/opengl/qglshaderprogram.cpp b/src/opengl/qglshaderprogram.cpp
index e7b7ad1348..84e4c26ed1 100644
--- a/src/opengl/qglshaderprogram.cpp
+++ b/src/opengl/qglshaderprogram.cpp
@@ -399,7 +399,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()
*/
@@ -450,7 +450,7 @@ bool QGLShader::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()
*/
@@ -463,7 +463,7 @@ bool QGLShader::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()
*/
@@ -474,7 +474,7 @@ bool QGLShader::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()
@@ -515,7 +515,7 @@ QByteArray QGLShader::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()
*/
@@ -698,7 +698,7 @@ bool QGLShaderProgram::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.
@@ -735,7 +735,7 @@ bool QGLShaderProgram::addShader(QGLShader *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().
@@ -765,7 +765,7 @@ bool QGLShaderProgram::addShaderFromSourceCode(QGLShader::ShaderType type, const
\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().
@@ -785,7 +785,7 @@ bool QGLShaderProgram::addShaderFromSourceCode(QGLShader::ShaderType type, const
\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().
@@ -803,7 +803,7 @@ bool QGLShaderProgram::addShaderFromSourceCode(QGLShader::ShaderType type, const
/*!
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().
@@ -895,7 +895,7 @@ void QGLShaderProgram::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().
@@ -969,7 +969,7 @@ bool QGLShaderProgram::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()
*/
@@ -995,7 +995,7 @@ QString QGLShaderProgram::log() const
Binds this shader program to the active QGLContext 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().
@@ -3153,7 +3153,7 @@ GLenum QGLShaderProgram::geometryOutputType() 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.
@@ -3191,7 +3191,7 @@ void QGLShaderProgram::shaderDestroyed()
#undef context
/*!
- 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.