diff options
author | Topi Reinio <topi.reinio@digia.com> | 2013-09-03 14:38:45 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-09-09 10:40:37 +0200 |
commit | e5ee6c00946d3a13502e460b7ca8354aa35586a9 (patch) | |
tree | 09cc37097978b4c8a4e10ad390736da599dedc3c | |
parent | 656fb307202a750594ff3f499431f55c9b57a8f9 (diff) |
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>
24 files changed, 134 insertions, 23 deletions
diff --git a/src/gui/opengl/qopenglfunctions_1_0.cpp b/src/gui/opengl/qopenglfunctions_1_0.cpp index b618dcb5cf..f368bda76d 100644 --- a/src/gui/opengl/qopenglfunctions_1_0.cpp +++ b/src/gui/opengl/qopenglfunctions_1_0.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_1_1.cpp b/src/gui/opengl/qopenglfunctions_1_1.cpp index bf032b5cf9..d101c5c406 100644 --- a/src/gui/opengl/qopenglfunctions_1_1.cpp +++ b/src/gui/opengl/qopenglfunctions_1_1.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_1_2.cpp b/src/gui/opengl/qopenglfunctions_1_2.cpp index 2b14900680..1c6ad1ddff 100644 --- a/src/gui/opengl/qopenglfunctions_1_2.cpp +++ b/src/gui/opengl/qopenglfunctions_1_2.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_1_3.cpp b/src/gui/opengl/qopenglfunctions_1_3.cpp index 94605f8638..aef3789f9a 100644 --- a/src/gui/opengl/qopenglfunctions_1_3.cpp +++ b/src/gui/opengl/qopenglfunctions_1_3.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_1_4.cpp b/src/gui/opengl/qopenglfunctions_1_4.cpp index e3035eeb55..24b4c0ba7a 100644 --- a/src/gui/opengl/qopenglfunctions_1_4.cpp +++ b/src/gui/opengl/qopenglfunctions_1_4.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_1_5.cpp b/src/gui/opengl/qopenglfunctions_1_5.cpp index 581ed14aac..b5a9486629 100644 --- a/src/gui/opengl/qopenglfunctions_1_5.cpp +++ b/src/gui/opengl/qopenglfunctions_1_5.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_2_0.cpp b/src/gui/opengl/qopenglfunctions_2_0.cpp index 2736d4a030..0645750858 100644 --- a/src/gui/opengl/qopenglfunctions_2_0.cpp +++ b/src/gui/opengl/qopenglfunctions_2_0.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_2_1.cpp b/src/gui/opengl/qopenglfunctions_2_1.cpp index ed94131e33..133f3bf0cb 100644 --- a/src/gui/opengl/qopenglfunctions_2_1.cpp +++ b/src/gui/opengl/qopenglfunctions_2_1.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_3_0.cpp b/src/gui/opengl/qopenglfunctions_3_0.cpp index e80235b957..ae56b50b31 100644 --- a/src/gui/opengl/qopenglfunctions_3_0.cpp +++ b/src/gui/opengl/qopenglfunctions_3_0.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_3_1.cpp b/src/gui/opengl/qopenglfunctions_3_1.cpp index ab48658bfc..5014fdb62c 100644 --- a/src/gui/opengl/qopenglfunctions_3_1.cpp +++ b/src/gui/opengl/qopenglfunctions_3_1.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_3_2_compatibility.cpp b/src/gui/opengl/qopenglfunctions_3_2_compatibility.cpp index 171b7454f4..a6de8fd0fe 100644 --- a/src/gui/opengl/qopenglfunctions_3_2_compatibility.cpp +++ b/src/gui/opengl/qopenglfunctions_3_2_compatibility.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_3_2_core.cpp b/src/gui/opengl/qopenglfunctions_3_2_core.cpp index 48dec29962..2c41d3a5fe 100644 --- a/src/gui/opengl/qopenglfunctions_3_2_core.cpp +++ b/src/gui/opengl/qopenglfunctions_3_2_core.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_3_3_compatibility.cpp b/src/gui/opengl/qopenglfunctions_3_3_compatibility.cpp index 8bebc7d0bc..dc36eba1ad 100644 --- a/src/gui/opengl/qopenglfunctions_3_3_compatibility.cpp +++ b/src/gui/opengl/qopenglfunctions_3_3_compatibility.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_3_3_core.cpp b/src/gui/opengl/qopenglfunctions_3_3_core.cpp index 941f9c38b6..5a1e238d0e 100644 --- a/src/gui/opengl/qopenglfunctions_3_3_core.cpp +++ b/src/gui/opengl/qopenglfunctions_3_3_core.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_4_0_compatibility.cpp b/src/gui/opengl/qopenglfunctions_4_0_compatibility.cpp index 7ab0688084..7affa43da1 100644 --- a/src/gui/opengl/qopenglfunctions_4_0_compatibility.cpp +++ b/src/gui/opengl/qopenglfunctions_4_0_compatibility.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_4_0_core.cpp b/src/gui/opengl/qopenglfunctions_4_0_core.cpp index a4bf66a44b..5e8bd8d6a5 100644 --- a/src/gui/opengl/qopenglfunctions_4_0_core.cpp +++ b/src/gui/opengl/qopenglfunctions_4_0_core.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_4_1_compatibility.cpp b/src/gui/opengl/qopenglfunctions_4_1_compatibility.cpp index a0ea4a052a..44e937557a 100644 --- a/src/gui/opengl/qopenglfunctions_4_1_compatibility.cpp +++ b/src/gui/opengl/qopenglfunctions_4_1_compatibility.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_4_1_core.cpp b/src/gui/opengl/qopenglfunctions_4_1_core.cpp index 474397bb1f..04fcc78d5d 100644 --- a/src/gui/opengl/qopenglfunctions_4_1_core.cpp +++ b/src/gui/opengl/qopenglfunctions_4_1_core.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_4_2_compatibility.cpp b/src/gui/opengl/qopenglfunctions_4_2_compatibility.cpp index 6d19fff92b..1329327f3e 100644 --- a/src/gui/opengl/qopenglfunctions_4_2_compatibility.cpp +++ b/src/gui/opengl/qopenglfunctions_4_2_compatibility.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_4_2_core.cpp b/src/gui/opengl/qopenglfunctions_4_2_core.cpp index 51ba3e8097..652d5810c5 100644 --- a/src/gui/opengl/qopenglfunctions_4_2_core.cpp +++ b/src/gui/opengl/qopenglfunctions_4_2_core.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_4_3_compatibility.cpp b/src/gui/opengl/qopenglfunctions_4_3_compatibility.cpp index de6cc185c6..19fffc8f2e 100644 --- a/src/gui/opengl/qopenglfunctions_4_3_compatibility.cpp +++ b/src/gui/opengl/qopenglfunctions_4_3_compatibility.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_4_3_core.cpp b/src/gui/opengl/qopenglfunctions_4_3_core.cpp index 29fc8368aa..b9659eeb88 100644 --- a/src/gui/opengl/qopenglfunctions_4_3_core.cpp +++ b/src/gui/opengl/qopenglfunctions_4_3_core.cpp @@ -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 */ diff --git a/src/gui/opengl/qopenglfunctions_es2.cpp b/src/gui/opengl/qopenglfunctions_es2.cpp index 20a4b50994..5e0efbd02e 100644 --- a/src/gui/opengl/qopenglfunctions_es2.cpp +++ b/src/gui/opengl/qopenglfunctions_es2.cpp @@ -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 */ diff --git a/util/glgen/codegenerator.cpp b/util/glgen/codegenerator.cpp index c6a77569dc..693e33cf67 100644 --- a/util/glgen/codegenerator.cpp +++ b/util/glgen/codegenerator.cpp @@ -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; |