Doc: Edit example documentation

- 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ö <topi.reinio@theqtcompany.com>

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 3bf5745..66f2773 100644
--- a/examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc
+++ b/examples/webchannel/chatclient-html/doc/src/chatclient-html.qdoc
@@ -33,31 +33,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}
 
 */