diff options
Diffstat (limited to 'src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc')
-rw-r--r-- | src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc b/src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc new file mode 100644 index 000000000..ae8398735 --- /dev/null +++ b/src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc @@ -0,0 +1,52 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://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 http://www.qt.io/terms-conditions. For further +** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \qmlmodule QtWayland.Compositor 1.0 + \title Qt Wayland Compositor QML Types + \ingroup qmlmodules + \brief Provides QML types for writing custom Wayland display servers. + + The Qt Wayland module provides QML types that can be used to create custom + display servers supporting the Wayland protocol. + + The QML types can be imported into your application using the following + import statement: + + \code + import QtWayland.Compositor 1.0 + \endcode + + To link against the module, add this line to your \l qmake \c .pro file: + + \code + QT += waylandcompositor + \endcode + + For more information about using these types in your application, + see the \l{Qt Wayland Compositor} documentation. +*/ |