diff options
author | Andreas Eliasson <andreas.eliasson@qt.io> | 2022-03-24 13:33:49 +0100 |
---|---|---|
committer | Andreas Eliasson <andreas.eliasson@qt.io> | 2022-03-28 11:42:37 +0100 |
commit | acc165cc4ef68832e250c10807d7966f9032af0c (patch) | |
tree | 69903ecdbbc6572659f64e2f3c99ed96c3f33156 /src | |
parent | 8ae49e865b38d5407e987b12fcd8a8576ccf52a2 (diff) | |
download | qtwebsockets-acc165cc4ef68832e250c10807d7966f9032af0c.tar.gz |
Doc: Revise Qt WebSockets module landing page
Remove the include directive section and add the global CMake and qmake
snippets. Also, reorganize some of the sections structure.
Task-number: QTBUG-100369
Pick-to: 6.3 6.3.0
Change-Id: Ief7a5f845df5b2edaa17c3c652895a4adb7ad3a5
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/websockets/doc/src/index.qdoc | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc index 9bd5e30..37e9475 100644 --- a/src/websockets/doc/src/index.qdoc +++ b/src/websockets/doc/src/index.qdoc @@ -31,61 +31,61 @@ \title Qt WebSockets \brief Provides an implementation of the WebSocket protocol. - WebSocket is a web-based protocol designed to enable two-way communication - between a client application and a remote host. It enables the two entities - to send data back and forth if the initial handshake succeeds. WebSocket is - the solution for applications that struggle to get real-time data feeds - with less network latency and minimum data exchange. + WebSocket is a web-based protocol designed to enable a two-way interactive + communication session between a client application and a remote host. It + enables the two entities to send data back and forth if the initial + handshake succeeds. The Qt WebSockets module provides C++ and QML interfaces that enable Qt applications to act as a server that can process WebSocket requests, or a client that can consume data received from the server, or both. - \section1 Getting Started + \section1 Using the Module - To include the definitions of the module's classes, use the following directive: + \section2 QML API - \code - #include <QtWebSockets/QtWebSockets> - \endcode + \include {module-use.qdocinc} {using the qml api} {QtWebSockets} - To import the QML types into your application, use the following import statement in your .qml file: + \section2 C++ API - \qml \QtMinorVersion - import QtWebSockets 1.\1 - \endqml + \include {module-use.qdocinc} {using the c++ api} - To link against the module, add this line to your qmake .pro file: + \section3 Building with CMake - \code - QT += websockets - \endcode + \include {module-use.qdocinc} {building with cmake} {WebSockets} - \section1 Licenses + \section3 Building with qmake - Qt WebSockets is available under commercial licenses from \l{The Qt Company}. - In addition, it is available under free software licenses. Since Qt 5.4, - these free software licenses are - \l{GNU Lesser General Public License, version 3}, or - the \l{GNU General Public License, version 2}. - See \l{Qt Licensing} for further details. + \include {module-use.qdocinc} {building_with_qmake} {websockets} + + \section1 Examples - \section1 Reference Documentation \list - \li \l{Qt WebSockets Overview}{Overview} - \li \l{Qt WebSockets C++ Classes}{C++ Classes} - \li \l{Qt WebSockets QML Types}{QML Types} + \li \l {Qt WebSockets Examples} \endlist - \section1 Examples + \section1 Reference - The module provides the following \l{Qt WebSockets Examples}{Examples} as a guide to using - the API. + \list + \li \l {Qt WebSockets Overview} {Overview} + \li \l {Qt WebSockets C++ Classes} {C++ Classes} + \li \l {Qt WebSockets QML Types} {QML Types} + \endlist \section1 Conformance + \list - \li \l {Testing Qt WebSockets} + \li \l {Testing Qt WebSockets} \endlist + + \section1 Licenses + + Qt WebSockets is available under commercial licenses from \l{The Qt Company}. + In addition, it is available under free software licenses. Since Qt 5.4, + these free software licenses are + \l{GNU Lesser General Public License, version 3}, or + the \l{GNU General Public License, version 2}. + See \l{Qt Licensing} for further details. */ /*! |