summaryrefslogtreecommitdiffstats
path: root/src/gui/opengl/qopenglbuffer.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/opengl/qopenglbuffer.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/opengl/qopenglbuffer.cpp')
-rw-r--r--src/gui/opengl/qopenglbuffer.cpp10
1 files changed, 5 insertions, 5 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,