diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-10-06 17:22:04 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-10-17 07:22:06 +0000 |
commit | 916c6b921246c3214b518886278990347fc00e21 (patch) | |
tree | 4d55d75eb748d5340420166c97e517262e4955d6 /src/webengine | |
parent | b918c9fbee7cd1fd804000f0577516b0c0a2aa60 (diff) |
Doc: Fix grouping Qt WebEngine modules
Add a page for exposed Qt WebEngine module C++ classes.
Change-Id: I4fd15e9d5c5c1b8c51a836ad5a036083adaae328
Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src/webengine')
-rw-r--r-- | src/webengine/doc/snippets/qtwebengine_build_snippet.qdoc | 8 | ||||
-rw-r--r-- | src/webengine/doc/src/qtwebengine-index.qdoc | 1 | ||||
-rw-r--r-- | src/webengine/doc/src/qtwebengine-module.qdoc | 44 |
3 files changed, 52 insertions, 1 deletions
diff --git a/src/webengine/doc/snippets/qtwebengine_build_snippet.qdoc b/src/webengine/doc/snippets/qtwebengine_build_snippet.qdoc new file mode 100644 index 000000000..248296588 --- /dev/null +++ b/src/webengine/doc/snippets/qtwebengine_build_snippet.qdoc @@ -0,0 +1,8 @@ +//! [0] +QT += webengine +//! [0] + + +//! [1] +#include <QtWebEngine> +//! [1] diff --git a/src/webengine/doc/src/qtwebengine-index.qdoc b/src/webengine/doc/src/qtwebengine-index.qdoc index c4be591ff..bd6cc9a32 100644 --- a/src/webengine/doc/src/qtwebengine-index.qdoc +++ b/src/webengine/doc/src/qtwebengine-index.qdoc @@ -28,7 +28,6 @@ /*! \page qtwebengine-index.html \title Qt WebEngine - \ingroup modules \brief Provides functionality for rendering regions of dynamic web content. diff --git a/src/webengine/doc/src/qtwebengine-module.qdoc b/src/webengine/doc/src/qtwebengine-module.qdoc new file mode 100644 index 000000000..97657f6a9 --- /dev/null +++ b/src/webengine/doc/src/qtwebengine-module.qdoc @@ -0,0 +1,44 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://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 https://www.qt.io/terms-conditions. For further +** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \module QtWebEngine + \title Qt WebEngine C++ Classes + \brief Exposes C++ functionality to Qt Quick. + \ingroup modules + + The Qt WebEngine module exposes C++ functionality to Qt Quick. + + To include the definitions of the module's classes, use the + following directive: + + \snippet qtwebengine_build_snippet.qdoc 1 + + To link against the module, add the following to your qmake project file: + + \snippet qtwebengine_build_snippet.qdoc 0 +*/ |