summaryrefslogtreecommitdiffstats
path: root/src/platformheaders/doc/src
diff options
context:
space:
mode:
authorTor Arne Vestbø <tor.arne.vestbo@qt.io>2020-07-29 15:41:52 +0200
committerTor Arne Vestbø <tor.arne.vestbo@qt.io>2020-08-04 07:12:32 +0200
commita00ad951370742241a8c86bc937fc37b13565127 (patch)
tree80ed29d7b8a4d4e86d12b721e48d83e53c34cf51 /src/platformheaders/doc/src
parent4595fb2c1edce6d2f5e7616111702018d3778001 (diff)
Remove last remaining bits of QtPlatformHeaders
Task-number: QTBUG-84220 Change-Id: I951e04bfe9358a99951d1d61ff47b675584b7f81 Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
Diffstat (limited to 'src/platformheaders/doc/src')
-rw-r--r--src/platformheaders/doc/src/dontdocument.qdoc30
-rw-r--r--src/platformheaders/doc/src/qtplatformheaders.qdoc96
2 files changed, 0 insertions, 126 deletions
diff --git a/src/platformheaders/doc/src/dontdocument.qdoc b/src/platformheaders/doc/src/dontdocument.qdoc
deleted file mode 100644
index dc02c6473e..0000000000
--- a/src/platformheaders/doc/src/dontdocument.qdoc
+++ /dev/null
@@ -1,30 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2019 The Qt Company Ltd.
-** Contact: https://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** Commercial License Usage
-** Licensees holding valid commercial Qt licenses may use this file in
-** accordance with the commercial license agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and The Qt Company. For licensing terms
-** and conditions see https://www.qt.io/terms-conditions. For further
-** information use the contact form at https://www.qt.io/contact-us.
-**
-** GNU Free Documentation License Usage
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \dontdocument (QMetaTypeId)
-*/
diff --git a/src/platformheaders/doc/src/qtplatformheaders.qdoc b/src/platformheaders/doc/src/qtplatformheaders.qdoc
deleted file mode 100644
index 1393121d00..0000000000
--- a/src/platformheaders/doc/src/qtplatformheaders.qdoc
+++ /dev/null
@@ -1,96 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2016 The Qt Company Ltd.
-** Contact: https://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** Commercial License Usage
-** Licensees holding valid commercial Qt licenses may use this file in
-** accordance with the commercial license agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and The Qt Company. For licensing terms
-** and conditions see https://www.qt.io/terms-conditions. For further
-** information use the contact form at https://www.qt.io/contact-us.
-**
-** GNU Free Documentation License Usage
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \module QtPlatformHeaders
- \title Qt Platform Headers C++ Classes
- \ingroup modules
-
- \brief The Qt Platform Headers module offers header-only inline classes that
- encapsulate platform-specific information that is tied to a given runtime
- configuration of a platform plugin.
-*/
-
-/*!
- \page qtplatformheaders-index.html
- \title Qt Platform Headers
-
- \brief The Qt Platform Headers module offers header-only inline classes that
- encapsulate platform-specific information that is tied to a given runtime
- configuration of a platform plugin.
-
- Some applications may need to interface Qt with other frameworks. This often
- means using graphics contexts or other types of native handles created by
- one framework with another. For example, on some platforms, QOpenGLContext
- offers the ability to wrap an existing native OpenGL context, instead of
- creating a new one. This existing native context can be created by some
- other third-party code.
-
- The type of such native handles is highly platform specific and in some
- cases the platform plugin will need more information to adopt a handle, just
- the handle in itself will not be sufficient. Therefore the public API
- consists of functions taking or returning a QVariant that contains a
- platform-specific value type. See for example
- QOpenGLContext::setNativeHandle() and QOpenGLContext::nativeHandle(). When
- running on Linux/X11, using the xcb platform plugin and the GLX windowing
- system interface, the variant contains a QGLXNativeContext. On other
- platforms a different class will be used. These classes are all placed in
- the Qt Platform Headers module.
-
- Platform headers can be used in conjunction with
- QGuiApplication::platformFunction() to give a type safe interface to
- platform specific functionality. It is possible for headers defined in
- QtPlatformHeaders to define typedefs for functions that can be returned by
- a platform plugin from QGuiApplication::platformFunction(). Headers in
- QtPlatformHeaders can also implement wrapper functions for the function
- pointer, giving a static function that can be called from any context after
- the platform integration has been created.
-
- \note Similar to the other QPA APIs, there are no binary compatibility
- guarantees for these classes, meaning that an application using these
- classes is only guaranteed to work with the Qt version it was developed
- against. Unlike QPA however, source compatibility is guaranteed.
-
- \sa QWindowsWindowFunctions
-
- \section1 Getting Started
-
- To include the definitions of the module's functions and classes, use the following directives:
- \code
- #include <QtPlatformHeaders/QWindowsWindowFunctions>
- \endcode
-
- As the module is header-only, no modifications to your build system are required.
-
- \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}
- \endlist
- */