summaryrefslogtreecommitdiffstats
path: root/examples/remoteobjects/websockets/doc
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/remoteobjects/websockets/doc
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/remoteobjects/websockets/doc')
-rw-r--r--examples/remoteobjects/websockets/doc/src/websocket.qdoc7
1 files changed, 4 insertions, 3 deletions
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.
*/