diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2016-05-23 14:27:05 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2016-05-23 14:05:15 +0000 |
| commit | ffd99e1d1803a8b82eab8d8b6c1cd9e58af36ee5 (patch) | |
| tree | 6b06a9f8f644807d0f0f388f1c42a53e288e7967 /src/platformheaders/doc/src/qtplatformheaders.qdoc | |
| parent | 644d0e75240811212ed9fd0c21e3bd05db3ba5db (diff) | |
Add section "Getting Started" to QPlatformHeader's documentation.
Change-Id: Id57c65a5f5281ed0ff8f4e5876cf121781f2ae90
Reviewed-by: Andy Shaw <andy.shaw@qt.io>
Diffstat (limited to 'src/platformheaders/doc/src/qtplatformheaders.qdoc')
| -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 89c2394bdc..d2caa5b212 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} |