Doc: Fixing Qt WebKit reference documentation.

Fixes:
-added \module for C++ classes and \qmlmodule for QML types
-added links to the Qt WebKit Examples pages
-fixed the qhp settings for Qt Creator

Task-number: QTBUG-28583
Task-number: QTBUG-28418
Task-number: QTBUG-27646
Change-Id: I883139f51f457bd6dc7bfe72bb53eb26771d2ccb
Reviewed-by: hjk <qthjk@ovi.com>
Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>

3 files changed, 67 insertions, 43 deletions

diff --git a/Source/WebKit/qt/docs/qtwebkit.qdoc b/Source/WebKit/qt/docs/qtwebkit.qdoc
index f17802d84..7d82714c6 100644
--- a/Source/WebKit/qt/docs/qtwebkit.qdoc
+++ b/Source/WebKit/qt/docs/qtwebkit.qdoc
@@ -1,24 +1,51 @@
 /*!
     \module QtWebKit
+    \title Qt WebKit Widgets C++ Classes
+    \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 webkitsnippets/qtwebkit_build_snippet.qdoc 1
+
+    To link against the module, add this line to your \l qmake \c
+    .pro file:
+
+    \snippet webkitsnippets/qtwebkit_build_snippet.qdoc 0
+
+*/
+
+/*!
+    \qmlmodule QtWebKit 3.0
+    \title Qt WebKit QML Types
+    \brief Provides QML types for rendering web content within a QML application
+
+    The QML types can be imported into your applciation using the following
+    import statement in your .qml file:
+
+    \code
+    import QtQuick 2.0
+    import QtWebKit 3.0
+    \endcode
+*/
+
+/*!
     \page qtwebkitwidgets-index.html
     \title Qt Webkit Widgets
-    \contentspage All Qt Modules
-    \previouspage QtSvg
-    \nextpage QtXml
     \ingroup modules
-    \ingroup technology-apis
 
-    \brief The QtWebKit module provides a web browser engine as well as
-    classes to render and interact with web content.
+    \brief The Qt WebKit Widgets module provides a web browser engine as well as
+    C++ classes to render and interact with web content.
 
-    QtWebKit provides a Web browser engine that makes it easy to embed content
-    from the World Wide Web into your Qt application. At the same time Web
-    content can be enhanced with native controls.
+    Qt WebKit Widgets provides a Web browser engine that makes it easy to embed
+    content from the World Wide Web into your Qt application. At the same time
+    Web content can be enhanced with native controls.
 
-    QtWebKit provides facilities for rendering of HyperText Markup Language
-    (HTML), Extensible HyperText Markup Language (XHTML) and Scalable Vector
-    Graphics (SVG) documents, styled using Cascading Style Sheets (CSS) and
-    scripted with JavaScript.
+    Qt WebKit Widgets provides facilities for rendering of HyperText Markup
+    Language (HTML), Extensible HyperText Markup Language (XHTML) and Scalable
+    Vector Graphics (SVG) documents, styled using Cascading Style Sheets (CSS)
+    and scripted with JavaScript.
 
     A bridge between the JavaScript execution environment and the Qt object
     model makes it possible for custom QObjects to be scripted. For detailed
@@ -45,7 +72,7 @@
 
     \snippet webkitsnippets/qtwebkit_build_snippet.qdoc 0
 
-    \section1 Notes 
+    \section1 Notes
 
     \note Building the QtWebKit module with debugging symbols is problematic
     on many platforms due to the size of the WebKit engine. We recommend
@@ -154,7 +181,11 @@
     \li The system \c{/Library/Internet Plug-Ins} directory
     \endlist
     \endtable
-    
+
+    \section1 Examples
+
+    There are several Qt WebKit Widgets examples located in the
+    \l{Qt WebKit Examples} page.
 
     \section1 License Information
 
@@ -189,4 +220,3 @@
     Boston, MA 02110-1301, USA.
     \endlegalese
 */
-
diff --git a/Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp b/Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp
index fd026215f..0e33f116f 100644
--- a/Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp
+++ b/Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp
@@ -1463,6 +1463,12 @@ QQuickWebPage* QQuickWebViewExperimental::page()
         }
     }
     \endcode
