From d122d15b66bdcecb42f4c3cabaeaab6791f1edaa Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Fri, 28 Feb 2014 12:31:13 +0100 Subject: Doc: Review documentation Qt WebSockets Task-number: QTBUG-37149 Change-Id: Ia8fe7b11140d31bc231a17bfcc16887f3af0dbce Reviewed-by: Jerome Pasion --- src/websockets/doc/src/index.qdoc | 9 +++++++-- src/websockets/doc/src/qtwebsockets-module.qdoc | 6 ++++++ 2 files changed, 13 insertions(+), 2 deletions(-) (limited to 'src') 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 */ -- cgit v1.2.3