summaryrefslogtreecommitdiff
path: root/src/websockets/doc
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2014-02-28 12:31:13 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-11 14:13:45 +0100
commitd122d15b66bdcecb42f4c3cabaeaab6791f1edaa (patch)
treeca6dda410f9addd4551b93757ed6e21c628e015b /src/websockets/doc
parentceac1d619029e1fcf10c12290fbaac25c7fa516e (diff)
downloadqtwebsockets-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 'src/websockets/doc')
-rw-r--r--src/websockets/doc/src/index.qdoc9
-rw-r--r--src/websockets/doc/src/qtwebsockets-module.qdoc6
2 files changed, 13 insertions, 2 deletions
diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc
index f85380b..2961ef3 100644
--- 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
--- 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
*/