From 3ed2ec14870c4035cfd1bd986f6d8f4f55890270 Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Mon, 24 Mar 2014 16:20:11 +0100 Subject: Fix some documentation errors. Correct links and fix typos, remove obsolete documentation, fix some snippets, mark some classes as internal. Change-Id: I9a3266605f060783413d32740057a57a820c8929 Reviewed-by: Laszlo Agocs --- src/opengl/qgl.cpp | 47 +-------------------------------------------- src/opengl/qglfunctions.cpp | 4 ++-- 2 files changed, 3 insertions(+), 48 deletions(-) (limited to 'src/opengl') diff --git a/src/opengl/qgl.cpp b/src/opengl/qgl.cpp index de1de476b8..e602a05af9 100644 --- a/src/opengl/qgl.cpp +++ b/src/opengl/qgl.cpp @@ -3227,43 +3227,6 @@ void QGLContext::moveToThread(QThread *thread) visual. On other platforms it may work differently. */ -/*! \fn int QGLContext::choosePixelFormat(void* dummyPfd, HDC pdc) - - \b{Win32 only:} This virtual function chooses a pixel format - that matches the OpenGL \l{setFormat()}{format}. - Reimplement this function in a subclass if you need a custom - context. - - \warning The \a dummyPfd pointer and \a pdc are used as a \c - PIXELFORMATDESCRIPTOR*. We use \c void to avoid using - Windows-specific types in our header files. - - \sa chooseContext() -*/ - -/*! \fn void *QGLContext::chooseVisual() - - \b{X11 only:} This virtual function tries to find a visual that - matches the format, reducing the demands if the original request - cannot be met. - - The algorithm for reducing the demands of the format is quite - simple-minded, so override this method in your subclass if your - application has spcific requirements on visual selection. - - \sa chooseContext() -*/ - -/*! \fn void *QGLContext::tryVisual(const QGLFormat& f, int bufDepth) - \internal - - \b{X11 only:} This virtual function chooses a visual that matches - the OpenGL \l{format()}{format}. Reimplement this function - in a subclass if you need a custom visual. - - \sa chooseContext() -*/ - /*! \fn void QGLContext::reset() @@ -3706,7 +3669,7 @@ QGLWidget::~QGLWidget() */ /*! - \fn QFunctionPointer QGLContext::getProcAddress() const + \fn QFunctionPointer QGLContext::getProcAddress(const QString &proc) const Returns a function pointer to the GL extension function passed in \a proc. 0 is returned if a pointer to the function could not be @@ -4045,14 +4008,6 @@ void QGLWidget::paintEvent(QPaintEvent *) */ -/*! - \fn void QGLWidget::setMouseTracking(bool enable) - - If \a enable is true then mouse tracking is enabled; otherwise it - is disabled. -*/ - - /*! Renders the current scene on a pixmap and returns the pixmap. diff --git a/src/opengl/qglfunctions.cpp b/src/opengl/qglfunctions.cpp index 450f17b171..d6d77d0568 100644 --- a/src/opengl/qglfunctions.cpp +++ b/src/opengl/qglfunctions.cpp @@ -466,7 +466,7 @@ void QGLFunctions::initializeGLFunctions(const QGLContext *context) */ /*! - \fn void QGLFunctions::glBufferData(GLenum target, qgl_GLsizeiptr size, const void* data, GLenum usage) + \fn void QGLFunctions::glBufferData(GLenum target, qopengl_GLsizeiptr size, const void* data, GLenum usage) Convenience function that calls glBufferData(\a target, \a size, \a data, \a usage). @@ -475,7 +475,7 @@ void QGLFunctions::initializeGLFunctions(const QGLContext *context) */ /*! - \fn void QGLFunctions::glBufferSubData(GLenum target, qgl_GLintptr offset, qgl_GLsizeiptr size, const void* data) + \fn void QGLFunctions::glBufferSubData(GLenum target, qopengl_GLintptr offset, qopengl_GLsizeiptr size, const void* data) Convenience function that calls glBufferSubData(\a target, \a offset, \a size, \a data). -- cgit v1.2.3 From 3c68252bf58a80fcf75fffcc2e0c976b1aa172fb Mon Sep 17 00:00:00 2001 From: Jonathan Liu Date: Thu, 27 Mar 2014 01:50:11 +1100 Subject: Doc: Fix typos Change-Id: I720813b126f02d4813c88811316a0fa99961c6d8 Reviewed-by: Friedemann Kleint --- src/opengl/doc/src/qtopengl-index.qdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src/opengl') diff --git a/src/opengl/doc/src/qtopengl-index.qdoc b/src/opengl/doc/src/qtopengl-index.qdoc index fc131c4b17..ff946c6e4e 100644 --- a/src/opengl/doc/src/qtopengl-index.qdoc +++ b/src/opengl/doc/src/qtopengl-index.qdoc @@ -68,5 +68,5 @@ non-OpenGL-specific GUI functionality. The \l{Qt OpenGL C++ Classes} page gives an overview over the available classes - int this module. + in this module. */ -- cgit v1.2.3