summaryrefslogtreecommitdiffstats
path: root/src/gui/doc/src
diff options
context:
space:
mode:
authorSamuel Rødal <samuel.rodal@digia.com>2012-10-01 10:58:47 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-10-01 15:59:10 +0200
commit39a06115b638487b1e3a5ab0911ca82de525b275 (patch)
treeb4bd5b302adebaeb51c0e64a4d6157f7982f8c38 /src/gui/doc/src
parent65d4dea41abe04ecd60aa71dd4cdb3fb7b866f9a (diff)
Fixed Qt GUI landing page.
Change-Id: I9af2ed12e27c00060a6bcc6262064ee95295a8a8 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/gui/doc/src')
-rw-r--r--src/gui/doc/src/qtgui.qdoc37
1 files changed, 26 insertions, 11 deletions
diff --git a/src/gui/doc/src/qtgui.qdoc b/src/gui/doc/src/qtgui.qdoc
index 74d4847847..c08ee657bb 100644
--- a/src/gui/doc/src/qtgui.qdoc
+++ b/src/gui/doc/src/qtgui.qdoc
@@ -27,7 +27,7 @@
/*!
\module QtGui
- \title The Qt GUI Module
+ \title Qt GUI C++ API
\ingroup modules
\brief The Qt GUI module provides the basic enablers for graphical
@@ -45,13 +45,13 @@
\snippet code/doc_src_qtgui.pro 0
- See the \l {Qt GUI Module Overview} for more details.
+ See the \l {Qt GUI} page for more details.
*/
/*!
- \page qtgui-overview.html
- \title Qt GUI Module Overview
+ \page qtgui-index.html
+ \title Qt GUI
The Qt GUI module provides classes for windowing system
integration, event handling, OpenGL and OpenGL ES integration, 2D
@@ -63,7 +63,13 @@
For application developers writing user interfaces, Qt provides
higher level API's, like Qt Quick, that are much more suitable
than the enablers found in the Qt GUI module.
- than the enablers found in the Qt GUI module.
+
+ \section1 Getting started
+
+ To include the definitions of the module's classes, use the
+ following directive:
+
+ \snippet code/doc_src_qtgui.pro 0
@@ -152,14 +158,23 @@
QtGui now contains only a small set of enablers, which are generally
useful for all graphical applications.
- */
-/*
+ \section1 Reference
+ \list
+ \li \l{Qt GUI C++ API}
+ \list
+ \li \l{Event Classes}
+ \li \l{Painting Classes}
+ \li \l{Rendering in 3D}
+ \endlist
+ \endlist
+ */
- ### DOC-TODO: link under OpenGL to hello-opengl for QWindow in
- examples/gui/opengl/openglwindow. Idea: QWindow which draws a
- triangle using GLES 2.0 compatible shaders. Do not care about
- 1.1 API as almost everyone has 2.0 support these days.
+/*!
+ \group events
+ \title Event Classes
+ \ingroup groups
+ \brief Classes that provide UI and input events.
*/