summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2012-12-11 18:15:48 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-12-12 18:26:45 +0100
commita2d8aa1b462b709c9a18292eb57971eaaeb18dbe (patch)
treea7f8941dc990f712e54750ff14d73cff2b2b32a5 /doc
parente88665589b06aa0d87a5185cc780ed767cff0f70 (diff)
downloadqtwebkit-examples-a2d8aa1b462b709c9a18292eb57971eaaeb18dbe.tar.gz
Doc: Added documentation for the WebKit Widget examples
- Moved the qdoc files from the qtdoc repository - Added group pages for QML and QWidget-based examples - Added an index page - Updated the qhp details in the qdocconf Change-Id: I5f79fb1aedbfc3bcb42c84ac774ea1c4bd3a9036 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/images/webkit-examples.pngbin0 -> 19323 bytes
-rw-r--r--doc/qtwebkitexamples.qdocconf21
-rw-r--r--doc/src/qtwebkit-examples.qdoc70
3 files changed, 88 insertions, 3 deletions
diff --git a/doc/images/webkit-examples.png b/doc/images/webkit-examples.png
new file mode 100644
index 0000000..23ddf1c
--- /dev/null
+++ b/doc/images/webkit-examples.png
Binary files differ
diff --git a/doc/qtwebkitexamples.qdocconf b/doc/qtwebkitexamples.qdocconf
index 3b2a93b..b88a143 100644
--- a/doc/qtwebkitexamples.qdocconf
+++ b/doc/qtwebkitexamples.qdocconf
@@ -16,9 +16,20 @@ qhp.QtWebKitExamples.namespace = org.qt-project.qtwebkit-examples.500
qhp.QtWebKitExamples.indexTitle = Qt WebKit Examples
qhp.QtWebKitExamples.virtualFolder = qtwebkit-examples
qhp.QtWebKitExamples.indexRoot =
-qhp.QtQml.filterAttributes = qtwebkit-examples 5.0.0 qtrefdoc
-qhp.QtQml.customFilters.Qt.name = QtWebKit 5.0.0
-qhp.QtQml.customFilters.Qt.filterAttributes = qtwebkit-examples 5.0.0
+qhp.QtWebKitExamples.filterAttributes = qtwebkit-examples 5.0.0 qtrefdoc
+qhp.QtWebKitExamples.customFilters.Qt.name = QtWebKit 5.0.0
+qhp.QtWebKitExamples.customFilters.Qt.filterAttributes = qtwebkit-examples 5.0.0
+
+qhp.QtWebKitExamples.subprojects = webkitwidgetsexamples webkitexamples
+qhp.QtWebKitExamples.subprojects.webkitwidgetsexamples.title = Qt WebKit Widgets Examples
+qhp.QtWebKitExamples.subprojects.webkitwidgetsexamples.indexTitle = Qt WebKit Widgets Examples and Demos
+qhp.QtWebKitExamples.subprojects.webkitwidgetsexamples.selectors = class fake:headerfile
+qhp.QtWebKitExamples.subprojects.webkitwidgetsexamples.sortPages = true
+
+qhp.QtWebKitExamples.subprojects.webkitexamples.title = Qt WebKit Examples
+qhp.QtWebKitExamples.subprojects.webkitexamples.indexTitle = Qt WebKit Examples and Demos
+qhp.QtWebKitExamples.subprojects.webkitexamples.selectors = class fake:headerfile
+qhp.QtWebKitExamples.subprojects.webkitexamples.sortPages = true
outputdir = $QT_INSTALL_DOCS/qtwebkitexamples
@@ -26,3 +37,7 @@ depends += qtcore qtwidgets qtquick qtgui qtscript qtdoc qtxml qtwebkitwidgets q
exampledirs = ../examples/webkitwidgets \
../examples/webkitqml
+
+sourcedirs = src
+
+imagedirs = images
diff --git a/doc/src/qtwebkit-examples.qdoc b/doc/src/qtwebkit-examples.qdoc
new file mode 100644
index 0000000..e17c21b
--- /dev/null
+++ b/doc/src/qtwebkit-examples.qdoc
@@ -0,0 +1,70 @@
+****************************************************************************
+**
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** 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 Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/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$
+**
+****************************************************************************/
+
+/*!
+ \page qtwebkitexamples-index.html
+ \title Qt WebKit Examples
+ \brief Provides examples demonstrating the WebKit features
+
+ Qt WebKit Examples provide QML-based examples that demonstrate the WebKit2
+ features, and also QWidget-based examples that demonstrate the Webkit1
+ features.
+
+ \section1 WebKit2 Examples
+ \annotatedlist webkit-qmlexamples
+
+ \section1 WebKit1 Examples
+ \annotatedlist webkit-widgetexamples
+
+ \sa \l{Qt Webkit}
+*/
+
+/*!
+ \group webkit-widgetexamples
+ \title Qt WebKit Widgets Examples
+ \brief Examples demonstrating the webkit widgets usage
+ \ingroup all-examples
+
+ \image webkit-examples.png WebKit
+
+ Qt provides an integrated Web browser component based on WebKit, the popular
+ open source browser engine.
+
+ These examples and demonstrations show a range of different uses for WebKit,
+ from displaying Web pages within a Qt user interface to an implementation of
+ a basic function Web browser.
+*/
+
+/*!
+ \group webkit-qmlexamples
+ \title Qt Webkit Examples and Demos
+ \brief QML examples demonstrating Webkit features
+ \ingroup all-examples
+
+ These examples demonstrate how to embed a WebView within a Qt Quick
+ application.
+*/