diff options
| author | Kai Koehne <kai.koehne@qt.io> | 2019-04-01 15:49:47 +0200 |
|---|---|---|
| committer | Kai Koehne <kai.koehne@qt.io> | 2019-05-07 07:46:21 +0000 |
| commit | c57520e491f420dc83d44ce5382c403192ce4836 (patch) | |
| tree | 7958ba1eba1b01b7c6de66f87bc4b921eb288759 /src/gui/doc | |
| parent | 43763e279644cdd2a52d770b9aeda4d485caaa76 (diff) | |
Document how to use CMake on Qt Core, Qt GUI's central pages
Add documentation on how to use a module from CMake, alongside
the existing documentation about qmake. Separate generic info
from module-specific examples, to make it possible to use one
include file in all modules.
While at it, also remove the mentioning of the central include;
it is not something we should actively advocate anymore. Instead,
the documentation of every class gives the correct include to use.
Task-number: QTBUG-73058
Change-Id: I6b3c0e5ea218dd9c06a491c8fb799a7fcf42dd92
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'src/gui/doc')
| -rw-r--r-- | src/gui/doc/snippets/code/doc_src_qtgui.pro | 4 | ||||
| -rw-r--r-- | src/gui/doc/snippets/overview/using-qt-gui.cmake | 2 | ||||
| -rw-r--r-- | src/gui/doc/src/qtgui.qdoc | 23 |
3 files changed, 8 insertions, 21 deletions
diff --git a/src/gui/doc/snippets/code/doc_src_qtgui.pro b/src/gui/doc/snippets/code/doc_src_qtgui.pro index e705555336..a5eb5b576c 100644 --- a/src/gui/doc/snippets/code/doc_src_qtgui.pro +++ b/src/gui/doc/snippets/code/doc_src_qtgui.pro @@ -1,7 +1,3 @@ -#! [0] -#include <QtGui> -#! [0] - #! [1] QT -= gui #! [1] diff --git a/src/gui/doc/snippets/overview/using-qt-gui.cmake b/src/gui/doc/snippets/overview/using-qt-gui.cmake new file mode 100644 index 0000000000..aecfa458a0 --- /dev/null +++ b/src/gui/doc/snippets/overview/using-qt-gui.cmake @@ -0,0 +1,2 @@ +find_package(Qt5 COMPONENTS Gui REQUIRED) +target_link_libraries(mytarget Qt5::Gui) diff --git a/src/gui/doc/src/qtgui.qdoc b/src/gui/doc/src/qtgui.qdoc index 53fd55bd39..c4e7d32de1 100644 --- a/src/gui/doc/src/qtgui.qdoc +++ b/src/gui/doc/src/qtgui.qdoc @@ -40,18 +40,6 @@ These classes are used internally by Qt's user interface technologies and can also be used directly, for instance to write applications using low-level OpenGL ES graphics APIs. - - To include the definitions of the module's classes, use the - following directive: - - \snippet code/doc_src_qtgui.pro 0 - - \if !defined(qtforpython) - If you use \l qmake to build your projects, \l{Qt GUI} is included by - default. To disable Qt GUI, add the following line to your \c .pro file: - - \snippet code/doc_src_qtgui.pro 1 - \endif */ /*! @@ -69,14 +57,15 @@ higher level API's, like Qt Quick, that are much more suitable than the enablers found in the Qt GUI module. - \section1 Getting Started + \if !defined(qtforpython) - To include the definitions of the module's classes, use the - following directive: + \include module-use.qdocinc using qt module + \quotefile overview/using-qt-gui.cmake - \snippet code/doc_src_qtgui.pro 0 + See also the \l[QtDoc]{Building with CMake} overview. + + \section2 Building with qmake - \if !defined(qtforpython) If you use \l qmake to build your projects, Qt GUI is included by default. To disable Qt GUI, add the following line to your \c .pro file: |