From 18d8ca185819d6d81a9f21858ff2d60bf6fd05f8 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 31 May 2016 15:34:32 +0200 Subject: Doc: Edit example documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add images to the examples. - Add instructions for running the examples - Edit for grammar and style - Add dependencies to Qt WebEngine and Qt WebSockets modules - Add a workaround for preventing autolinking of WebChannel, WebEngine and WebSockets to the wrong targets - Use explicit linking where necessary Change-Id: Ia4025284063fa09c9e2a0b2c347ee682bba8a615 Reviewed-by: Topi Reiniö (cherry picked from commit 01ea92c7c8d77d3d3c10ab1cc4bf4f214aa07126) --- .../chatclient-html/doc/src/chatclient-html.qdoc | 31 +++++++++++++--------- 1 file changed, 18 insertions(+), 13 deletions(-) (limited to 'examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc') 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} */ -- cgit v1.2.1