summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorØystein Heskestad <oystein.heskestad@qt.io>2023-09-25 18:34:02 +0200
committerØystein Heskestad <oystein.heskestad@qt.io>2023-10-11 16:03:05 +0200
commitc2ba4a68bb50d274ec984e4473709e05722e72bd (patch)
tree38af716f391b8a80103d3edae5a0502d5eb6c247
parent13905766a105e8c05fa5ae83b89732b31919e3bf (diff)
Document simpleswitch examples
Task-number: QTBUG-112850 Pick-to: 6.6 6.5 Change-Id: I43cc08101153f10c30cd8ffa38649fd8e84ddbd2 Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
-rw-r--r--examples/remoteobjects/simpleswitch/doc/src/simpleswitch.qdoc34
-rw-r--r--src/remoteobjects/doc/images/simpleswitch-example.webpbin0 -> 14410 bytes
2 files changed, 34 insertions, 0 deletions
diff --git a/examples/remoteobjects/simpleswitch/doc/src/simpleswitch.qdoc b/examples/remoteobjects/simpleswitch/doc/src/simpleswitch.qdoc
new file mode 100644
index 0000000..c3bdf6c
--- /dev/null
+++ b/examples/remoteobjects/simpleswitch/doc/src/simpleswitch.qdoc
@@ -0,0 +1,34 @@
+// Copyright (C) 2023 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \example simpleswitch
+ \title Simpleswitch Direct Server and Client
+ \examplecategory {Connectivity}
+ \ingroup qtremoteobjects-examples
+ \meta tag {remoteobjects}
+ \brief A minimalist Remote Object server and client.
+
+ \image simpleswitch-example.webp
+
+ The directconnectserver and directconnectclient applications are simple
+ examples that can be used as starting points for more complex
+ applications.
+
+ The directconnectserver application shares a rep-file defined
+ SimpleSwitch object, while the directconnectclient application gets a
+ replica of it. The server has a two second timer, and every time it times
+ out, the boolean state of the boolean currState property of the
+ SimpleSwitch object is toggled and the current state is printed out to
+ the terminal. Each client connects to the state change of the
+ SimpleSwitch replica, and emits the current state back to the server. For
+ every connected client, the server prints out the state of the client
+ back to the terminal.
+
+ The implementation of these two applications are documented at
+ \l {qtro-example1}{Example 1}.
+
+ Other simple examples are located at tests/manual/examples/simpleswitch.
+ These three applications are documented at \l {qtro-example2}{Example 2}
+ and \l {qtro-example3}{Example 3}.
+*/
diff --git a/src/remoteobjects/doc/images/simpleswitch-example.webp b/src/remoteobjects/doc/images/simpleswitch-example.webp
new file mode 100644
index 0000000..0ce57c5
--- /dev/null
+++ b/src/remoteobjects/doc/images/simpleswitch-example.webp
Binary files differ