1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Organize QtOpenGLWidgets documentation

Browse Source 
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>
This commit is contained in:
Volker Hilsheimer 2020-10-28 18:25:27 +01:00
parent 61574ee963
commit 7635d77689
7 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/opengl/doc/qtopengl.qdocconf
View File

@ -11,8 +11,10 @@ project = QtOpenGL
# <rootdir>/examples. # <rootdir>/examples.
# Paths are relative to the location of this file. # Paths are relative to the location of this file.
headerdirs += .. headerdirs += .. \
../../openglwidgets
sourcedirs += .. \ sourcedirs += .. \
../../openglwidgets \
../../../examples/opengl/doc/src ../../../examples/opengl/doc/src
exampledirs += ../../../examples/opengl \ exampledirs += ../../../examples/opengl \
. \ . \

0
src/widgets/doc/snippets/code/doc_gui_widgets_qopenglwidget.cpp → src/opengl/doc/snippets/code/doc_gui_widgets_qopenglwidget.cpp
View File

0
src/gui/doc/snippets/code/src_gui_opengl_qopenglbuffer.cpp → src/opengl/doc/snippets/code/src_gui_opengl_qopenglbuffer.cpp
View File

0
src/gui/doc/snippets/code/src_gui_opengl_qopengldebug.cpp → src/opengl/doc/snippets/code/src_gui_opengl_qopengldebug.cpp
View File

0
src/gui/doc/snippets/code/src_gui_qopenglshaderprogram.cpp → src/opengl/doc/snippets/code/src_gui_qopenglshaderprogram.cpp
View File

3
src/opengl/doc/src/qtopengl-index.qdoc
View File

@ -31,9 +31,6 @@
\brief The Qt OpenGL module offers classes that make it easy to \brief The Qt OpenGL module offers classes that make it easy to
use OpenGL in Qt applications. 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 \section1 Introduction
OpenGL is a standard API for rendering 3D graphics. OpenGL only OpenGL is a standard API for rendering 3D graphics. OpenGL only

16
src/opengl/doc/src/qtopengl-module.qdoc
View File

@ -35,5 +35,19 @@
\brief The Qt OpenGL module offers classes that make it easy to \brief The Qt OpenGL module offers classes that make it easy to
use OpenGL in Qt applications. 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
*/ */