diff options
author | Topi Reinio <topi.reinio@digia.com> | 2014-11-14 11:09:42 +0100 |
---|---|---|
committer | Jani Heikkinen <jani.heikkinen@theqtcompany.com> | 2014-11-17 12:53:23 +0100 |
commit | a659a309fa6f280e657458123c64a401707a9db0 (patch) | |
tree | 113b7e4c3cd2d7aea7fa0da2928ed8ad68013e42 | |
parent | 8f09f9918b10d40b2823bdfe24aa82908aa37990 (diff) |
Doc: Fix issues related to example docs
- Add documentation for Quick Nano Browser
- Add all examples to the correct group
- Add instructions to run the examples
- Qt WebEngine Widgets index page: Add examples section
Task-number: QTBUG-42668
Change-Id: Ie60f8708336b9c147d0c22afb555fe87287deddc
Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
-rw-r--r-- | examples/webengine/quicknanobrowser/doc/images/quicknanobrowser-demo.jpg | bin | 0 -> 30156 bytes | |||
-rw-r--r-- | examples/webengine/quicknanobrowser/doc/src/quicknanobrowser.qdoc | 41 | ||||
-rw-r--r-- | examples/webenginewidgets/browser/doc/src/browser.qdoc | 5 | ||||
-rw-r--r-- | examples/webenginewidgets/fancybrowser/doc/src/fancybrowser.qdoc | 5 | ||||
-rw-r--r-- | src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc | 6 |
5 files changed, 55 insertions, 2 deletions
diff --git a/examples/webengine/quicknanobrowser/doc/images/quicknanobrowser-demo.jpg b/examples/webengine/quicknanobrowser/doc/images/quicknanobrowser-demo.jpg Binary files differnew file mode 100644 index 000000000..12693bb0f --- /dev/null +++ b/examples/webengine/quicknanobrowser/doc/images/quicknanobrowser-demo.jpg diff --git a/examples/webengine/quicknanobrowser/doc/src/quicknanobrowser.qdoc b/examples/webengine/quicknanobrowser/doc/src/quicknanobrowser.qdoc new file mode 100644 index 000000000..e42637073 --- /dev/null +++ b/examples/webengine/quicknanobrowser/doc/src/quicknanobrowser.qdoc @@ -0,0 +1,41 @@ +/**************************************************************************** +** +** Copyright (C) 2014 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 quicknanobrowser + \title WebEngine Quick Nano Browser + \ingroup webengine-examples + \brief A web browser implemented using the WebEngineView QML type. + + The Quick Nano Browser demo shows the \l{Qt WebEngine} module in action, + providing a little QML web browser with support for tabs and keyboard + shortcuts. + + \image quicknanobrowser-demo.jpg + + \include examples-run.qdocinc +*/ diff --git a/examples/webenginewidgets/browser/doc/src/browser.qdoc b/examples/webenginewidgets/browser/doc/src/browser.qdoc index a8208184d..f4a51518b 100644 --- a/examples/webenginewidgets/browser/doc/src/browser.qdoc +++ b/examples/webenginewidgets/browser/doc/src/browser.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 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. @@ -28,10 +28,13 @@ /*! \example browser \title WebEngine Tab Browser Example + \ingroup webengine-widgetexamples \brief The QtWebKit browser example ported to use QtWebEngine The Tab Browser example shows the \l{Qt WebEngine Widgets} module in action, providing a little Web browser application with support for tabs. \image browser-demo.png + + \include examples-run.qdocinc */ diff --git a/examples/webenginewidgets/fancybrowser/doc/src/fancybrowser.qdoc b/examples/webenginewidgets/fancybrowser/doc/src/fancybrowser.qdoc index 60652c69a..f4b5321a1 100644 --- a/examples/webenginewidgets/fancybrowser/doc/src/fancybrowser.qdoc +++ b/examples/webenginewidgets/fancybrowser/doc/src/fancybrowser.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 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. @@ -28,6 +28,7 @@ /*! \example fancybrowser \title WebEngine Fancy Browser Example + \ingroup webengine-widgetexamples \brief Demonstrates how to use browse web and manipulate content \brief The Fancy Browser example shows how to use JQuery with QtWebEngine to @@ -40,6 +41,8 @@ evaluate the jQuery JavaScript code. A QMainWindow with a QWebEngineView as central widget builds up the browser itself. + \include examples-run.qdocinc + \section1 MainWindow Class Definition The \c MainWindow class inherits QMainWindow. It implements a number of diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc index 3f6e888f3..d440dd06a 100644 --- a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc +++ b/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc @@ -117,6 +117,12 @@ \li \l {Qt WebEngine Widgets C++ Classes} \endlist + \section1 Examples + + \list + \li \l {Qt WebEngine Widgets Examples} + \endlist + \section1 License Information This is a snapshot of the integration of Chromium into Qt. |