diff options
author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-08-19 12:30:48 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-08-19 13:32:51 +0000 |
commit | 26d33081187c5b2865cfd2431202cacfde54c081 (patch) | |
tree | e8c752cc63a298684b7b9dc695007384b72c7fe7 /src/core/doc/src | |
parent | 9317c7525ebd5f581ee19fb9123823820b54ce13 (diff) |
Doc: reorganize and rename docs
- Move general docs to src/webengine/doc/src
- Remove a dedicated .qdocconf for Qt WebEngine Core,
build its documentation as part of Qt WebEngine
- Describe all Qt WebEngine modules on the Qt WebEngine
index and overview pages
- Add a wireframe drawing on the architecture
Change-Id: Ib4261d1a16bbaf313d0f858515184a96dab524a5
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/core/doc/src')
-rw-r--r-- | src/core/doc/src/qtwebenginecore-index.qdoc (renamed from src/core/doc/src/qtwebenginecore.qdoc) | 37 | ||||
-rw-r--r-- | src/core/doc/src/qtwebenginecore-module.qdoc | 44 |
2 files changed, 65 insertions, 16 deletions
diff --git a/src/core/doc/src/qtwebenginecore.qdoc b/src/core/doc/src/qtwebenginecore-index.qdoc index a690d3f0e..49231c8f2 100644 --- a/src/core/doc/src/qtwebenginecore.qdoc +++ b/src/core/doc/src/qtwebenginecore-index.qdoc @@ -25,35 +25,40 @@ ** ****************************************************************************/ - /*! - \module QtWebEngineCore - \title Qt WebEngine Core C++ Classes - \brief Provides public API shared by both QtWebEngine and QtWebEngineWidgets - \since 5.6 + \page qtwebenginecore-index.html + \title Qt WebEngine Core + \ingroup modules + + \brief Provides common API shared by Qt WebEngine and Qt WebEngine Widgets. + + Qt WebEngine Core provides API shared by \l {Qt WebEngine} and \l {Qt WebEngine Widgets}. + + \section1 Getting Started To include the definitions of the module's classes, use the following directive: \snippet qtwebenginecore_build_snippet.qdoc 1 - If you use qmake to build your projects, Qt WebEngine Core is usually - indirectly included through the \l[QtWebEngine]{Qt WebEngine} or - \l[QtWebEngineWidgets]{Qt WebEngine Widgets} modules. -*/ + To link against the module, add this line to your qmake project file: -/*! - \page qtwebenginecore-index.html - \title Qt WebEngine Core - \ingroup modules + \snippet qtwebenginecore_build_snippet.qdoc 0 + + \section1 Articles and Guides - \brief Common API shared by both Qt WebEngine and Qt WebEngine Widgets. + \list + \li \l{Qt WebEngine Overview} + \endlist - Qt WebEngine Core provides API shared by both Qt WebEngine and - Qt WebEngine Widgets. + \section1 API Reference + \list + \li \l{Qt WebEngine Core C++ Classes} + \endlist \section1 License Information + This is a snapshot of the integration of Chromium into Qt. Qt Commercial Edition licensees that wish to distribute applications that diff --git a/src/core/doc/src/qtwebenginecore-module.qdoc b/src/core/doc/src/qtwebenginecore-module.qdoc new file mode 100644 index 000000000..750a0244e --- /dev/null +++ b/src/core/doc/src/qtwebenginecore-module.qdoc @@ -0,0 +1,44 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + + +/*! + \module QtWebEngineCore + \title Qt WebEngine Core C++ Classes + \brief Provides public API shared by both QtWebEngine and QtWebEngineWidgets + \since 5.6 + \ingroup qtwebengine-modules + + To include the definitions of the module's classes, use the + following directive: + + \snippet qtwebenginecore_build_snippet.qdoc 1 + + If you use qmake to build your projects, Qt WebEngine Core is usually + indirectly included through the \l[QtWebEngine]{Qt WebEngine} or + \l[QtWebEngineWidgets]{Qt WebEngine Widgets} modules. +*/ |