Doc: Link to external docs in QOpenGLFunctions_* classes
These are wrapper classes that do not document their functions. This change adds links to docs on opengl.org / khronos.org where suitable, and changes the \brief commands to mention the correct OpenGL version/profile. Change-Id: I48154d5bce26f6753ca4400962939847c78a527d Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
This commit is contained in:
parent
656fb30720
commit
e5ee6c0094
src/gui/opengl
qopenglfunctions_1_0.cppqopenglfunctions_1_1.cppqopenglfunctions_1_2.cppqopenglfunctions_1_3.cppqopenglfunctions_1_4.cppqopenglfunctions_1_5.cppqopenglfunctions_2_0.cppqopenglfunctions_2_1.cppqopenglfunctions_3_0.cppqopenglfunctions_3_1.cppqopenglfunctions_3_2_compatibility.cppqopenglfunctions_3_2_core.cppqopenglfunctions_3_3_compatibility.cppqopenglfunctions_3_3_core.cppqopenglfunctions_4_0_compatibility.cppqopenglfunctions_4_0_core.cppqopenglfunctions_4_1_compatibility.cppqopenglfunctions_4_1_core.cppqopenglfunctions_4_2_compatibility.cppqopenglfunctions_4_2_core.cppqopenglfunctions_4_3_compatibility.cppqopenglfunctions_4_3_core.cppqopenglfunctions_es2.cpp
util/glgen
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_1_0 class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_1_0 class provides all functions for OpenGL 1.0 specification.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 1.0 specification.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_1_1 class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_1_1 class provides all functions for OpenGL 1.1 specification.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 1.1 specification.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_1_2 class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_1_2 class provides all functions for OpenGL 1.2 specification.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 1.2 specification.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_1_3 class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_1_3 class provides all functions for OpenGL 1.3 specification.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 1.3 specification.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_1_4 class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_1_4 class provides all functions for OpenGL 1.4 specification.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 1.4 specification.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_1_5 class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_1_5 class provides all functions for OpenGL 1.5 specification.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 1.5 specification.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_2_0 class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_2_0 class provides all functions for OpenGL 2.0 specification.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 2.0 specification.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_2_1 class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_2_1 class provides all functions for OpenGL 2.1 specification.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 2.1 specification.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_3_0 class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_3_0 class provides all functions for OpenGL 3.0 specification.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 3.0 specification.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_3_1 class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_3_1 class provides all functions for OpenGL 3.1 specification.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 3.1 specification.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_3_2_Compatibility class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_3_2_Compatibility class provides all functions for OpenGL 3.2 compatibility profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 3.2 compatibility profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_3_2_Core class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_3_2_Core class provides all functions for OpenGL 3.2 core profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 3.2 core profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_3_3_Compatibility class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_3_3_Compatibility class provides all functions for OpenGL 3.3 compatibility profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 3.3 compatibility profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_3_3_Core class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_3_3_Core class provides all functions for OpenGL 3.3 core profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 3.3 core profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_4_0_Compatibility class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_4_0_Compatibility class provides all functions for OpenGL 4.0 compatibility profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 4.0 compatibility profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_4_0_Core class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_4_0_Core class provides all functions for OpenGL 4.0 core profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 4.0 core profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_4_1_Compatibility class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_4_1_Compatibility class provides all functions for OpenGL 4.1 compatibility profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 4.1 compatibility profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_4_1_Core class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_4_1_Core class provides all functions for OpenGL 4.1 core profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 4.1 core profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_4_2_Compatibility class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_4_2_Compatibility class provides all functions for OpenGL 4.2 compatibility profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 4.2 compatibility profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_4_2_Core class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_4_2_Core class provides all functions for OpenGL 4.2 core profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 4.2 core profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_4_3_Compatibility class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_4_3_Compatibility class provides all functions for OpenGL 4.3 compatibility profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 4.3 compatibility profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -58,7 +58,11 @@ QT_BEGIN_NAMESPACE
|
||||
\inmodule QtGui
|
||||
\since 5.1
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_4_3_Core class provides all functions for this version and profile of OpenGL.
|
||||
\brief The QOpenGLFunctions_4_3_Core class provides all functions for OpenGL 4.3 core profile.
|
||||
|
||||
This class is a wrapper for functions from OpenGL 4.3 core profile.
|
||||
See reference pages on \l {http://www.opengl.org/sdk/docs/}{opengl.org}
|
||||
for function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
@ -51,6 +51,10 @@ QT_BEGIN_NAMESPACE
|
||||
\wrapper
|
||||
\brief The QOpenGLFunctions_ES2 class provides all functions for OpenGL ES 2
|
||||
|
||||
This class is a wrapper for OpenGL ES 2 functions. See reference pages on
|
||||
\l {http://www.khronos.org/opengles/sdk/docs/man/}{khronos.org} for
|
||||
function documentation.
|
||||
|
||||
\sa QAbstractOpenGLFunctions
|
||||
*/
|
||||
|
||||
|
@ -593,8 +593,27 @@ void CodeGenerator::writePublicClassImplementation(const QString &baseFileName,
|
||||
<< QStringLiteral(" \\class ") << className << endl
|
||||
<< QStringLiteral(" \\inmodule QtGui") << endl
|
||||
<< QStringLiteral(" \\since 5.1") << endl
|
||||
<< QStringLiteral(" \\wrapper") << endl
|
||||
<< QStringLiteral(" \\brief The ") << className
|
||||
<< QStringLiteral(" class provides all functions for this version and profile of OpenGL.") << endl << endl
|
||||
<< QString(QStringLiteral(" class provides all functions for OpenGL %1.%2 "))
|
||||
.arg(versionProfile.version.major)
|
||||
.arg(versionProfile.version.minor);
|
||||
|
||||
if (!profileSuffix.isEmpty()) {
|
||||
profileSuffix.remove(0, 1);
|
||||
profileSuffix.append(QStringLiteral(" profile"));
|
||||
} else {
|
||||
profileSuffix = "specification";
|
||||
}
|
||||
|
||||
stream << profileSuffix << QStringLiteral(".") << endl << endl
|
||||
<< QStringLiteral(" This class is a wrapper for functions from ")
|
||||
<< QString(QStringLiteral("OpenGL %1.%2 "))
|
||||
.arg(versionProfile.version.major)
|
||||
.arg(versionProfile.version.minor)
|
||||
<< profileSuffix << QStringLiteral(".") << endl
|
||||
<< QStringLiteral(" See reference pages on \\l {http://www.opengl.org/sdk/docs/}{opengl.org}") << endl
|
||||
<< QStringLiteral(" for function documentation.") << endl << endl
|
||||
<< QStringLiteral(" \\sa QAbstractOpenGLFunctions") << endl
|
||||
<< QStringLiteral("*/") << endl << endl;
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user