1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Fix documentation warnings for Qt OpenGL

Browse Source 
Task-number: QTBUG-86295
Change-Id: I4fff2d61f8f0513181150954440c9357acf73c1d
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Topi Reinio 2020-10-29 23:13:47 +01:00
parent ae347b23d6
commit afa341375d
4 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
examples/gui/doc/images/openglwindow-example.png → src/opengl/doc/images/openglwindow-example.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

3
src/opengl/doc/qtopengl.qdocconf
View File

@ -19,7 +19,8 @@ sourcedirs += .. \
exampledirs += ../../../examples/opengl \ exampledirs += ../../../examples/opengl \
. \ . \
snippets \ snippets \
.. .. \
../../gui/doc/snippets
imagedirs += images \ imagedirs += images \
../../../examples/opengl/doc/images ../../../examples/opengl/doc/images

8
src/opengl/qopenglversionfunctions.cpp
View File

@ -247,9 +247,9 @@ void QAbstractOpenGLFunctionsPrivate::removeExternalFunctions(QOpenGLContext *co
A pointer to an object of the class corresponding to the version and A pointer to an object of the class corresponding to the version and
profile of OpenGL in use can be obtained from profile of OpenGL in use can be obtained from
QOpenGLContext::versionFunctions(). If obtained in this way, note that QOpenGLVersionFunctionsFactory::get(). If obtained in this way, note that
the QOpenGLContext retains ownership of the object. This is so that only the QOpenGLContext retains ownership of the object. This is so that the
one instance need be created. instance can be cached and shared.
Before calling any of the exposed OpenGL functions you must ensure that the Before calling any of the exposed OpenGL functions you must ensure that the
object has resolved the function pointers to the OpenGL functions. This object has resolved the function pointers to the OpenGL functions. This
@ -266,7 +266,7 @@ void QAbstractOpenGLFunctionsPrivate::removeExternalFunctions(QOpenGLContext *co
profile. This is obviously a lot easier to debug than undefined behavior profile. This is obviously a lot easier to debug than undefined behavior
at run time. at run time.
\sa QOpenGLContext::versionFunctions() \sa QOpenGLVersionFunctionsFactory::get()
*/ */
/*! /*!
Constructs a QAbstractOpenGLFunctions object. Constructs a QAbstractOpenGLFunctions object.

8
src/opengl/qopenglversionfunctionsfactory.cpp
View File

@ -161,6 +161,14 @@ static QAbstractOpenGLFunctions *createFunctions(const QOpenGLVersionProfile &ve
#endif #endif
} }
/*!
\class QOpenGLVersionFunctionsFactory
\inmodule QtOpenGL
\since 6.0
\brief Provides access to OpenGL functions for a specified version and
profile.
*/
/*! /*!
\fn static T *QOpenGLVersionFunctionsFactory::get(QOpenGLContext *context) \fn static T *QOpenGLVersionFunctionsFactory::get(QOpenGLContext *context)