Add documentation for QtWebEngineCore module

Now that QtWebEngineCore has public API, we should document the module.

Change-Id: I29660243da80b5923836bb2d0394dc2e8be209e2
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@theqtcompany.com>
Reviewed-by: Andras Becsi <andras.becsi@theqtcompany.com>

3 files changed, 139 insertions, 0 deletions

diff --git a/src/core/doc/qtwebenginecore.qdocconf b/src/core/doc/qtwebenginecore.qdocconf
new file mode 100644
index 000000000..491447706
--- /dev/null
+++ b/src/core/doc/qtwebenginecore.qdocconf
@@ -0,0 +1,32 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
+
+project                 = QtWebEngineCore
+description             = Qt WebEngineCore Reference Documentation
+version                 = $QT_VERSION
+
+qhp.projects            = QtWebEngineCore
+
+qhp.QtWebEngineCore.file                = qtwebenginecore.qhp
+qhp.QtWebEngineCore.namespace           = org.qt-project.qtwebenginecore.$QT_VERSION_TAG
+qhp.QtWebEngineCore.virtualFolder       = qtwebenginecore
+qhp.QtWebEngineCore.indexTitle          = Qt WebEngine Core
+qhp.QtWebEngineCore.indexRoot           =
+
+qhp.QtWebEngineCore.filterAttributes    = qtwebenginecore $QT_VERSION qtrefdoc
+qhp.QtWebEngineCore.customFilters.Qt.name = QtWebEngineCore $QT_VERSION
+qhp.QtWebEngineCore.customFilters.Qt.filterAttributes = qtwebenginecore $QT_VERSION
+qhp.QtWebEngineCore.subprojects         = classes
+qhp.QtWebEngineCore.subprojects.classes.title = C++ Classes
+qhp.QtWebEngineCore.subprojects.classes.indexTitle = Qt WebEngine Core C++ Classes
+qhp.QtWebEngineCore.subprojects.classes.selectors = class fake:headerfile
+qhp.QtWebEngineCore.subprojects.classes.sortPages = true
+
+depends += qtcore qtdoc qmake
+
+headerdirs  += ../api
+sourcedirs  += ../api src
+
+exampledirs += snippets
+
+navigation.landingpage = "Qt WebEngine Core"
+navigation.cppclassespage = "Qt WebEngine Core C++ Class Types"
diff --git a/src/core/doc/snippets/qtwebenginecore_build_snippet.qdoc b/src/core/doc/snippets/qtwebenginecore_build_snippet.qdoc
new file mode 100644
index 000000000..4806359c9
--- /dev/null
+++ b/src/core/doc/snippets/qtwebenginecore_build_snippet.qdoc
@@ -0,0 +1,8 @@
+//! [0]
+QT += webenginecore
+//! [0]
+
+
+//! [1]
+#include <QtWebEngineCore>
+//! [1]
diff --git a/src/core/doc/src/qtwebenginecore.qdoc b/src/core/doc/src/qtwebenginecore.qdoc
new file mode 100644
index 000000000..a690d3f0e
--- /dev/null
+++ b/src/core/doc/src/qtwebenginecore.qdoc
@@ -0,0 +1,99 @@
+/****************************************************************************
+**
+** 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
+
+    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.
+*/
+
+/*!
+    \page qtwebenginecore-index.html
+    \title Qt WebEngine Core
+    \ingroup modules
+
+    \brief Common API shared by both Qt WebEngine and Qt WebEngine Widgets.
+
+    Qt WebEngine Core provides API shared by both Qt WebEngine and
+    Qt WebEngine Widgets.
+
+
+    \section1 License Information
+    This is a snapshot of the integration of Chromium into Qt.
+
+    Qt Commercial Edition licensees that wish to distribute applications that
+    use the Qt WebEngine module need to be aware of their obligations under the
+    GNU Library General Public License (LGPLv2).
+
+    Developers using the Open Source Edition can choose to redistribute
+    the module under the GNU LGPLv3 or GPLv2 and up.
+
+    \legalese
+
+    Chromium is licensed under the following license:
+
+    Copyright (c) 2013 The Chromium Authors. All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are
+    met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following disclaimer
+      in the documentation and/or other materials provided with the
+      distribution.
+    * Neither the name of Google Inc. nor the names of its
+    contributors may be used to endorse or promote products derived from
+    this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+    \endlegalese
+*/