From 25bda72630af1529fbca4ef821c45e3b74896ada Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 11 Nov 2020 16:59:49 +0100 Subject: Doc: Fix documentation warnings for Qt OpenGL Use a custom module header for the documentation build that pulls in also QtOpenGLWidgets' headers. Fixes: QTBUG-88275 Change-Id: I4e1144b179a124b01114de24cc183289fa05fb33 Reviewed-by: Paul Wicking --- src/opengl/doc/QtOpenGLDoc | 2 ++ src/opengl/doc/qtopengl.qdocconf | 4 ++++ src/opengl/doc/src/qtopengl-index.qdoc | 3 ++- 3 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 src/opengl/doc/QtOpenGLDoc (limited to 'src/opengl/doc') diff --git a/src/opengl/doc/QtOpenGLDoc b/src/opengl/doc/QtOpenGLDoc new file mode 100644 index 0000000000..2e98521801 --- /dev/null +++ b/src/opengl/doc/QtOpenGLDoc @@ -0,0 +1,2 @@ +#include +#include diff --git a/src/opengl/doc/qtopengl.qdocconf b/src/opengl/doc/qtopengl.qdocconf index f225e19df2..3d9b0ac3fb 100644 --- a/src/opengl/doc/qtopengl.qdocconf +++ b/src/opengl/doc/qtopengl.qdocconf @@ -1,6 +1,10 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) include($QT_INSTALL_DOCS/config/exampleurl-qtbase.qdocconf) +# Use a custom module header that pulls in also QtOpenGLWidgets +includepaths += . +moduleheader = QtOpenGLDoc + # Name of the project which must match the outputdir. Determines the .index file project = QtOpenGL diff --git a/src/opengl/doc/src/qtopengl-index.qdoc b/src/opengl/doc/src/qtopengl-index.qdoc index b902599c75..d09d508fb3 100644 --- a/src/opengl/doc/src/qtopengl-index.qdoc +++ b/src/opengl/doc/src/qtopengl-index.qdoc @@ -42,7 +42,8 @@ wrapper around the platform-dependent GLX (version 1.3 or later), WGL, or AGL C APIs. Although the basic functionality provided is very similar to Mark Kilgard's GLUT library, applications can use the - other \l{Qt modules} to implement the rest of the user interface. + other \l{All Modules}{Qt modules} to implement the rest of the user + interface. The \l{Qt OpenGL C++ Classes} page gives an overview over the available classes in this module. -- cgit v1.2.3