[Qt] Doc: Fixing Qt WebKit reference documentation.
authorhausmann@webkit.org <hausmann@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 13 Dec 2012 15:04:36 +0000 (15:04 +0000)
committerhausmann@webkit.org <hausmann@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 13 Dec 2012 15:04:36 +0000 (15:04 +0000)
Patch by Jerome Pasion <jerome.pasion@digia.com> on 2012-12-13
Reviewed by Simon Hausmann.

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

.:

* Source/qtwebkit.qdocconf:

Source/WebKit/qt:

* docs/qtwebkit.qdoc:

Source/WebKit2:

* UIProcess/API/qt/qquickwebview.cpp:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@137590 268f45cc-cd09-0410-ab3c-d52691b4dbfc

ChangeLog
Source/WebKit/qt/ChangeLog
Source/WebKit/qt/docs/qtwebkit.qdoc
Source/WebKit2/ChangeLog
Source/WebKit2/UIProcess/API/qt/qquickwebview.cpp
Source/qtwebkit.qdocconf

index 7b72117..7699d1e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,20 @@
+2012-12-13  Jerome Pasion  <jerome.pasion@digia.com>
+
+        [Qt] Doc: Fixing Qt WebKit reference documentation.
+
+        Reviewed by Simon Hausmann.
+
+        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
+
+        * Source/qtwebkit.qdocconf:
+
 2012-12-13  Jerome Pasion <Jerome.Pasion@digia.com>
 
         [Qt] Fix missing doc dependency to examples
 2012-12-13  Jerome Pasion <Jerome.Pasion@digia.com>
 
         [Qt] Fix missing doc dependency to examples
index 6b555bc..dda2cd3 100644 (file)
@@ -1,3 +1,20 @@
+2012-12-13  Jerome Pasion  <jerome.pasion@digia.com>
+
+        [Qt] Doc: Fixing Qt WebKit reference documentation.
+
+        Reviewed by Simon Hausmann.
+
+        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
+
+        * docs/qtwebkit.qdoc:
+
 2012-12-12  Mark Lam  <mark.lam@apple.com>
 
         Encapsulate externally used webdatabase APIs in DatabaseManager.
 2012-12-12  Mark Lam  <mark.lam@apple.com>
 
         Encapsulate externally used webdatabase APIs in DatabaseManager.
index f8cd8e7..7190279 100644 (file)
@@ -1,23 +1,51 @@
 /*!
     \module QtWebKit
 /*!
     \module QtWebKit
-    \title WebKit in Qt
-    \contentspage All Qt Modules
-    \previouspage QtSvg
-    \nextpage QtXml
+    \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
     \ingroup modules
     \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
 
     A bridge between the JavaScript execution environment and the Qt object
     model makes it possible for custom QObjects to be scripted. For detailed
@@ -47,7 +75,7 @@
 
     \snippet webkitsnippets/qtwebkit_build_snippet.qdoc 0
 
 
     \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
 
     \note Building the QtWebKit module with debugging symbols is problematic
     on many platforms due to the size of the WebKit engine. We recommend
     \li The system \c{/Library/Internet Plug-Ins} directory
     \endlist
     \endtable
     \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
 
 
     \section1 License Information
 
     Boston, MA 02110-1301, USA.
     \endlegalese
 */
     Boston, MA 02110-1301, USA.
     \endlegalese
 */
-
index 1fe2dc4..b035d27 100644 (file)
@@ -1,3 +1,20 @@
+2012-12-13  Jerome Pasion  <jerome.pasion@digia.com>
+
+        [Qt] Doc: Fixing Qt WebKit reference documentation.
+
+        Reviewed by Simon Hausmann.
+
+        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
+
+        * UIProcess/API/qt/qquickwebview.cpp:
+
 2012-12-13  Jussi Kukkonen  <jussi.kukkonen@intel.com>
 
         [EFL][GTK] Don't call deprecated g_type_init when glib => 2.35
 2012-12-13  Jussi Kukkonen  <jussi.kukkonen@intel.com>
 
         [EFL][GTK] Don't call deprecated g_type_init when glib => 2.35
index 80baa96..f9bcd59 100644 (file)
@@ -1460,6 +1460,12 @@ QQuickWebPage* QQuickWebViewExperimental::page()
         }
     }
     \endcode
         }
     }
     \endcode
+
+    \section1 Examples
+
+    There are several Qt WebKit examples located in the
+    \l{Qt WebKit Examples} page.
+
 */
 
 
 */
 
 
index 4522d7e..f10ef27 100644 (file)
@@ -1,10 +1,29 @@
-include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
 include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
 
 include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
 
-project     = qtwebkit
+project     = QtWebKit
 description = "Qt WebKit API Documentation"
 version     = 5.0.0
 
 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
+qhp.QtWebKit.virtualFolder  = qtwebkit
+
+# For listing child nodes in Qt Creator or Assistant.
+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
 exampledirs = WebKit/qt/docs
 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
 exampledirs = WebKit/qt/docs