diff options
author | Johan Klokkhammer Helsing <johan.helsing@qt.io> | 2017-08-08 14:24:23 +0200 |
---|---|---|
committer | Johan Helsing <johan.helsing@qt.io> | 2017-08-14 08:46:12 +0000 |
commit | 38f673748d86bb2e3443d566bbf9b94fc8709cfe (patch) | |
tree | ec42cb6d71c1411930cc669567eb01bfbce776d1 /examples | |
parent | e1605103ab79d7ef377afc73ac69925a082a87f7 (diff) | |
download | qtwayland-38f673748d86bb2e3443d566bbf9b94fc8709cfe.tar.gz |
Add missing documentation for examples
Add documentation for the following examples: minimal-qml, ivi-compositor,
multi-screen and spanning-screens.
Change-Id: Iacb14af9b1c825f08e2092836cb4821db005628d
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'examples')
4 files changed, 161 insertions, 0 deletions
diff --git a/examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc b/examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc new file mode 100644 index 00000000..ae37c895 --- /dev/null +++ b/examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc @@ -0,0 +1,44 @@ +/**************************************************************************** +** +** Copyright (C) 2017 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$ +** +****************************************************************************/ + +/*! + * \title Qt Wayland Compositor Examples - IVI Compositor + * \example ivi-compositor + * \brief IVI Compositor is an example that demonstrates how to use the IviApplication extension. + * \ingroup qtwaylandcompositor-examples + * + * IVI Compositor is a Wayland compositor example demonstrating how to create a + * compositor supporting the \c ivi-application protocol. + * + * IVI application windows with the id 1337 will be resized to cover one half + * of the screen, while all other windows will be resized to cover the other + * half. + * + * To start a Qt application using the \c ivi-application protocol with the + * right id, you need to set QT_WAYLAND_SHELL_INTEGRATION to ivi-shell and + * QT_IVI_SURFACE_ID to 1337. + */ diff --git a/examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc b/examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc new file mode 100644 index 00000000..24a5f652 --- /dev/null +++ b/examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc @@ -0,0 +1,36 @@ +/**************************************************************************** +** +** Copyright (C) 2017 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$ +** +****************************************************************************/ + +/*! + * \title Qt Wayland Compositor Examples - Minimal QML + * \example minimal-qml + * \brief Minimal QML is a simple example that demonstrates how to write a Wayland compositor in QML. + * \ingroup qtwaylandcompositor-examples + * + * Minimal QML is a desktop-style Wayland compositor example implementing a + * complete Qt Wayland Compositor with as little code as possible. + */ diff --git a/examples/wayland/multi-screen/doc/src/multi-screen.qdoc b/examples/wayland/multi-screen/doc/src/multi-screen.qdoc new file mode 100644 index 00000000..20d3912c --- /dev/null +++ b/examples/wayland/multi-screen/doc/src/multi-screen.qdoc @@ -0,0 +1,45 @@ +/**************************************************************************** +** +** Copyright (C) 2017 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$ +** +****************************************************************************/ + +/*! + * \title Qt Wayland Compositor Examples - Multi Screen + * \example multi-screen + * \brief Multi Screen is a desktop-style Wayland compositor for multiple screens. + * \ingroup qtwaylandcompositor-examples + * + * Multi-screen is a desktop-style Wayland compositor example for multiple + * screens. + * + * When a client creates a shell surface, one ShellSurfaceItem is created on + * each screen. The ShellSurfaceItem will be visible only on one (or two) + * screens at a time. ShellSurfaceItem positions are synchronized so that when + * windows enter one screen they are moved off another at the same time. + * + * WaylandQuickItem::setPrimary() is called at appropriate times to set the + * primary view for the ShellSurface, which is used when the client asks to be + * maximized or fullscreen. + */ diff --git a/examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc b/examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc new file mode 100644 index 00000000..cbb720fa --- /dev/null +++ b/examples/wayland/spanning-screens/doc/src/spanning-screens.qdoc @@ -0,0 +1,36 @@ +/**************************************************************************** +** +** Copyright (C) 2017 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$ +** +****************************************************************************/ + +/*! + * \title Qt Wayland Compositor Examples - Spanning Screens + * \example spanning-screens + * \brief Spanning Screens is an example that demonstrates how to let Wayland clients span multiple screens. + * \ingroup qtwaylandcompositor-examples + * + * Spanning screens is a Wayland compositor example that maximizes clients + * across a top and a bottom screen. + */ |