summaryrefslogtreecommitdiff
path: root/examples/websockets/doc/qmlwebsocketserver.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/websockets/doc/qmlwebsocketserver.qdoc')
-rw-r--r--examples/websockets/doc/qmlwebsocketserver.qdoc13
1 files changed, 12 insertions, 1 deletions
diff --git a/examples/websockets/doc/qmlwebsocketserver.qdoc b/examples/websockets/doc/qmlwebsocketserver.qdoc
index 83d9831..8582384 100644
--- a/examples/websockets/doc/qmlwebsocketserver.qdoc
+++ b/examples/websockets/doc/qmlwebsocketserver.qdoc
@@ -3,7 +3,18 @@
/*!
\example qmlwebsocketserver
- \title QML WebSocket Server Example
+ \title QML WebSocket Server
+ \meta category {Networking}
\ingroup qtwebsockets-examples
\brief A simple example that shows how to use a QML WebSocketServer.
+
+ \image qmlwebsocketserver-example.webp QML WebSocket Server GUI
+
+ This example opens a window and has a WebSocketServer listening
+ for incoming connections and a WebSocket connecting to the
+ WebSocketServer. Every time the window is clicked, the WebSocket
+ sends a message to the WebSocketServer. The WebSocketServer has a
+ signal handler that logs the incoming message to the window and
+ sends a message back again, and the WebSocket has a signal
+ handler that logs the returned message to the window.
*/