diff options
Diffstat (limited to 'examples/websockets/doc/echoserver.qdoc')
| -rw-r--r-- | examples/websockets/doc/echoserver.qdoc | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/examples/websockets/doc/echoserver.qdoc b/examples/websockets/doc/echoserver.qdoc index f314ac0..0728372 100644 --- a/examples/websockets/doc/echoserver.qdoc +++ b/examples/websockets/doc/echoserver.qdoc @@ -3,20 +3,23 @@ /*! \example echoserver - \title Echo Server Example + \title WebSocket Echo Server + \meta category {Networking} \ingroup qtwebsockets-examples - \brief Shows how to create a simple server application that - sends back the messages it receives. + \brief Show how to write a simple WebSocket server application. - The Echo Server Example shows how to create a simple server application that - sends back the messages it receives, using the \l {Qt WebSockets}{WebSocket} API. + This Echo Server shows how to create a simple server application that sends + back a reply in response to a message it receives, using the + \l {Qt WebSockets}{WebSocket} API. For the sake of illustration, the reply + is simply a copy of the message. If your web browser supports \l {Qt WebSockets}{WebSocket}, you can also use it to open the \c {echoserver/echoclient.html}{echoclient.html} file, and operate - like the following screenshot. + as shown in the following screenshot: - \image echoclient-html-example.png Screenshot of the HTML version of Echo - Client example + \image echoclient-html-example.png WebSocket Echo HTML Client - \sa {Echo Client Example} + Otherwise use the \l {WebSocket Echo Client} to connect to the server. + + \sa {WebSocket Echo Client} */ |