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>

5 files changed, 105 insertions, 76 deletions

diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets-examples.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-examples.qdoc
new file mode 100644
index 000000000..eff22be26
--- /dev/null
+++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-examples.qdoc
@@ -0,0 +1,38 @@
+/*
+    Copyright (C) 2015 The Qt Company Ltd.
+    Copyright (C) 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+    1.  Redistributions of source code must retain the above copyright
+        notice, this list of conditions and the following disclaimer.
+    2.  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.
+
+    THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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.
+*/
+
+/*!
+    \group webengine-widgetexamples
+    \title Qt WebEngine Widgets Examples
+    \brief Examples demonstrating the Qt WebEngine Widgets usage
+    \ingroup all-examples
+
+    Qt provides an integrated Web browser component based on Chromium, the popular
+    open source browser engine.
+
+    These examples and demonstrations show a range of different uses for Qt WebEngine,
+    from displaying Web pages within a Qt user interface to an implementation of
+    a basic function Web browser.
+*/
diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc
index 1e8cda065..77596a370 100644
--- a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc
+++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc
@@ -26,74 +26,29 @@
 ****************************************************************************/
 
 /*!
-    \module QtWebEngineWidgets
-    \title Qt WebEngine Widgets C++ Classes
-    \qtvariable webenginewidgets
-    \brief Provides a web browser engine as well as C++ classes to render and
-    interact with web content
-
-    To include the definitions of the module's classes, use the
-    following directive:
-
-    \snippet snippets/qtwebengine_build_snippet.qdoc 1
-
-    To link against the module, add this line to your \l qmake \c
-    .pro file:
-
-    \snippet snippets/qtwebengine_build_snippet.qdoc 0
-*/
-
-/*!
     \page qtwebenginewidgets-index.html
     \title Qt WebEngine Widgets
     \ingroup modules
 
-    \brief The Qt WebEngine Widgets module provides a web browser engine as
-    well as C++ classes to display and interact with web content.
-
-    Qt WebEngine Widgets gives you a Web browser engine that you can use to
-    embed content easily from the World Wide Web into your Qt application.
-
-    Qt WebEngine Widgets lets you display HyperText Markup Language version 5
-    (HTML5), Extensible HyperText Markup Language (XHTML) and Scalable Vector
-    Graphics (SVG) documents, styled using Cascading Style Sheets (CSS) and
-    scripted with JavaScript.
-
-    HTML and XHTML documents can also be made fully editable to the user by
-    using the \c{contenteditable} attribute on HTML elements.
+    \brief Provides a web browser engine as well as C++ classes to render  web content and interact
+    with it.
 
-    Qt WebEngine is based on the Chromium project. See the
-    \l{http://www.chromium.org}{Chromium Project} Web site for more information.
-
-    \section1 Including In Your Project
+    \section1 Getting Started
 
     To include the definitions of the module's classes, use the
     following directive:
 
-    \snippet snippets/qtwebengine_build_snippet.qdoc 1
-
-    To link against the module, add this line to your \l qmake \c
-    .pro file:
-
-    \snippet snippets/qtwebengine_build_snippet.qdoc 0
+    \snippet qtwebengine_build_snippet.qdoc 1
 
-    \section1 Architecture
+    To link against the module, add this line to your qmake project file:
 
-    Use the QWebEngineView class to display web pages in the simplest way.
-    Because it's a widget, you can embed QWebEngineView into your forms and use
-    its convenience functions to download and display web sites.
+    \snippet qtwebengine_build_snippet.qdoc 0
 
-    \snippet snippets/simple/main.cpp Using QWebEngineView
-
-    An instance of QWebEngineView has one QWebEnginePage. QWebEnginePage
-    provides access to the page's navigation history, ability to run JavaScript
-    code in the context of the page's main frame, and enables customization of
-    handlers for specific events like showing custom authentication dialogs.
-
-    \section1 Reference Documentation
+    \section1 Articles and Guides
 
     \list
-        \li \l {Qt WebEngine Widgets C++ Classes}
+        \li \l{Qt WebEngine Overview}
+        \li \l{Porting from Qt WebKit to Qt WebEngine}
     \endlist
 
     \section1 Examples
@@ -102,7 +57,14 @@
         \li \l {Qt WebEngine Widgets Examples}
     \endlist
 
+    \section1 API Reference
+
+    \list
+        \li \l {Qt WebEngine Widgets 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
@@ -146,17 +108,3 @@
 
     \endlegalese
 */
-
-/*!
-    \group webengine-widgetexamples
-    \title Qt WebEngine Widgets Examples
-    \brief Examples demonstrating the Qt WebEngine Widgets usage
-    \ingroup all-examples
-
-    Qt provides an integrated Web browser component based on Chromium, the popular
-    open source browser engine.
-
-    These examples and demonstrations show a range of different uses for Qt WebEngine,
-    from displaying Web pages within a Qt user interface to an implementation of
-    a basic function Web browser.
-*/
diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc
new file mode 100644
index 000000000..6373389f3
--- /dev/null
+++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc
@@ -0,0 +1,43 @@
+/****************************************************************************
+**
+** 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 QtWebEngineWidgets
+    \title Qt WebEngine Widgets C++ Classes
+    \brief Provides a web browser engine as well as C++ classes to render and
+    interact with web content
+    \ingroup qtwebengine-modules
+
+    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
+*/
diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
index 676643387..e1990af73 100644
--- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
@@ -351,7 +351,7 @@
     was found; otherwise the callback value will be false.
 
     For example:
-    \snippet snippets/qtwebengine_qwebenginepage_snippet.cpp 0
+    \snippet qtwebengine_qwebenginepage_snippet.cpp 0
 */
 
 /*!
diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
index 163e9a28e..76878e077 100644
--- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
@@ -41,7 +41,7 @@
     Qt widgets, the show() function must be invoked in order to display
     QWebEngineView. The snippet below illustrates this:
 
-    \snippet snippets/simple/main.cpp Using QWebEngineView
+    \snippet simple/main.cpp Using QWebEngineView
 
     Alternatively, setUrl() can also be used to load a web site. If you have
     the HTML content readily available, you can use setHtml() instead.
@@ -170,7 +170,7 @@
 
     It is equivalent to
 
-    \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 0
+    \snippet qtwebengine_qwebengineview_snippet.cpp 0
 */
 
 /*!
@@ -231,7 +231,7 @@
     The following example triggers the copy action and therefore copies any
     selected text to the clipboard.
 
-    \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 2
+    \snippet qtwebengine_qwebengineview_snippet.cpp 2
 
     \sa pageAction()
 */
@@ -268,7 +268,7 @@
 
     It is equivalent to
 
-    \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 3
+    \snippet qtwebengine_qwebengineview_snippet.cpp 3
 
     \sa reload(), pageAction(), loadFinished()
 */
@@ -280,7 +280,7 @@
 
     It is equivalent to
 
-    \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 4
+    \snippet qtwebengine_qwebengineview_snippet.cpp 4
 
     \sa forward(), pageAction()
 */
@@ -292,7 +292,7 @@
 
     It is equivalent to
 
-    \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 5
+    \snippet qtwebengine_qwebengineview_snippet.cpp 5
 
     \sa back(), pageAction()
 */
@@ -386,7 +386,7 @@
 
     It is equivalent to
 
-    \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 6
+    \snippet qtwebengine_qwebengineview_snippet.cpp 6
 
     \sa QWebEngineSettings::globalSettings()
 */