summaryrefslogtreecommitdiffstats
path: root/src/webengine/doc
diff options
context:
space:
mode:
authorAllan Sandfeld Jensen <allan.jensen@theqtcompany.com>2016-01-12 11:32:02 +0100
committerAllan Sandfeld Jensen <allan.jensen@theqtcompany.com>2016-01-12 11:35:45 +0100
commita077399f4c17f57e911334867c918cc6ddeb15fc (patch)
treec8e4d326d7a074e9d16b68399ecc5f728f8533fe /src/webengine/doc
parent3d698f5de377bde2293e222536bc50171cfdf1b8 (diff)
parent12dd6ff845656eb625e2ee3d0e73392bc2c61983 (diff)
Merge branch '5.6' into dev
Diffstat (limited to 'src/webengine/doc')
-rw-r--r--src/webengine/doc/qtwebengine.qdocconf1
-rw-r--r--src/webengine/doc/src/external-resources.qdoc10
-rw-r--r--src/webengine/doc/src/qtwebengine-modules.qdoc3
-rw-r--r--src/webengine/doc/src/qtwebengine-overview.qdoc11
-rw-r--r--src/webengine/doc/src/qtwebengine-platform-notes.qdoc45
-rw-r--r--src/webengine/doc/src/qtwebengine-qmlmodule.qdoc2
-rw-r--r--src/webengine/doc/src/webengineview.qdoc4
7 files changed, 69 insertions, 7 deletions
diff --git a/src/webengine/doc/qtwebengine.qdocconf b/src/webengine/doc/qtwebengine.qdocconf
index 01485dc56..02f9a9ffd 100644
--- a/src/webengine/doc/qtwebengine.qdocconf
+++ b/src/webengine/doc/qtwebengine.qdocconf
@@ -39,6 +39,7 @@ tagfile = ../../../doc/qtwebengine/qtwebengine.tags
depends += qtcore \
qtgui \
+ qtnetwork \
qtqml \
qtquick \
qtquickcontrols \
diff --git a/src/webengine/doc/src/external-resources.qdoc b/src/webengine/doc/src/external-resources.qdoc
index 2987f1fca..38d8b637b 100644
--- a/src/webengine/doc/src/external-resources.qdoc
+++ b/src/webengine/doc/src/external-resources.qdoc
@@ -40,6 +40,16 @@
\title Chrome console API
*/
+/*!
+ \externalpage http://ffmpeg.org/
+ \title FFmpeg
+*/
+
+/*!
+ \externalpage http://www.openh264.org/
+ \title OpenH264
+*/
+
/*
This prevents autolinking of each occurrence of 'WebEngine'
To link to the WebEngine QML type, use explicit linking:
diff --git a/src/webengine/doc/src/qtwebengine-modules.qdoc b/src/webengine/doc/src/qtwebengine-modules.qdoc
index 8530f5d01..451165b26 100644
--- a/src/webengine/doc/src/qtwebengine-modules.qdoc
+++ b/src/webengine/doc/src/qtwebengine-modules.qdoc
@@ -42,4 +42,7 @@
\section2 Qt WebEngineWidgets Module
\generatelist {classesbymodule QtWebEngineWidgets}
+
+ \section2 Qt WebEngine Module
+ \generatelist {classesbymodule QtWebEngine}
*/
diff --git a/src/webengine/doc/src/qtwebengine-overview.qdoc b/src/webengine/doc/src/qtwebengine-overview.qdoc
index 8be4adda0..ca60fedc2 100644
--- a/src/webengine/doc/src/qtwebengine-overview.qdoc
+++ b/src/webengine/doc/src/qtwebengine-overview.qdoc
@@ -127,6 +127,17 @@
}
\endqml
+ \section1 Managing Certificates
+
+ Qt WebEngine uses its own network stack, and therefore QSslConfiguration is not used to
+ open SSL connections. Instead, Qt WebEngine uses the root CA certificates from the operating
+ system to validate the peer's certificate.
+
+ The \l{WebEngineCertificateError::error} and \l{QWebEngineCertificateError::Error} enumerations
+ provide information about the types of certificate errors that might occur. The errors can be
+ handled by using the WebEngineView::certificateError QML method or by reimplementing the
+ QWebEnginePage::certificateError function.
+
\section1 Using WebEngine Core
Qt WebEngine Core provides an API shared by Qt WebEngine and Qt WebEngine Widgets for handling
diff --git a/src/webengine/doc/src/qtwebengine-platform-notes.qdoc b/src/webengine/doc/src/qtwebengine-platform-notes.qdoc
index 0898a72fc..555db2a2d 100644
--- a/src/webengine/doc/src/qtwebengine-platform-notes.qdoc
+++ b/src/webengine/doc/src/qtwebengine-platform-notes.qdoc
@@ -50,11 +50,31 @@
\li OS X: Xcode version 5.1 or later
\endlist
- \section1 Adobe Flash Player Plugin Support
+ \section1 Pepper Plugin API Support
- Qt WebEngine supports the Adobe Flash player plugin that is a Pepper Plugin API (PPAPI)
- plugin. The plugin must be installed in one of the following locations, depending on the
- platform:
+ Qt WebEngine supports loading Pepper Plugin API (PPAPI) plugins. The plugins must be loaded
+ manually using the Chromium command line syntax with the \c --register-pepper-plugins argument.
+ The argument value is a list of entries, separated by commas, that contain the file path and
+ one or several MIME types, separated by semicolons:
+
+ \code
+ <file-path-plugin1>;<mime-type-plugin1>,<file-path-plugin2>;<mime-type1-plugin2>;<mime-type2-plugin2>
+ \endcode
+
+ For example:
+
+ \code
+ --register-pepper-plugins="libppapi_example.so;application/x-ppapi-example"
+ \endcode
+
+ The MIME type is important because it determines which embeds the plugin is used for.
+
+ This process has been automated for the Adobe Flash Player Plugin.
+
+ \section2 Adobe Flash Player Plugin Support
+
+ The Adobe Flash player plugin can be loaded automatically if it is installed in one of the
+ following locations, depending on the platform:
\list
\li Windows
@@ -79,4 +99,21 @@
\code
--ppapi-flash-path=./libpepflashplayer.so
\endcode
+
+ \section1 Audio and Video Codec Support
+
+ Qt WebEngine supports the MPEG-4 Part 14 (MP4) file format only if the required proprietary
+ audio and video codecs, such as H.264 and MPEG layer-3 (MP3), have been enabled. Proprietary
+ codecs can be enabled by passing the following option to qmake:
+
+ \code
+ qmake WEBENGINE_CONFIG += use_proprietary_codecs
+ \endcode
+
+ \warning When distributing proprietary codec libraries, you must acquire licenses for them.
+
+ \l FFmpeg is a cross-platform solution to record, convert, and stream audio and video. It can
+ be configured for use with several codecs, which rises licensing issues during distribution
+ with the codec libraries. For some codecs, open source implementations, such as \l {OpenH264},
+ are available.
*/
diff --git a/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc b/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc
index 89ff6f0b3..7fcddb373 100644
--- a/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc
+++ b/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc
@@ -24,7 +24,7 @@
*/
/*!
- \qmlmodule QtWebEngine 1.1
+ \qmlmodule QtWebEngine 1.2
\title Qt WebEngine QML Types
\brief Provides QML types for rendering web content within a QML application
\ingroup qtwebengine-qmlmodules
diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc
index 49717ae50..39441228d 100644
--- a/src/webengine/doc/src/webengineview.qdoc
+++ b/src/webengine/doc/src/webengineview.qdoc
@@ -26,7 +26,7 @@
/*!
\qmltype WebEngineView
\instantiates QQuickWebEngineView
- \inqmlmodule QtWebEngine 1.1
+ \inqmlmodule QtWebEngine
\since QtWebEngine 1.0
\brief A WebEngineView renders web content within a QML application.
*/
@@ -698,7 +698,7 @@
/*!
\qmltype WebEngineFullScreenRequest
\instantiates QQuickWebEngineFullScreenRequest
- \inqmlmodule QtWebEngine 1.1
+ \inqmlmodule QtWebEngine
\since QtWebEngine 1.1
\brief A utility type for the WebEngineView::fullScreenRequested() signal.