summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorJuha Vuolle <juha.vuolle@insta.fi>2022-09-21 11:50:04 +0300
committerJuha Vuolle <juha.vuolle@insta.fi>2022-09-23 09:17:12 +0300
commite7fed04f826ad1d1cca8a1c5f2e1fef47ca6337f (patch)
tree611a915da22f2f312f9e3ec703a1f08ba1eaf364 /examples
parentf9e7d3b72bcf3e8c1bb594394d9e7008f71d056c (diff)
Enable QtRemoteObjects example documentation
This commit adds the example listing page and a link to it on the module's landing page. The examples that had the 'qdoc' file are included in the listing. Few examples' documentation is quite limited, but those can be addresed in their own tasks as needed. Fixes: QTBUG-105943 Change-Id: Id69baead6fa5a2a62a3ce7fdf3d7e6be06cc851d Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'examples')
-rw-r--r--examples/remoteobjects/ble/doc/src/ble.qdoc7
-rw-r--r--examples/remoteobjects/modelviewclient/doc/src/modelviewclient.qdoc9
-rw-r--r--examples/remoteobjects/modelviewserver/doc/src/modelviewserver.qdoc10
-rw-r--r--examples/remoteobjects/qmlmodelviewclient/doc/src/qmlmodelviewclient.qdoc8
-rw-r--r--examples/remoteobjects/ssl/doc/src/ssl.qdoc5
-rw-r--r--examples/remoteobjects/websockets/doc/src/websocket.qdoc7
6 files changed, 23 insertions, 23 deletions
diff --git a/examples/remoteobjects/ble/doc/src/ble.qdoc b/examples/remoteobjects/ble/doc/src/ble.qdoc
index 819e9b3..e19c1bd 100644
--- a/examples/remoteobjects/ble/doc/src/ble.qdoc
+++ b/examples/remoteobjects/ble/doc/src/ble.qdoc
@@ -4,10 +4,11 @@
/*!
\example ble
\title QtRemoteObjects Bluetooth LE Example
+ \brief Using QtBluetooth Low Energy (BT LE or BLE for short) as a transport medium with
+ Qt Remote Objects.
+ \ingroup qtremoteobjects-examples
- This example shows how you could use QtBluetooth Low Energy (BT LE or BLE for
- short) as a transport medium with Qt Remote Objects. This is achieved by wrapping the
- bluetooth low energy transport logic in a \l QIODevice.
+ This is achieved by wrapping the bluetooth low energy transport logic in a \l QIODevice.
The example consists of a client and server application which communicate over the bluetooth
low energy radio.
diff --git a/examples/remoteobjects/modelviewclient/doc/src/modelviewclient.qdoc b/examples/remoteobjects/modelviewclient/doc/src/modelviewclient.qdoc
index ae02d3a..8d3521d 100644
--- a/examples/remoteobjects/modelviewclient/doc/src/modelviewclient.qdoc
+++ b/examples/remoteobjects/modelviewclient/doc/src/modelviewclient.qdoc
@@ -4,12 +4,11 @@
/*!
\example modelviewclient
\title Model-View Client
+ \brief Developing a very simple client program which displays the content and changes
+ made on a server.
+ \ingroup qtremoteobjects-examples
- This is the client-side application that accompanies the
- \l {Model-View Server}.
-
- This example showcases how to make a very simple client program which
- displays the content and changes made on a server.
+ This is the client-side application that accompanies the \l {Model-View Server}.
\snippet modelviewclient/main.cpp ObjectNode creation
diff --git a/examples/remoteobjects/modelviewserver/doc/src/modelviewserver.qdoc b/examples/remoteobjects/modelviewserver/doc/src/modelviewserver.qdoc
index a2d6a56..6c39a1f 100644
--- a/examples/remoteobjects/modelviewserver/doc/src/modelviewserver.qdoc
+++ b/examples/remoteobjects/modelviewserver/doc/src/modelviewserver.qdoc
@@ -4,13 +4,11 @@
/*!
\example modelviewserver
\title Model-View Server
+ \brief Developing a simple server program that displays and makes changes to a QTreeView
+ which is made available on a Remote Objects network.
+ \ingroup qtremoteobjects-examples
- This is the server-side application that accompanies the
- \l {Model-View Client}.
-
- This example showcases how to make a simple server program that displays
- and makes changes to a QTreeView which is made available on a Remote
- Objects network.
+ This is the server-side application that accompanies the \l {Model-View Client}.
\snippet modelviewserver/main.cpp RegistryHost setup
diff --git a/examples/remoteobjects/qmlmodelviewclient/doc/src/qmlmodelviewclient.qdoc b/examples/remoteobjects/qmlmodelviewclient/doc/src/qmlmodelviewclient.qdoc
index c21582c..b54ba0b 100644
--- a/examples/remoteobjects/qmlmodelviewclient/doc/src/qmlmodelviewclient.qdoc
+++ b/examples/remoteobjects/qmlmodelviewclient/doc/src/qmlmodelviewclient.qdoc
@@ -4,11 +4,11 @@
/*!
\example qmlmodelviewclient
\title QML Model-View Client
+ \brief Making a QAbstractItemModelReplica available to QML and using it from QML.
+ \ingroup qtremoteobjects-examples
- This is an alternate client application you can use along with the
- \l {Model-View Server}.
+ 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
+ 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
index ba1aef8..90b6725 100644
--- a/examples/remoteobjects/ssl/doc/src/ssl.qdoc
+++ b/examples/remoteobjects/ssl/doc/src/ssl.qdoc
@@ -4,8 +4,9 @@
/*!
\example ssl
\title QtRemoteObjects SSL Example
+ \brief Setting up a secure Remote Object network using QSslSockets.
+ \ingroup qtremoteobjects-examples
- 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
+ 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
index 2fadb89..a1a3c91 100644
--- a/examples/remoteobjects/websockets/doc/src/websocket.qdoc
+++ b/examples/remoteobjects/websockets/doc/src/websocket.qdoc
@@ -4,8 +4,9 @@
/*!
\example websockets
\title QtRemoteObjects WebSockets Example
+ \brief Using a non-QIODevice-based transport (QWebSocket) with QtRemoteObjects.
+ \ingroup qtremoteobjects-examples
+
+ This is achieved by implementing a small QIODevice-derived wrapper for QWebSocket.
- 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.
*/