summaryrefslogtreecommitdiff
path: root/examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@qt.io>2016-06-16 07:10:09 +0200
committerLiang Qi <liang.qi@qt.io>2016-06-16 07:10:09 +0200
commitb84f22a3249aa1af46b17e33ac030abb077251bf (patch)
tree315d6c8151598a3a3bbad6d4a4161d08bb51a689 /examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc
parent4fda82b66e17cc03e6b08f1afd135069cfef09b7 (diff)
parent23cd16ad672a3d07da00d14276a63901d8d9f118 (diff)
downloadqtwebchannel-b84f22a3249aa1af46b17e33ac030abb077251bf.tar.gz
Merge remote-tracking branch 'origin/5.7.0' into 5.7
Change-Id: If663d043ad0da98731e436309d3b40e3379b0831
Diffstat (limited to 'examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc')
-rw-r--r--examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc31
1 files changed, 18 insertions, 13 deletions
diff --git a/examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc b/examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc
index 497c63f..0a3efb6 100644
--- a/examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc
+++ b/examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc
@@ -50,31 +50,36 @@
/*!
\example chatclient-html
- \title Qt WebChannel Chatclient HTML Example
+ \title Qt WebChannel ChatClient HTML Example
\ingroup qtwebchannel-examples
\brief A HTML/JavaScript client that communicates over a WebSocket with a QWebChannel server.
- The chatclient-html example provides a simple QWebChannel client implemented using JavaScript and HTML.
+ \image chatclient-html.png
- \section1 Overview
+ \e{ChatClient HTML} provides a simple QWebChannel client implemented using JavaScript and HTML.
+
+ \section1 Running the Example
+
+ To run the example, open the \c chatclient.html file in a browser.
+
+ \section1 Implementing a Web Channel Client
The client initializes a WebSocket connection to the chat server and receives an object
- containing all neccessarry signals, slots and properties for implementing a chat client.
+ containing all the necessary signals, slots, and properties for implementing a chat client.
- After login the client can invoke the method \c sendMessage and receive the signal \c newMessage
- to send and receive messages. Furthermore there is a \c userList property which provides the
- names of all other connected clients. It is automatically updated when its contents change.
- Also, the client responds to the servers keep alive signal which is needed to detect disconnected
- clients and remove them from the \c userlist property.
+ After login, the client can invoke the method \c sendMessage and receive the signal \c newMessage
+ to send and receive messages. Furthermore, a \c userList property provides the names of
+ all other connected clients. The list is automatically updated when its contents change.
+ Also, the client responds to the server's keep alive signal which is needed to detect disconnected
+ clients and remove them from the \c userList property.
The example shows how basic elements can be used with the client JavaScript implementation of
- QWebChannel, like connecting to signals (\c newMessage), calling slots (\c sendMessage) and handle
+ QWebChannel, like connecting to signals (\c newMessage), calling slots (\c sendMessage), and handling
property changes (\c userList).
- The client is able to work with the chatserver-cpp example.
+ The client is able to work with \l{Qt WebChannel ChatServer Example}.
- To run the example, open the \c chatclient.html in a browser.
- \sa {chatserver-cpp}, {chatclient-qml}
+ \sa {Qt WebChannel ChatServer Example}, {Qt WebChannel ChatClient QML Example}
*/