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/opengl/qglbuffer.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/opengl/qglbuffer.cpp')
-rw-r--r-- | src/opengl/qglbuffer.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
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, |