summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--examples/websockets/doc/echoserver.qdoc9
-rw-r--r--examples/websockets/doc/images/echoclient-html-example.pngbin0 -> 47215 bytes
-rw-r--r--src/websockets/doc/qtwebsockets.qdocconf4
3 files changed, 12 insertions, 1 deletions
diff --git a/examples/websockets/doc/echoserver.qdoc b/examples/websockets/doc/echoserver.qdoc
index e6d4f2c..ae6218a 100644
--- a/examples/websockets/doc/echoserver.qdoc
+++ b/examples/websockets/doc/echoserver.qdoc
@@ -39,7 +39,14 @@
sends back the messages it receives.
The Echo Server Example shows how to create a simple server application that
- sends back the messages it receives, using the WebSocket API.
+ sends back the messages it receives, using the \l {Qt WebSockets}{WebSocket} API.
+
+ If your web browser supports \l {Qt WebSockets}{WebSocket}, you can also use it
+ to open the \l {echoserver/echoclient.html}{echoclient.html} file, and operate
+ like the following screenshot.
+
+ \image echoclient-html-example.png Screenshot of the HTML version of Echo
+ Client example
\sa {Echo Client Example}
*/
diff --git a/examples/websockets/doc/images/echoclient-html-example.png b/examples/websockets/doc/images/echoclient-html-example.png
new file mode 100644
index 0000000..2cda8fd
--- /dev/null
+++ b/examples/websockets/doc/images/echoclient-html-example.png
Binary files differ
diff --git a/src/websockets/doc/qtwebsockets.qdocconf b/src/websockets/doc/qtwebsockets.qdocconf
index 3f87cef..ed95343 100644
--- a/src/websockets/doc/qtwebsockets.qdocconf
+++ b/src/websockets/doc/qtwebsockets.qdocconf
@@ -50,6 +50,10 @@ sourcedirs += .. \
exampledirs += ../../../examples/websockets \
snippets
+examples.fileextensions += "*.html"
+
+imagedirs += ../../../examples/websockets/doc/images
+
manifestmeta.thumbnail.names += "QtWebSockets/*"
navigation.landingpage = "Qt WebSockets"