diff options
| author | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2020-10-28 18:25:27 +0100 |
|---|---|---|
| committer | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2020-10-29 09:48:28 +0100 |
| commit | 7635d77689193e729db248300634571aea4d8c81 (patch) | |
| tree | 3b3d47208c25d209f6d6a9d94b36f8dfab457559 /src/opengl/doc/src | |
| parent | 61574ee963a5c3f70ede89c1a7367db621164b6f (diff) | |
Organize QtOpenGLWidgets documentation
Move snippets to the right place, and give the widgets class a place to
live.
QtOpenGLWidgets is just a library, not a separate module, but we need a
module page that the class can refer to for correct build instructions.
Change-Id: I6d955ad3c4cd1003a828cc1f256deb6e7fb50ec4
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/opengl/doc/src')
| -rw-r--r-- | src/opengl/doc/src/qtopengl-index.qdoc | 3 | ||||
| -rw-r--r-- | src/opengl/doc/src/qtopengl-module.qdoc | 16 |
2 files changed, 15 insertions, 4 deletions
diff --git a/src/opengl/doc/src/qtopengl-index.qdoc b/src/opengl/doc/src/qtopengl-index.qdoc index 53f1599c1b..a655a3e20f 100644 --- a/src/opengl/doc/src/qtopengl-index.qdoc +++ b/src/opengl/doc/src/qtopengl-index.qdoc @@ -31,9 +31,6 @@ \brief The Qt OpenGL module offers classes that make it easy to use OpenGL in Qt applications. - \warning This module should not be used anymore for new code. Please - use the corresponding OpenGL classes in \l{Qt GUI}. - \section1 Introduction OpenGL is a standard API for rendering 3D graphics. OpenGL only diff --git a/src/opengl/doc/src/qtopengl-module.qdoc b/src/opengl/doc/src/qtopengl-module.qdoc index 0ba78ed5dc..0d1c9e687f 100644 --- a/src/opengl/doc/src/qtopengl-module.qdoc +++ b/src/opengl/doc/src/qtopengl-module.qdoc @@ -35,5 +35,19 @@ \brief The Qt OpenGL module offers classes that make it easy to use OpenGL in Qt applications. - \warning This module should not be used anymore for new code. + The \l{Qt OpenGL Widgets C++ Classes}{Qt OpenGL Widgets} library provides + a C++ widget class for rendering OpenGL graphics into widgets UIs. + + \generatelist classesbymodule QtOpenGLWidgets +*/ + +/* + This "module" only exists so that classes in that separate library have + the correct build system documentation. +*/ +/*! + \module QtOpenGLWidgets + \title Qt OpenGL Widgets C++ Classes + \qtcmakepackage OpenGLWidgets + \qtvariable openglwidgets */ |