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>
(cherry picked from commit 01ea92c7c8d77d3d3c10ab1cc4bf4f214aa07126)

1 files changed, 20 insertions, 12 deletions

diff --git a/examples/webchannel/chatserver-cpp/doc/src/chatserver-cpp.qdoc b/examples/webchannel/chatserver-cpp/doc/src/chatserver-cpp.qdoc
index 06d5b2e..0b198d2 100644
--- a/examples/webchannel/chatserver-cpp/doc/src/chatserver-cpp.qdoc
+++ b/examples/webchannel/chatserver-cpp/doc/src/chatserver-cpp.qdoc
@@ -50,31 +50,39 @@
 
 /*!
     \example chatserver-cpp
-    \title Qt WebChannel Chatserver Example
+    \title Qt WebChannel ChatServer Example
     \ingroup qtwebchannel-examples
-    \brief Shows how to use the QWebChannel C++ API to implement a simple chat server
+    \brief A simple chat server implemented using the QWebChannel C++ API.
 
-    The chatserver examples provides a chat service that client examples can connect to.
+    \image chatserver-cpp.png
 
-    \section1 Overview
+    \e{ChatServer} provides a chat service that the
+    \l{Qt WebChannel ChatClient QML Example} and
+    \l{Qt WebChannel ChatClient HTML Example} can connect to.
+
+    \include examples-run.qdocinc
+
+    \section1 Implementing a Chat Server
 
     The C++ application implements a QObject which provides all mechanisms required for
     a chat service.
-    This object is published through a QWebChannel which uses a WebSocket as transport.
+    This object is published through a QWebChannel which uses a \l{Qt WebSockets}
+    {WebSocket} as transport.
 
     The server provides a basic \c login method (username only, no passwords), which must be
     successfully invoked before a client is able to chat.
-    After login a client can invoke the method \c sendMessage and receive the signal \c newMessage
-    to write and receive messages. Furthermore there is a \c userList property which provides
+    After login, a client can invoke the method \c sendMessage and receive the signal \c newMessage
+    to write and receive messages. Furthermore, there is a \c userList property which provides
     the names of all other connected clients.
-    Additionally the server sends a keepAlive signal periodically to all clients. The clients
+    Additionally the server sends a \c keepAlive signal periodically to all clients. The clients
     have to respond to this signal, otherwise the client will be removed from the \c userList property.
 
-    The example shows how basic QObject elements can be used with QWebChannel, i.e. signals
-    (\c newMessage), slots (\c sendMessage) and properties (\c userList).
+    The example shows how basic QObject elements can be used with QWebChannel, that is signals
+    (\c newMessage), slots (\c sendMessage), and properties (\c userList).
 
-    Because this is a plain server application, there are separated clients needed to interact
-    with the server. Both examples chatclient-qml and chatclient-html show a client implementation
+    Because this is a plain server application, separate clients are needed to
+    interact with it. \l{Qt WebChannel ChatClient QML Example} and
+    \l{Qt WebChannel ChatClient HTML Example} are client implementations
     compatible with this server.
 
 */