summaryrefslogtreecommitdiffstats
path: root/src/compositor/doc/src/qtwaylandcompositor-qmltypes.qdoc
blob: 1f1f58286f10e2a6d751ba14e825ab9708198880 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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.1
  \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.1
  \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.
*/