summaryrefslogtreecommitdiff
path: root/Source/WebKit/qt/docs
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2012-12-13 14:57:54 +0100
committerSimon Hausmann <simon.hausmann@digia.com>2012-12-13 16:03:10 +0100
commit5423dd08373bb58f0d469d52cde49f128b49ddf2 (patch)
tree8617028005b29318ef727f087bd137dc920f636d /Source/WebKit/qt/docs
parent3d99c8c119a6f45a9add920943bafd34b111c7d0 (diff)
downloadqtwebkit-5423dd08373bb58f0d469d52cde49f128b49ddf2.tar.gz
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>
Diffstat (limited to 'Source/WebKit/qt/docs')
-rw-r--r--Source/WebKit/qt/docs/qtwebkit.qdoc62
1 files changed, 46 insertions, 16 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
*/
-