summaryrefslogtreecommitdiffstats
path: root/examples/wayland/ivi-compositor
diff options
context:
space:
mode:
authorJohan Klokkhammer Helsing <johan.helsing@qt.io>2017-08-08 14:24:23 +0200
committerJohan Helsing <johan.helsing@qt.io>2017-08-14 08:46:12 +0000
commit38f673748d86bb2e3443d566bbf9b94fc8709cfe (patch)
treeec42cb6d71c1411930cc669567eb01bfbce776d1 /examples/wayland/ivi-compositor
parente1605103ab79d7ef377afc73ac69925a082a87f7 (diff)
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/wayland/ivi-compositor')
-rw-r--r--examples/wayland/ivi-compositor/doc/src/ivi-compositor.qdoc44
1 files changed, 44 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 000000000..ae37c8950
--- /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.
+ */