From ffd99e1d1803a8b82eab8d8b6c1cd9e58af36ee5 Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Mon, 23 May 2016 14:27:05 +0200 Subject: Add section "Getting Started" to QPlatformHeader's documentation. Change-Id: Id57c65a5f5281ed0ff8f4e5876cf121781f2ae90 Reviewed-by: Andy Shaw --- src/platformheaders/doc/src/qtplatformheaders.qdoc | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'src/platformheaders') 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 + #include + \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} -- cgit v1.2.3