Merge branch '5.5' into 5.6

Change-Id: Idafba4d47393638cfc72fd02be092b67bb8cbd8c

4 files changed, 72 insertions, 62 deletions

diff --git a/src/webenginewidgets/api/qwebenginecertificateerror.cpp b/src/webenginewidgets/api/qwebenginecertificateerror.cpp
index e320552bf..f35175c67 100644
--- a/src/webenginewidgets/api/qwebenginecertificateerror.cpp
+++ b/src/webenginewidgets/api/qwebenginecertificateerror.cpp
@@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE
     \since 5.4
     \inmodule QtWebEngineWidgets
 
-    QWebEngineCertificateError holds known information about a certificate error to be used to determine whether to allow it or not, and to be reported to the user.
+    Provides information about a certificate error.
 */
 
 class QWebEngineCertificateErrorPrivate {
@@ -82,7 +82,8 @@ QWebEngineCertificateError::~QWebEngineCertificateError()
 
     This enum describes the type of certificate error encountered.
 
-    \value SslPinnedKeyNotInCertificateChain The certificate did not match the built-in public key pins for the host name.
+    \value SslPinnedKeyNotInCertificateChain The certificate did not match the built-in public keys
+            pinned for the host name.
     \value CertificateCommonNameInvalid The certificate's common name did not match the host name.
     \value CertificateDateInvalid The certificate is not valid at the current date and time.
     \value CertificateAuthorityInvalid The certificate is not signed by a trusted authority.
diff --git a/src/webenginewidgets/api/qwebenginedownloaditem.cpp b/src/webenginewidgets/api/qwebenginedownloaditem.cpp
index 7df044e66..6c9413280 100644
--- a/src/webenginewidgets/api/qwebenginedownloaditem.cpp
+++ b/src/webenginewidgets/api/qwebenginedownloaditem.cpp
@@ -153,7 +153,7 @@ void QWebEngineDownloadItem::cancel()
 }
 
 /*!
-    Returns the download item's id.
+    Returns the download item's ID.
 */
 
 quint32 QWebEngineDownloadItem::id() const
@@ -190,13 +190,14 @@ quint32 QWebEngineDownloadItem::id() const
 /*!
     \enum QWebEngineDownloadItem::DownloadState
 
-    This enum describes the state in which the download is in.
+    This enum describes the state of the download:
 
-    \value DownloadRequested The download has been requested, but has not been accepted yet.
-    \value DownloadInProgress The download is in progress.
-    \value DownloadCompleted The download completed successfully.
-    \value DownloadCancelled The download has been cancelled.
-    \value DownloadInterrupted The download has been interrupted (by the server or because of lost connectivity).
+    \value DownloadRequested Download has been requested, but has not been accepted yet.
+    \value DownloadInProgress Download is in progress.
+    \value DownloadCompleted Download completed successfully.
+    \value DownloadCancelled Download has been cancelled.
+    \value DownloadInterrupted Download has been interrupted (by the server or because of lost
+            connectivity).
 */
 
 /*!
@@ -212,9 +213,9 @@ QWebEngineDownloadItem::DownloadState QWebEngineDownloadItem::state() const
 }
 
 /*!
-    Returns the download's total size in bytes.
+    Returns the the total amount of data to download in bytes.
 
-    -1 means the size is unknown.
+    \c -1 means the size is unknown.
 */
 
 qint64 QWebEngineDownloadItem::totalBytes() const
@@ -224,9 +225,9 @@ qint64 QWebEngineDownloadItem::totalBytes() const
 }
 
 /*!
-    Returns the download's bytes that have been received so far.
+    Returns the amount of data in bytes that has been downloaded so far.
 
-    -1 means the size is unknown.
+    \c -1 means the size is unknown.
 */
 
 qint64 QWebEngineDownloadItem::receivedBytes() const
@@ -236,7 +237,7 @@ qint64 QWebEngineDownloadItem::receivedBytes() const
 }
 
 /*!
-    Returns the download's origin url.
+    Returns the download's origin URL.
 */
 
 QUrl QWebEngineDownloadItem::url() const
