summaryrefslogtreecommitdiffstats
path: root/src/platformheaders/doc/src/qtplatformheaders.qdoc
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@qt.io>2016-06-13 09:01:02 +0200
committerLiang Qi <liang.qi@qt.io>2016-06-13 12:46:46 +0200
commit511790fd1af1e2886a0e2e8dd4308099705cd815 (patch)
treeb42aee537a6103cd064f9f41ae2889b09b79fd23 /src/platformheaders/doc/src/qtplatformheaders.qdoc
parent1542d8881fc5ccbc5918cd4acbe4091ebbd24508 (diff)
parentcbe332405aa22257d432f1797b325f5e57007c20 (diff)
Merge remote-tracking branch 'origin/5.7' into dev
Conflicts: config_help.txt configure mkspecs/features/uikit/sdk.prf src/corelib/global/qhooks.cpp src/corelib/io/qfilesystemwatcher.cpp src/corelib/io/qlockfile_unix.cpp src/corelib/tools/qalgorithms.h src/gui/kernel/qwindowsysteminterface.h src/gui/text/qtextdocument_p.cpp src/network/access/access.pri src/network/access/qnetworkaccessmanager.cpp src/network/access/qnetworkreplynsurlconnectionimpl.mm src/src.pro src/testlib/qtestcase.cpp src/widgets/kernel/qwidgetbackingstore_p.h src/widgets/styles/qwindowscestyle.cpp src/widgets/styles/qwindowsmobilestyle.cpp tests/auto/corelib/io/qdiriterator/qdiriterator.pro tests/auto/corelib/io/qfileinfo/qfileinfo.pro tests/auto/gui/kernel/qwindow/BLACKLIST tests/auto/widgets/dialogs/qfilesystemmodel/tst_qfilesystemmodel.cpp tools/configure/configureapp.cpp Change-Id: Ibf7fb9c8cf263a810ade82f821345d0725c57c67
Diffstat (limited to 'src/platformheaders/doc/src/qtplatformheaders.qdoc')
-rw-r--r--src/platformheaders/doc/src/qtplatformheaders.qdoc13
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}