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>

11 files changed, 60 insertions, 60 deletions

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.