@@ -246,7 +247,7 @@ QUrl QWebEngineDownloadItem::url() const
 }
 
 /*!
-    Returns the download's full target path where it is being downloaded to.
+    Returns the full target path where data is being downloaded to.
 
     The path includes the file name. The default suggested path is the standard download location
     and file name is deduced not to overwrite already existing files.
@@ -259,11 +260,11 @@ QString QWebEngineDownloadItem::path() const
 }
 
 /*!
-    Sets the download's full target path, where the file should be downloaded to.
+    Sets the full target path to download the file to.
 
     The \a path should also include the file name. The download path can only be set in response
     to the QWebEngineProfile::downloadRequested() signal before the download is accepted.
-    Past that point this function has no effect on the download item's state.
+    Past that point, this function has no effect on the download item's state.
 */
 void QWebEngineDownloadItem::setPath(QString path)
 {
diff --git a/src/webenginewidgets/api/qwebenginesettings.cpp b/src/webenginewidgets/api/qwebenginesettings.cpp
index 1c45095b8..430d64185 100644
--- a/src/webenginewidgets/api/qwebenginesettings.cpp
+++ b/src/webenginewidgets/api/qwebenginesettings.cpp
@@ -99,6 +99,11 @@ QWebEngineSettings *QWebEngineSettings::globalSettings()
 }
 #endif
 
