Doc: Review documentation Qt WebSockets

Task-number: QTBUG-37149

Change-Id: Ia8fe7b11140d31bc231a17bfcc16887f3af0dbce
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>

diff --git a/examples/doc/echoclient.qdoc b/examples/doc/echoclient.qdoc
index a1f1646..a6cb1a9 100644 (file)
--- a/examples/doc/echoclient.qdoc
+++ b/examples/doc/echoclient.qdoc
@@ -43,7 +43,10 @@
     \example echoclient
     \title Echo Client Example
     \ingroup qtwebsockets-examples
-    \brief Explains how to use the websocket API to create a simple echo client.
+    \brief Describes how to use the websocket API for creating a simple echo client.
+
+    The Echo Client Example shows how to use the websocket API to create a simple
+    echo client.
 
     \sa {Echo Server Example}
 */

diff --git a/examples/doc/echoserver.qdoc b/examples/doc/echoserver.qdoc
index b7b8299..fcb0442 100644 (file)
--- a/examples/doc/echoserver.qdoc
+++ b/examples/doc/echoserver.qdoc
@@ -43,9 +43,11 @@
     \example echoserver
     \title Echo Server Example
     \ingroup qtwebsockets-examples
+    \brief Shows how to create a simple server application that
+    sends back the messages it receives.
 
-    The Echo Server example shows how to create a simple server application that
-    sends back the messages that it receives, using the websockets API.
+    The Echo Server Example shows how to create a simple server application that
+    sends back the messages it receives, using the websockets API.
 
     \sa {Echo Client Example}
 */

diff --git a/examples/doc/qmlwebsocketclient.qdoc b/examples/doc/qmlwebsocketclient.qdoc
index 0bf39bd..776e486 100644 (file)
--- a/examples/doc/qmlwebsocketclient.qdoc
+++ b/examples/doc/qmlwebsocketclient.qdoc
@@ -43,4 +43,5 @@
     \example qmlwebsocketclient
     \title QML WebSocket Client Example
     \ingroup qtwebsockets-examples
+    \brief Explains how to program a QML WebSocket client example.
 */

diff --git a/examples/doc/simplechat.qdoc b/examples/doc/simplechat.qdoc
index 215c46a..506d45a 100644 (file)
--- a/examples/doc/simplechat.qdoc
+++ b/examples/doc/simplechat.qdoc
@@ -43,7 +43,10 @@
     \example simplechat
     \title Simple Chat Example
     \ingroup qtwebsockets-examples
+    \brief Shows how to use the QWebSocket and QWebSocketServer classes
+    for creating a minimalistic chat application over websockets.
 
-    The Simple Chat example shows how to use the QWebSocket and QWebSocketServer
+    The Simple Chat Example shows how to use the QWebSocket and QWebSocketServer
     classes to create a minimalistic chat application over websockets.
+
 */

diff --git a/examples/doc/sslechoclient.qdoc b/examples/doc/sslechoclient.qdoc
index ca515ec..d7d1897 100644 (file)
--- a/examples/doc/sslechoclient.qdoc
+++ b/examples/doc/sslechoclient.qdoc
@@ -43,6 +43,8 @@
     \example sslechoclient
     \title SSL Echo Client Example
     \ingroup qtwebsockets-examples
+    \brief Shows how to use the QWebSocket class to implement an echo
+    client over a secure connection (wss).
 
     The SSL Echo Client example shows how to use the QWebSocket class to implement
     an echo client over a secure connection (wss).

diff --git a/examples/doc/sslechoserver.qdoc b/examples/doc/sslechoserver.qdoc
index 608b27a..d158a68 100644 (file)
--- a/examples/doc/sslechoserver.qdoc
+++ b/examples/doc/sslechoserver.qdoc
@@ -43,6 +43,8 @@
     \example sslechoserver
     \title SSL Echo Server Example
     \ingroup qtwebsockets-examples
+    \brief Shows how to use the QWebSocketServer class for implementing a simple
+    echo server over secure sockets (wss).
 
     The SSL Echo Server example shows how to use the QWebSocketServer class
     to implement a simple echo server over secure sockets (wss).

diff --git a/examples/examples.qdoc b/examples/examples.qdoc
index b770704..bc1ad32 100644 (file)
--- a/examples/examples.qdoc
+++ b/examples/examples.qdoc
@@ -45,8 +45,7 @@
     \page examples.html
     \brief List of Qt WebSocket examples
 
-    The module provides the following examples for reference to
-    help understand the API usage:
+    The examples below can be used as a guide to using the API.
 
     \list
     \li \l echoclient

diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc
index f85380b..2961ef3 100644 (file)
--- a/src/websockets/doc/src/index.qdoc
+++ b/src/websockets/doc/src/index.qdoc
@@ -50,10 +50,15 @@
     QT += websockets
     \endcode
 
-    \section1 Related information
+    \section1 Reference documentation
     \list
     \li \l{Qt WebSockets C++ Classes}{C++ Classes}
-    \li \l{Qt WebSockets Examples}{Examples}
     \li \l{Qt WebSockets QML Types}{QML Types}
     \endlist
+
+    \section1 Examples
+
+    The module provides the following examples as a guide to using
+    the API.
+    \l{Qt WebSockets Examples}{Examples}
 */

diff --git a/src/websockets/doc/src/qtwebsockets-module.qdoc b/src/websockets/doc/src/qtwebsockets-module.qdoc
index c4dea41..02d31d1 100644 (file)
--- a/src/websockets/doc/src/qtwebsockets-module.qdoc
+++ b/src/websockets/doc/src/qtwebsockets-module.qdoc
@@ -29,6 +29,7 @@
     \title Qt WebSockets C++ Classes
     \ingroup modules
     \qtvariable websockets
+    \since 5.3
     \brief List of C++ classes that provide WebSockets communication.
 
     To use these classes in your application, use the following include
@@ -52,4 +53,9 @@
     \brief List of QML types that provide WebSockets communication.
 
     \annotatedlist websockets-qml
+
+    The QML types are accessed by using:
+    \code
+    import QtWebSockets 1.0
+    \endcode
 */