summaryrefslogtreecommitdiff
path: root/examples/webkitwidgets/framecapture/doc/src
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 /examples/webkitwidgets/framecapture/doc/src
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 'examples/webkitwidgets/framecapture/doc/src')
-rw-r--r--examples/webkitwidgets/framecapture/doc/src/webkit-framecapture.qdoc46
1 files changed, 46 insertions, 0 deletions
diff --git a/examples/webkitwidgets/framecapture/doc/src/webkit-framecapture.qdoc b/examples/webkitwidgets/framecapture/doc/src/webkit-framecapture.qdoc
new file mode 100644
index 0000000..b616011
--- /dev/null
+++ b/examples/webkitwidgets/framecapture/doc/src/webkit-framecapture.qdoc
@@ -0,0 +1,46 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \example webkit/framecapture
+ \title WebKit Frame Capture Example
+ \brief Demonstrates how to capture frame in the web page
+ \ingroup webkit-widgetexamples
+
+ The Frame Capture example shows how to use the WebKit browser engine to
+ obtain images of frames in a Web page.
+
+ This example is designed to be run from the command-line. Run the
+ example with a URL and the output file name as arguments. The application
+ captures the frame contents in a PNG image with the file name your
+ specified.
+
+ The following output image is generated by the application, if you pass the
+ URL, www.qt-project.org.
+
+ \image framecapture-example.png
+*/