diff options
| author | Nico Vertriest <nico.vertriest@digia.com> | 2014-02-28 12:31:13 +0100 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-03-11 14:13:45 +0100 |
| commit | d122d15b66bdcecb42f4c3cabaeaab6791f1edaa (patch) | |
| tree | ca6dda410f9addd4551b93757ed6e21c628e015b /examples | |
| parent | ceac1d619029e1fcf10c12290fbaac25c7fa516e (diff) | |
| download | qtwebsockets-d122d15b66bdcecb42f4c3cabaeaab6791f1edaa.tar.gz | |
Doc: Review documentation Qt WebSockets
Task-number: QTBUG-37149
Change-Id: Ia8fe7b11140d31bc231a17bfcc16887f3af0dbce
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/doc/echoclient.qdoc | 5 | ||||
| -rw-r--r-- | examples/doc/echoserver.qdoc | 6 | ||||
| -rw-r--r-- | examples/doc/qmlwebsocketclient.qdoc | 1 | ||||
| -rw-r--r-- | examples/doc/simplechat.qdoc | 5 | ||||
| -rw-r--r-- | examples/doc/sslechoclient.qdoc | 2 | ||||
| -rw-r--r-- | examples/doc/sslechoserver.qdoc | 2 | ||||
| -rw-r--r-- | examples/examples.qdoc | 3 |
7 files changed, 18 insertions, 6 deletions
diff --git a/examples/doc/echoclient.qdoc b/examples/doc/echoclient.qdoc index a1f1646..a6cb1a9 100644 --- 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 --- 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 --- 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 --- 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 --- 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 --- 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 --- 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 |