Commit a659a309 authored by Topi Reinio's avatar Topi Reinio Committed by Jani Heikkinen
Browse files

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: default avatarJocelyn Turcotte <jocelyn.turcotte@digia.com>
Reviewed-by: default avatarVenugopal Shivashankar <venugopal.shivashankar@digia.com>
Showing with 55 additions and 2 deletions
examples/webengine/quicknanobrowser/doc/images/quicknanobrowser-demo.jpg

29.4 KB

/****************************************************************************
**
** 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
*/
/**************************************************************************** /****************************************************************************
** **
** 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 ** Contact: http://www.qt-project.org/legal
** **
** This file is part of the documentation of the Qt Toolkit. ** This file is part of the documentation of the Qt Toolkit.
...@@ -28,10 +28,13 @@ ...@@ -28,10 +28,13 @@
/*! /*!
\example browser \example browser
\title WebEngine Tab Browser Example \title WebEngine Tab Browser Example
\ingroup webengine-widgetexamples
\brief The QtWebKit browser example ported to use QtWebEngine \brief The QtWebKit browser example ported to use QtWebEngine
The Tab Browser example shows the \l{Qt WebEngine Widgets} module in action, The Tab Browser example shows the \l{Qt WebEngine Widgets} module in action,
providing a little Web browser application with support for tabs. providing a little Web browser application with support for tabs.
\image browser-demo.png \image browser-demo.png
\include examples-run.qdocinc
*/ */
/**************************************************************************** /****************************************************************************
** **
** 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 ** Contact: http://www.qt-project.org/legal
** **
** This file is part of the documentation of the Qt Toolkit. ** This file is part of the documentation of the Qt Toolkit.
...@@ -28,6 +28,7 @@ ...@@ -28,6 +28,7 @@
/*! /*!
\example fancybrowser \example fancybrowser
\title WebEngine Fancy Browser Example \title WebEngine Fancy Browser Example
\ingroup webengine-widgetexamples
\brief Demonstrates how to use browse web and manipulate content \brief Demonstrates how to use browse web and manipulate content
\brief The Fancy Browser example shows how to use JQuery with QtWebEngine to \brief The Fancy Browser example shows how to use JQuery with QtWebEngine to
...@@ -40,6 +41,8 @@ ...@@ -40,6 +41,8 @@
evaluate the jQuery JavaScript code. A QMainWindow with a QWebEngineView evaluate the jQuery JavaScript code. A QMainWindow with a QWebEngineView
as central widget builds up the browser itself. as central widget builds up the browser itself.
\include examples-run.qdocinc
\section1 MainWindow Class Definition \section1 MainWindow Class Definition
The \c MainWindow class inherits QMainWindow. It implements a number of The \c MainWindow class inherits QMainWindow. It implements a number of
......
...@@ -117,6 +117,12 @@ ...@@ -117,6 +117,12 @@
\li \l {Qt WebEngine Widgets C++ Classes} \li \l {Qt WebEngine Widgets C++ Classes}
\endlist \endlist
\section1 Examples
\list
\li \l {Qt WebEngine Widgets Examples}
\endlist
\section1 License Information \section1 License Information
This is a snapshot of the integration of Chromium into Qt. This is a snapshot of the integration of Chromium into Qt.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment