diff options
| author | Liang Qi <liang.qi@qt.io> | 2016-06-06 08:34:03 +0200 |
|---|---|---|
| committer | Liang Qi <liang.qi@qt.io> | 2016-06-06 09:04:55 +0200 |
| commit | 57057f76add416d0faf2e09a90c126baafb6198e (patch) | |
| tree | 07d54f8e5daeb3ed1161723542e94c324d745166 /src/platformheaders/doc | |
| parent | dc0ae02ebc8e221f952829230c0301a718a6f10b (diff) | |
| parent | fd70978693bd92761e9989bc1c76bf83c1e8c987 (diff) | |
Merge remote-tracking branch 'origin/5.6' into 5.7
Conflicts:
.qmake.conf
config.tests/unix/nis/nis.cpp
mkspecs/unsupported/freebsd-g++/qplatformdefs.h
src/corelib/tools/qdatetime.cpp
src/corelib/tools/qsimd.cpp
src/corelib/tools/qsimd_p.h
src/network/access/access.pri
src/network/access/qnetworkreplynsurlconnectionimpl.mm
src/network/access/qnetworkreplynsurlconnectionimpl_p.h
src/plugins/platforms/cocoa/qnsview.mm
src/plugins/printsupport/windows/qwindowsprintdevice.cpp
tests/auto/corelib/kernel/qobject/tst_qobject.cpp
tests/auto/network/access/qnetworkreply/BLACKLIST
tests/auto/widgets/widgets/qopenglwidget/BLACKLIST
Change-Id: I4b32055bbf922392ef0264fd403405416fffee57
Diffstat (limited to 'src/platformheaders/doc')
| -rw-r--r-- | src/platformheaders/doc/src/qtplatformheaders.qdoc | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/platformheaders/doc/src/qtplatformheaders.qdoc b/src/platformheaders/doc/src/qtplatformheaders.qdoc index 745edf7983..6eb7b27cce 100644 --- a/src/platformheaders/doc/src/qtplatformheaders.qdoc +++ b/src/platformheaders/doc/src/qtplatformheaders.qdoc @@ -80,6 +80,19 @@ \sa QXcbWindowFunctions QWindowsWindowFunctions + \section1 Getting Started + + To include the definitions of the module's functions and classes, use the following directives: + \code + #include <QtPlatformHeaders/QWindowsWindowFunctions> + #include <QtPlatformHeaders/QXcbWindowFunctions> + \endcode + + As the module is header-only, no further modifications to the .pro files are required to use it. + + \note The module name (\c QtPlatformHeaders) must appear in the \c #include directive. + \note It is not necessary to enclose the code in \c #ifdef directives depending on platform. + \section1 API Reference \list \li \l{Qt Platform Headers C++ Classes}{C++ Classes} |