diff options
Diffstat (limited to 'src/platformheaders/doc')
-rw-r--r-- | src/platformheaders/doc/qtplatformheaders.qdocconf | 51 | ||||
-rw-r--r-- | src/platformheaders/doc/src/qtplatformheaders.qdoc | 68 |
2 files changed, 119 insertions, 0 deletions
diff --git a/src/platformheaders/doc/qtplatformheaders.qdocconf b/src/platformheaders/doc/qtplatformheaders.qdocconf new file mode 100644 index 0000000000..dfef69f892 --- /dev/null +++ b/src/platformheaders/doc/qtplatformheaders.qdocconf @@ -0,0 +1,51 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +# Name of the project which must match the outputdir. Determines the .index file +project = QtPlatformHeaders + +# Directories in which to search for files to document and images. +# By default set to the root directory of the project for sources +# and headers and qdoc will therefore generate output for each file. +# Images should be placed in <rootdir>/dic/images and examples in +# <rootdir>/examples. +# Paths are relative to the location of this file. + +headerdirs += .. +sourcedirs += .. +exampledirs += .. +imagedirs += images + +depends += qtdoc qtcore qtgui qtwidgets + +examplesinstallpath = platformheaders + +# The following parameters are for creating a qhp file, the qhelpgenerator +# program can convert the qhp file into a qch file which can be opened in +# Qt Assistant and/or Qt Creator. + +# Defines the name of the project. You cannot use operators (+, =, -) in +# the name. Properties for this project are set using a qhp.<projectname>.property +# format. +qhp.projects = QtPlatformHeaders + +# Sets the name of the output qhp file. +qhp.QtPlatformHeaders.file = qtplatformheaders.qhp + +# Namespace for the output file. This namespace is used to distinguish between +# different documentation files in Creator/Assistant. +qhp.QtPlatformHeaders.namespace = org.qt-project.qtplatformheaders.$QT_VERSION_TAG + +# Title for the package, will be the main title for the package in +# Assistant/Creator. +qhp.QtPlatformHeaders.indexTitle = Qt Platform Headers + +# Only update the name of the project for the next variables. +qhp.QtPlatformHeaders.virtualFolder = qtplatformheaders +qhp.QtPlatformHeaders.subprojects = classes +qhp.QtPlatformHeaders.subprojects.classes.title = C++ Classes +qhp.QtPlatformHeaders.subprojects.classes.indexTitle = Qt Platform Headers C++ Classes +qhp.QtPlatformHeaders.subprojects.classes.selectors = class fake:headerfile +qhp.QtPlatformHeaders.subprojects.classes.sortPages = true + +navigation.landingpage = "Qt Platform Headers" +navigation.cppclassespage = "Qt Platform Headers C++ Classes" diff --git a/src/platformheaders/doc/src/qtplatformheaders.qdoc b/src/platformheaders/doc/src/qtplatformheaders.qdoc new file mode 100644 index 0000000000..4ed740d296 --- /dev/null +++ b/src/platformheaders/doc/src/qtplatformheaders.qdoc @@ -0,0 +1,68 @@ +/**************************************************************************** +** +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** 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 Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.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. + + \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. + */ |