From 10cad9ece2cb380e26e03a1c03b900f8e3b4c801 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Mon, 23 May 2016 11:45:35 +0200 Subject: Doc: Also mention QML Import in index page qtwebsockets-index.html is the entry point for both C++ and QML API. Change-Id: I81efb2d7b931cce0d63efc2f25ce89904abcbfad Reviewed-by: Leena Miettinen --- src/websockets/doc/src/index.qdoc | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc index 9e1c40c..4f25589 100644 --- a/src/websockets/doc/src/index.qdoc +++ b/src/websockets/doc/src/index.qdoc @@ -41,15 +41,21 @@ 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. - To use this module in your application, use the following include - statement: + \section1 Getting Started + + To include the definitions of the module's classes, use the following directive: \code #include \endcode - To link against the module, add this line to your \l qmake \c - .pro file: + To import the QML types into your application, use the following import statement in your .qml file: + + \code + import QtWebSockets 1.0 + \endcode + + To link against the module, add this line to your qmake .pro file: \code QT += websockets -- cgit v1.2.1