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>
This commit is contained in:
Jan Arve Saether 2012-11-27 15:09:17 +01:00 committed by The Qt Project
parent 7a7102ad07
commit 96cded6667
8 changed files with 15 additions and 2 deletions

View File

@ -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.

View File

@ -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,

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -41,6 +41,7 @@
/*!
\class QGLPixelBuffer
\inmodule QtOpenGL
\brief The QGLPixelBuffer class encapsulates an OpenGL pbuffer.
\since 4.1
\obsolete

View File

@ -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

View File

@ -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