+
+    \section1 Examples
+
+    There are several Qt WebKit examples located in the
+    \l{Qt WebKit Examples} page.
+
 */
 
 
diff --git a/Source/qtwebkit.qdocconf b/Source/qtwebkit.qdocconf
index 6421dd5ec..f10ef279e 100644
--- a/Source/qtwebkit.qdocconf
+++ b/Source/qtwebkit.qdocconf
@@ -1,29 +1,28 @@
-include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
 include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
 
-project     = qtwebkit
+project     = QtWebKit
 description = "Qt WebKit API Documentation"
 version     = 5.0.0
 
 # Defines the name of the project. You cannot use operators (+, =, -) in
 # the name. Properties for this project are set using a qhp.<projectname>.property
 # format.
-qhp.projects = qtwebkit
-qhp.qtwebkit.file = qtwebkit.qhp
-qhp.qtwebkit.namespace = org.qt-project.qtwebkit.500
-qhp.qtwebkit.indexTitle = Qt WebKit Reference Documentation
-qhp.qtwebkit.virtualFolder  = qtwebkit
+qhp.projects = QtWebKit
+qhp.QtWebKit.file = qtwebkit.qhp
+qhp.QtWebKit.namespace = org.qt-project.qtwebkit.500
+qhp.QtWebKit.indexTitle = Qt WebKit
+qhp.QtWebKit.virtualFolder  = qtwebkit
 
 # For listing child nodes in Qt Creator or Assistant.
-qhp.qtwebkit.subprojects = classes qmltypes
-qhp.qtwebkit.subprojects.classes.title = C++ Classes
-qhp.qtwebkit.subprojects.classes.indexTitle = Qt WebKit C++ Classes
-qhp.qtwebkit.subprojects.classes.selectors = class fake:headerfile
-qhp.qtwebkit.subprojects.classes.sortPages = true
-qhp.qtwebkit.subprojects.qmltypes.title = QML Types
-qhp.qtwebkit.subprojects.qmltypes.indexTitle = Qt WebKit QML Types
-qhp.qtwebkit.subprojects.qmltypes.selectors = class fake:headerfile
-qhp.qtwebkit.subprojects.qmltypes.sortPages = true
+qhp.QtWebKit.subprojects = classes qmltypes
+qhp.QtWebKit.subprojects.classes.title = Qt WebKit Widgets
+qhp.QtWebKit.subprojects.classes.indexTitle = Qt WebKit Widgets
+qhp.QtWebKit.subprojects.classes.selectors = class fake:headerfile
+qhp.QtWebKit.subprojects.classes.sortPages = true
+qhp.QtWebKit.subprojects.qmltypes.title = QML Types
+qhp.QtWebKit.subprojects.qmltypes.indexTitle = Qt WebKit QML Types
+qhp.QtWebKit.subprojects.qmltypes.selectors = fake:headerfile
+qhp.QtWebKit.subprojects.qmltypes.sortPages = true
 
 headerdirs = WebKit/qt/Api WebKit/qt/WidgetApi WebKit2/UIProcess/API/qt
 sourcedirs = WebKit/qt/Api WebKit/qt/WidgetApi WebKit/qt/docs Source/JavaScriptCore/qt/api WebKit2/UIProcess/API/qt
@@ -31,14 +30,3 @@ exampledirs = WebKit/qt/docs
 imagedirs = WebKit/qt/docs
 
 depends += qtcore qtwidgets qtgui qtscript qtdoc qtprintsupport qtxml qtwebkitexamples
-
-qhp.projects = qtwebkit
-
-qhp.qtwebkit.file = qtwebkit.qhp
-qhp.qtwebkit.namespace = org.qt-project.qtwebkit.500
-qhp.qtwebkit.indexTitle = Qt WebKit Documentation
-qhp.qtwebkit.virtualFolder  = qtwebkit
-qhp.qtwebkit.subprojects = classes
-qhp.qtwebkit.subprojects.classes.title = Qt WebKit C++ Classes
-qhp.qtwebkit.subprojects.classes.selectors = class fake:headerfile
-qhp.qtwebkit.subprojects.classes.sortPages = true