Improve OpenGL docs

* Mark all Open GL classes with \inmodule QtOpenGL. Otherwise, they
  weren't listed in the list of classes.
* Remove a reference to Motif

Change-Id: I75680712b212cf46b869014d3678b56d022c6323
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>

diff --git a/src/opengl/doc/src/qtopengl.qdoc b/src/opengl/doc/src/qtopengl.qdoc
index fef543c..38f9a0b 100644 (file)
--- a/src/opengl/doc/src/qtopengl.qdoc
+++ b/src/opengl/doc/src/qtopengl.qdoc
@@ -37,7 +37,7 @@
     OpenGL is a standard API for rendering 3D graphics. OpenGL only
     deals with 3D rendering and provides little or no support for GUI
     programming issues. The user interface for an OpenGL application
-    must be created with another toolkit, such as Motif on the X
+    must be created with another toolkit, such as Cocoa on the Mac OS X
     platform, Microsoft Foundation Classes (MFC) under Windows, or Qt
     on both platforms.
 

diff --git a/src/opengl/qgl.cpp b/src/opengl/qgl.cpp
index accfcae..f5c84a4 100644 (file)
--- a/src/opengl/qgl.cpp
+++ b/src/opengl/qgl.cpp
@@ -162,6 +162,8 @@ QGLSignalProxy *QGLSignalProxy::instance()
 
 /*!
     \class QGLFormat
+    \inmodule QtOpenGL
+
     \brief The QGLFormat class specifies the display format of an OpenGL
     rendering context.
 
@@ -1809,6 +1811,8 @@ struct DDSFormat {
 
 /*!
     \class QGLContext
+    \inmodule QtOpenGL
+
     \brief The QGLContext class encapsulates an OpenGL rendering context.
 
     \ingroup painting-3D
@@ -3234,11 +3238,12 @@ void QGLContextPrivate::setCurrentContext(QGLContext *context)
 
 /*!
     \class QGLWidget
+    \inmodule QtOpenGL
+
     \brief The QGLWidget class is a widget for rendering OpenGL graphics.
 
     \ingroup painting-3D
 
-
     QGLWidget provides functionality for displaying OpenGL graphics
     integrated into a Qt application. It is very simple to use. You
     inherit from it and use the subclass like any other QWidget,

diff --git a/src/opengl/qglbuffer.cpp b/src/opengl/qglbuffer.cpp
index acb13d6..a052c0a 100644 (file)
--- a/src/opengl/qglbuffer.cpp
+++ b/src/opengl/qglbuffer.cpp
@@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \class QGLBuffer
+    \inmodule QtOpenGL
     \brief The QGLBuffer class provides functions for creating and managing GL buffer objects.
     \since 4.7
     \obsolete

diff --git a/src/opengl/qglframebufferobject.cpp b/src/opengl/qglframebufferobject.cpp
index a5c2d1c..efc6690 100644 (file)
--- a/src/opengl/qglframebufferobject.cpp
+++ b/src/opengl/qglframebufferobject.cpp
@@ -104,6 +104,7 @@ extern QImage qt_gl_read_framebuffer(const QSize&, bool, bool);
 
 /*!
     \class QGLFramebufferObjectFormat
+    \inmodule QtOpenGL
     \brief The QGLFramebufferObjectFormat class specifies the format of an OpenGL
     framebuffer object.
 
@@ -698,6 +699,7 @@ void QGLFramebufferObjectPrivate::init(QGLFramebufferObject *q, const QSize &sz,
 
 /*!
     \class QGLFramebufferObject
+    \inmodule QtOpenGL
     \brief The QGLFramebufferObject class encapsulates an OpenGL framebuffer object.
     \since 4.2
 

diff --git a/src/opengl/qglfunctions.cpp b/src/opengl/qglfunctions.cpp
index 67f6c25..8db6e3a 100644 (file)
--- a/src/opengl/qglfunctions.cpp
+++ b/src/opengl/qglfunctions.cpp
@@ -47,6 +47,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \class QGLFunctions
+    \inmodule QtOpenGL
     \brief The QGLFunctions class provides cross-platform access to the OpenGL/ES 2.0 API.
     \since 4.8
     \obsolete

diff --git a/src/opengl/qglpixelbuffer.cpp b/src/opengl/qglpixelbuffer.cpp
index d39ac3d..a5e748a 100644 (file)
--- a/src/opengl/qglpixelbuffer.cpp
+++ b/src/opengl/qglpixelbuffer.cpp
@@ -41,6 +41,7 @@
 
 /*!
     \class QGLPixelBuffer
+    \inmodule QtOpenGL
     \brief The QGLPixelBuffer class encapsulates an OpenGL pbuffer.
     \since 4.1
     \obsolete

diff --git a/src/opengl/qglshaderprogram.cpp b/src/opengl/qglshaderprogram.cpp
index 17df516..1d8f3ab 100644 (file)
--- a/src/opengl/qglshaderprogram.cpp
+++ b/src/opengl/qglshaderprogram.cpp
@@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \class QGLShaderProgram
+    \inmodule QtOpenGL
     \brief The QGLShaderProgram class allows OpenGL shader programs to be linked and used.
     \since 4.6
     \obsolete
@@ -125,6 +126,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \class QGLShader
+    \inmodule QtOpenGL
     \brief The QGLShader class allows OpenGL shaders to be compiled.
     \since 4.6
     \obsolete

diff --git a/src/opengl/qgraphicsshadereffect.cpp b/src/opengl/qgraphicsshadereffect.cpp
index 3671c9b..fe4855d 100644 (file)
--- a/src/opengl/qgraphicsshadereffect.cpp
+++ b/src/opengl/qgraphicsshadereffect.cpp
@@ -51,6 +51,7 @@ QT_BEGIN_NAMESPACE
 
 /*#
     \class QGraphicsShaderEffect
+    \inmodule QtOpenGL
     \brief The QGraphicsShaderEffect class is the base class for creating
     custom GLSL shader effects in a QGraphicsScene.
     \since 4.6