+/*!
+    Returns the default settings for the web engine page.
+
+    \sa globalSettings()
+*/
 QWebEngineSettings *QWebEngineSettings::defaultSettings()
 {
     return QWebEngineProfile::defaultProfile()->settings();
diff --git a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
index bb5217013..c65c37f55 100644
--- a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
@@ -28,13 +28,15 @@
 
     Any setting changed on the default object is automatically applied to all
     QWebEnginePage instances where the particular setting is not overridden already.
+
+    \sa defaultSettings()
 */
 
 /*!
     \class QWebEngineSettings
     \since 5.4
     \brief The QWebEngineSettings class provides an object to store the settings used
-    by QWebEnginePage
+    by QWebEnginePage.
 
     \inmodule QtWebEngineWidgets
 
@@ -44,10 +46,9 @@
     globalSettings().
 
     QWebEngineSettings allows configuration of browser properties, such as font sizes and
-    families, the location of a custom style sheet, and generic attributes like
-    JavaScript and plugins. Individual attributes are set using the setAttribute()
-    function. The \l{QWebEngineSettings::WebAttribute}{WebAttribute} enum further describes
-    each attribute.
+    families, the location of a custom style sheet, and generic attributes, such as JavaScript
+    support. Individual attributes are set using the setAttribute() function. The
+    \l{QWebEngineSettings::WebAttribute}{WebAttribute} enum further describes each attribute.
 
     \sa QWebEnginePage::settings(), QWebEngineView::settings()
 */
@@ -70,11 +71,11 @@
 /*!
     \enum QWebEngineSettings::FontSize
 
-    This enum describes the font sizes configurable through QWebEngineSettings.
+    This enum describes the font sizes configurable through QWebEngineSettings:
 
     \value MinimumFontSize The hard minimum font size.
     \value MinimumLogicalFontSize The minimum logical font size that is applied
-        when zooming out with QWebEngineFrame::setTextSizeMultiplier().
+        when zooming out.
     \value DefaultFontSize The default font size for regular text.
     \value DefaultFixedFontSize The default font size for fixed-pitch text.
 */
@@ -82,40 +83,42 @@
 /*!
     \enum QWebEngineSettings::WebAttribute
 
-    This enum describes various attributes that are configurable through QWebEngineSettings.
-
-    \value AutoLoadImages Specifies whether images are automatically loaded in
-        web pages. This is enabled by default.
-    \value JavascriptEnabled Enables or disables the running of JavaScript
-        programs. This is enabled by default
-    \value JavascriptCanOpenWindows Specifies whether JavaScript programs
-        can open new windows. This is enabled by default.
-    \value JavascriptCanAccessClipboard Specifies whether JavaScript programs
-        can read or write to the clipboard. This is disabled by default.
-    \value LinksIncludedInFocusChain Specifies whether hyperlinks should be
-        included in the keyboard focus chain. This is enabled by default.
-    \value LocalStorageEnabled Specifies whether support for the HTML 5
-        local storage feature is enabled or not. This is enabled by default.
-    \value LocalContentCanAccessRemoteUrls Specifies whether locally loaded documents are
-        allowed to access remote urls. This is disabled by default. For more information
-        about security origins and local vs. remote content see QWebEngineSecurityOrigin.
-    \value XSSAuditingEnabled Specifies whether load requests should be monitored for cross-site
-        scripting attempts. Suspicious scripts will be blocked and reported in the inspector's
-        JavaScript console. Enabling this feature might have an impact on performance
-        and it is disabled by default.
-    \value SpatialNavigationEnabled Enables or disables the Spatial Navigation
-        feature, which consists in the ability to navigate between focusable
-        elements in a Web page, such as hyperlinks and form controls, by using
-        Left, Right, Up and Down arrow keys. For example, if a user presses the
-        Right key, heuristics determine whether there is an element they might be
-        trying to reach towards the right and which element they probably want.
-        This is disabled by default.
-    \value LocalContentCanAccessFileUrls Specifies whether locally loaded documents are
-        allowed to access other local urls. This is enabled by default. For more information
-        about security origins and local vs. remote content see QWebEngineSecurityOrigin.
-    \value HyperlinkAuditingEnabled This setting enables support for the ping attribute for hyperlinks. It is disabled by default.
-    \value ScrollAnimatorEnabled This setting enables animated scrolling. It is disabled by default.
-    \value ErrorPageEnabled This setting enables built-in error pages of Chromium. It is enabled by default.
+    This enum type specifies settings for web pages:
+
+    \value  AutoLoadImages
+            Automatically loads images on web pages. Enabled by default.
+    \value  JavascriptEnabled
+            Enables the running of JavaScript programs. Enabled by default.
+    \value  JavascriptCanOpenWindows
+            Allows JavaScript programs to open new windows. Enabled by default.
+    \value  JavascriptCanAccessClipboard
+            Allows JavaScript programs to read from and write to the clipboard. Disabled by
+            default.
+    \value  LinksIncludedInFocusChain
+            Includes hyperlinks in the keyboard focus chain. Enabled by default.
+    \value  LocalStorageEnabled
+            Enables support for the HTML 5 local storage feature. Enabled by default.
+    \value  LocalContentCanAccessRemoteUrls
+            Allows locally loaded documents to access remote URLs. Disabled by default.
+    \value  XSSAuditingEnabled
+            Monitors load requests for cross-site scripting attempts. Suspicious scripts are blocked
+            and reported in the inspector's JavaScript console. Disabled by default, because it
+            might negatively affect performance.
+    \value  SpatialNavigationEnabled
+            Enables the Spatial Navigation feature, which means the ability to navigate between
+            focusable elements, such as hyperlinks and form controls, on a web page by using the
+            Left, Right, Up and Down arrow keys. For example, if a user presses the
+            Right key, heuristics determine whether there is an element they might be
+            trying to reach towards the right and which element they probably want.
+            Disabled by default.
+    \value  LocalContentCanAccessFileUrls
+            Allows locally loaded documents to access other local URLs. Enabled by default.
+    \value  HyperlinkAuditingEnabled
+            Enables support for the \c ping attribute for hyperlinks. Disabled by default.
+    \value  ScrollAnimatorEnabled
+            Enables animated scrolling. Disabled by default.
+    \value  ErrorPageEnabled
+            Enables displaying the built-in error pages of Chromium. Enabled by default.
     \value  PluginsEnabled
             Enables support for Pepper plugins, such as the Flash player. Disabled by default.
 */
@@ -142,9 +145,9 @@
     \fn void QWebEngineSettings::setDefaultTextEncoding(const QString& encoding)
     Specifies the default text encoding system.
 
-    The \a encoding, must be a string describing an encoding such as "utf-8",
-    "iso-8859-1", etc. If left empty a default value will be used. For a more
-    extensive list of encoding names see \l{QTextCodec}
+    The value of \a encoding must be a string describing an encoding such as "utf-8" or
+    "iso-8859-1". If left empty, a default value will be used. For a more
+    extensive list of encoding names see \l{QTextCodec}.
 
     \sa defaultTextEncoding()
 */
@@ -186,7 +189,7 @@
 /*!
     \fn bool QWebEngineSettings::testAttribute(WebAttribute attribute) const
 
-    Returns true if \a attribute is enabled; otherwise returns false.
+    Returns \c true if \a attribute is enabled; otherwise returns \c false.
 */
 
 /*!