summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorMårten Nordheim <marten.nordheim@qt.io>2021-03-23 16:40:37 +0100
committerMårten Nordheim <marten.nordheim@qt.io>2021-03-24 09:51:34 +0100
commitd29f3f1094b04d61b22ca8abfa3ac4f56bc90a54 (patch)
tree7908331617b9bd6d7ca4c47e76a1fc1cabbe7db7 /examples
parent93a8755dec5db8fdc30e60815891a2c5feeea023 (diff)
Add some introductory documentation to a few more examples
This way they will show up in the examples section for Remote Objects. Didn't document them as much as the previous example as they're not doing the Remote Objects parts very differently, but they are covering niches which are very important. Change-Id: I9bbd26a3fb8b2cf8a409464d9807daafc2558ac2 Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'examples')
-rw-r--r--examples/remoteobjects/qmlmodelviewclient/doc/src/qmlmodelviewclient.qdoc38
-rw-r--r--examples/remoteobjects/ssl/doc/src/ssl.qdoc35
-rw-r--r--examples/remoteobjects/websockets/doc/src/websocket.qdoc35
3 files changed, 108 insertions, 0 deletions
diff --git a/examples/remoteobjects/qmlmodelviewclient/doc/src/qmlmodelviewclient.qdoc b/examples/remoteobjects/qmlmodelviewclient/doc/src/qmlmodelviewclient.qdoc
new file mode 100644
index 0000000..00c1874
--- /dev/null
+++ b/examples/remoteobjects/qmlmodelviewclient/doc/src/qmlmodelviewclient.qdoc
@@ -0,0 +1,38 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 The Qt Company Ltd.
+** Contact: https://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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \example qmlmodelviewclient
+ \title QML Model-View Client
+
+ This is an alternate client application you can use along with the
+ \l {Model-View Server}.
+
+ This short example showcases how to quickly make a QAbstractItemModelReplica
+ available to and use from QML. See the \l {Model-View Client} example for a
+ more detailed explanation on how the model is acquired and used.
+*/
diff --git a/examples/remoteobjects/ssl/doc/src/ssl.qdoc b/examples/remoteobjects/ssl/doc/src/ssl.qdoc
new file mode 100644
index 0000000..d77f35e
--- /dev/null
+++ b/examples/remoteobjects/ssl/doc/src/ssl.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 The Qt Company Ltd.
+** Contact: https://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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \example ssl
+ \title QtRemoteObjects SSL Example
+
+ This example shows how you can set up a secure Remote Object network using
+ QSslSockets! Encrypting communication is critical when you need to pass data
+ through a network you don't have full control over.
+*/
diff --git a/examples/remoteobjects/websockets/doc/src/websocket.qdoc b/examples/remoteobjects/websockets/doc/src/websocket.qdoc
new file mode 100644
index 0000000..3db2e3c
--- /dev/null
+++ b/examples/remoteobjects/websockets/doc/src/websocket.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 The Qt Company Ltd.
+** Contact: https://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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \example websockets
+ \title QtRemoteObjects WebSockets Example
+
+ This example shows how you could use a non-QIODevice-based transport
+ (QWebSocket) with QtRemoteObjects. This is achieved by implementing a
+ small QIODevice-derived wrapper for QWebSocket.
+*/