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/qglpixelbuffer.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/qglpixelbuffer.cpp')
| -rw-r--r-- | src/opengl/qglpixelbuffer.cpp | 14 |
1 files changed, 7 insertions, 7 deletions
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 { |