diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-05-31 15:34:32 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-05-31 13:44:02 +0000 |
commit | 01ea92c7c8d77d3d3c10ab1cc4bf4f214aa07126 (patch) | |
tree | 7fdc236b2c1ba022357c8b7ba2e46ea5828fca3d /src/webchannel/doc | |
parent | bec50124b893c4632829d9806f49f64c4debf936 (diff) | |
download | qtwebchannel-01ea92c7c8d77d3d3c10ab1cc4bf4f214aa07126.tar.gz |
Doc: Edit example documentation
- Add images to the examples.
- Add instructions for running the examples
- Edit for grammar and style
- Add dependencies to Qt WebEngine and Qt WebSockets modules
- Add a workaround for preventing autolinking of WebChannel,
WebEngine and WebSockets to the wrong targets
- Use explicit linking where necessary
Change-Id: Ia4025284063fa09c9e2a0b2c347ee682bba8a615
Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src/webchannel/doc')
-rw-r--r-- | src/webchannel/doc/qtwebchannel.qdocconf | 3 | ||||
-rw-r--r-- | src/webchannel/doc/src/examples.qdoc | 3 | ||||
-rw-r--r-- | src/webchannel/doc/src/external-resources.qdoc | 57 |
3 files changed, 61 insertions, 2 deletions
diff --git a/src/webchannel/doc/qtwebchannel.qdocconf b/src/webchannel/doc/qtwebchannel.qdocconf index cfb47e4..4026379 100644 --- a/src/webchannel/doc/qtwebchannel.qdocconf +++ b/src/webchannel/doc/qtwebchannel.qdocconf @@ -40,7 +40,7 @@ qhp.QtWebChannel.subprojects.javascript.indexTitle = Qt WebChannel JavaScript tagfile = ../../../doc/qtwebchannel/qtwebchannel.tags -depends += qtcore qtquick qtqml qmake qtdoc +depends += qtcore qtquick qtqml qmake qtdoc qtwebengine qtwebsockets headerdirs += .. \ ../../imports @@ -48,6 +48,7 @@ headerdirs += .. \ sourcedirs += .. \ ../../imports +imagedirs += images exampledirs += ../../../examples/webchannel examples.fileextensions += "*.html *.json" diff --git a/src/webchannel/doc/src/examples.qdoc b/src/webchannel/doc/src/examples.qdoc index c47b687..34875f8 100644 --- a/src/webchannel/doc/src/examples.qdoc +++ b/src/webchannel/doc/src/examples.qdoc @@ -36,6 +36,7 @@ \group qtwebchannel-examples \brief List of Qt WebChannel examples. - The examples show how to use the QWebChannel C++ and WebChannel QML API. + The examples show how to use the QWebChannel C++ and \l [QML] WebChannel QML + API. */ diff --git a/src/webchannel/doc/src/external-resources.qdoc b/src/webchannel/doc/src/external-resources.qdoc new file mode 100644 index 0000000..0002ec1 --- /dev/null +++ b/src/webchannel/doc/src/external-resources.qdoc @@ -0,0 +1,57 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/* + The nolink entries prevent autolinking of each occurrence of 'WebChannel' + 'WebEngine' or 'WebSocket' to the QML type. + To link to the QML type, use explicit linking. For example: + \l [QML] WebChannel + \sa {QtWebChannel::}{WebChannel} +*/ +/*! + \externalpage nolink + \title WebChannel + \internal +*/ + +/*! + \externalpage nolink + \title WebEngine + \internal +*/ + +/*! + \externalpage nolink + \title WebSockets + \internal +*/ + +/*! + \externalpage nolink + \title WebSocket + \internal +*/ |