summaryrefslogtreecommitdiffstats
path: root/src/opengl/doc/src
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@qt.io>2020-11-11 17:23:18 +0100
committerJerome Pasion <jerome.pasion@qt.io>2020-11-17 20:16:12 +0100
commitd4b3989818e85b1e1f3183bef2711e125fbe76ca (patch)
treefe4d940d588be1a33ec06a60ce163f4d5a873cf4 /src/opengl/doc/src
parent4f6c5d83d09881a8432873487eab44b88eabec9e (diff)
Update landing pages and module pages in qtbase
-Qt SQL, Qt D-BUS, Qt GUI, Qt OpenGL, Qt Widgets, Qt Test, Qt Concurrent, Qt XML, Qt Network, Qt Core -language edits for consistency, add links Task-number: QTBUG-87155 Change-Id: Ic61350c9fa15090c802a42d8e9116219591eba73 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/opengl/doc/src')
-rw-r--r--src/opengl/doc/src/qtopengl-index.qdoc23
-rw-r--r--src/opengl/doc/src/qtopengl-module.qdoc9
2 files changed, 21 insertions, 11 deletions
diff --git a/src/opengl/doc/src/qtopengl-index.qdoc b/src/opengl/doc/src/qtopengl-index.qdoc
index f6d7ef81a6..01bccd26d4 100644
--- a/src/opengl/doc/src/qtopengl-index.qdoc
+++ b/src/opengl/doc/src/qtopengl-index.qdoc
@@ -31,10 +31,6 @@
\brief The Qt OpenGL module offers classes that make it easy to
use OpenGL in Qt applications.
- OpenGL is a low-level, cross-platform API for graphics. In Qt,
- it can optionally be used as the foundation for rendering.
-
- \section1 Introduction
Qt has two main approaches to UI development: \l[QtQuick]{Qt Quick} and
\l{Qt Widgets}. They exist to support different types of user
@@ -76,9 +72,6 @@
\section1 Overview
- The \l{Qt OpenGL C++ Classes} page gives an overview over the available classes
- in this module.
-
\include module-use.qdocinc using qt module
\snippet snippets/CMakeLists.txt cmake_use
@@ -93,12 +86,24 @@
\section1 Licenses and Trademarks
- The Qt OpenGL module is available under commercial licenses from \l{The Qt Company}.
- In addition, it is available under free software licenses:
+ The Qt OpenGL module is available under commercial licenses from
+ \l{The Qt Company}. In addition, it is available under free software
+ licenses:
The \l{GNU Lesser General Public License, version 3}, or
the \l{GNU General Public License, version 2}.
See \l{Qt Licensing} for further details.
OpenGL\reg is a trademark of Silicon Graphics, Inc. in
the United States and other countries.
+
+
+ \section1 Related Information
+
+ These are links to the API reference materials and related pages.
+
+ \list
+ \li l{Qt OpenGL C++ Classes}{C++ Classes}
+ \li \l{OpenGL Window Example}
+ \endlist
+
*/
diff --git a/src/opengl/doc/src/qtopengl-module.qdoc b/src/opengl/doc/src/qtopengl-module.qdoc
index 0d1c9e687f..7bf0c18f93 100644
--- a/src/opengl/doc/src/qtopengl-module.qdoc
+++ b/src/opengl/doc/src/qtopengl-module.qdoc
@@ -35,8 +35,10 @@
\brief The Qt OpenGL module offers classes that make it easy to
use OpenGL in Qt applications.
- The \l{Qt OpenGL Widgets C++ Classes}{Qt OpenGL Widgets} library provides
- a C++ widget class for rendering OpenGL graphics into widgets UIs.
+ The \l{Qt OpenGL} page contains information about how to use the module.
+
+ A separate \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
*/
@@ -50,4 +52,7 @@
\title Qt OpenGL Widgets C++ Classes
\qtcmakepackage OpenGLWidgets
\qtvariable openglwidgets
+
+ The \l{Qt OpenGL Widgets} page contains information about how to use the
+ module.
*/