summaryrefslogtreecommitdiffstats
path: root/examples/wayland/minimal-qml/doc/src
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/minimal-qml/doc/src
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/minimal-qml/doc/src')
-rw-r--r--examples/wayland/minimal-qml/doc/src/minimal-qml.qdoc36
1 files changed, 36 insertions, 0 deletions
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 000000000..24a5f6522
--- /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.
+ */