summaryrefslogtreecommitdiffstats
path: root/src/opengl/doc
diff options
context:
space:
mode:
Diffstat (limited to 'src/opengl/doc')
-rw-r--r--src/opengl/doc/qtopengl.qdocconf15
-rw-r--r--src/opengl/doc/snippets/CMakeLists.txt3
-rw-r--r--src/opengl/doc/src/qt6-changes.qdoc2
-rw-r--r--src/opengl/doc/src/qtopengl-examples.qdoc2
-rw-r--r--src/opengl/doc/src/qtopengl-index.qdoc2
5 files changed, 13 insertions, 11 deletions
diff --git a/src/opengl/doc/qtopengl.qdocconf b/src/opengl/doc/qtopengl.qdocconf
index 58f16e7d2e..7af173aac8 100644
--- a/src/opengl/doc/qtopengl.qdocconf
+++ b/src/opengl/doc/qtopengl.qdocconf
@@ -15,18 +15,17 @@ project = QtOpenGL
# <rootdir>/examples.
# Paths are relative to the location of this file.
-headerdirs += .. \
- ../../openglwidgets
-sourcedirs += .. \
- ../../openglwidgets \
- ../../../examples/opengl/doc/src
+{sourcedirs,headerdirs} += \
+ .. \
+ ../../openglwidgets
+
exampledirs += ../../../examples/opengl \
. \
snippets \
.. \
../../gui/doc/snippets
-imagedirs += images \
- ../../../examples/opengl/doc/images
+
+imagedirs += images
depends += qtcore qtgui qtwidgets qtdoc qmake qtcmake qtquick
@@ -65,5 +64,5 @@ qhp.QtOpenGL.subprojects.classes.sortPages = true
navigation.landingpage = "Qt OpenGL"
navigation.cppclassespage = "Qt OpenGL C++ Classes"
-# Fail the documentation build if there are more warnings than the limit
+# Enforce zero documentation warnings
warninglimit = 0
diff --git a/src/opengl/doc/snippets/CMakeLists.txt b/src/opengl/doc/snippets/CMakeLists.txt
index aff5f13c15..419e0923e0 100644
--- a/src/opengl/doc/snippets/CMakeLists.txt
+++ b/src/opengl/doc/snippets/CMakeLists.txt
@@ -1,3 +1,6 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
#! [cmake_use]
find_package(Qt6 REQUIRED COMPONENTS OpenGL)
target_link_libraries(mytarget PRIVATE Qt6::OpenGL)
diff --git a/src/opengl/doc/src/qt6-changes.qdoc b/src/opengl/doc/src/qt6-changes.qdoc
index 1bde84fb62..e227476868 100644
--- a/src/opengl/doc/src/qt6-changes.qdoc
+++ b/src/opengl/doc/src/qt6-changes.qdoc
@@ -5,7 +5,7 @@
\page opengl-changes-qt6.html
\title Changes to Qt OpenGL
\ingroup changes-qt-5-to-6
- \brief Migrate Qt OpenGL to Qt 6.
+ \brief QOpenGL classes migrated, QOpenGLWidget class has been moved to Qt OpenGL Widgets.
Qt 6 is a result of the conscious effort to make the framework more
efficient and easy to use.
diff --git a/src/opengl/doc/src/qtopengl-examples.qdoc b/src/opengl/doc/src/qtopengl-examples.qdoc
index 4843407b0b..3a98c16c70 100644
--- a/src/opengl/doc/src/qtopengl-examples.qdoc
+++ b/src/opengl/doc/src/qtopengl-examples.qdoc
@@ -3,7 +3,7 @@
/*!
\ingroup all-examples
- \title OpenGL Examples from the Qt OpenGL module
+ \title Qt OpenGL Examples
\brief Accessing OpenGL from Qt.
\group examples-widgets-opengl
diff --git a/src/opengl/doc/src/qtopengl-index.qdoc b/src/opengl/doc/src/qtopengl-index.qdoc
index 0b0080edf0..7ea1635827 100644
--- a/src/opengl/doc/src/qtopengl-index.qdoc
+++ b/src/opengl/doc/src/qtopengl-index.qdoc
@@ -61,7 +61,7 @@
\section1 Examples
\list
- \li \l {OpenGL Window Example}
+ \li \l {Qt OpenGL Examples}
\endlist
\section1 Reference