diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2021-06-30 14:04:31 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2021-07-01 14:50:42 +0200 |
| commit | c248844b3b8ee004800606d1a6c6e6d6bee31738 (patch) | |
| tree | e5c9d05a1f59f725d79279f8dbc5cb75136d118a /src/webenginequick/api/qquickwebenginesettings.cpp | |
| parent | 57eb73f933e3c1499a969b2023073c3c01bb9a1f (diff) | |
| download | qtwebengine-c248844b3b8ee004800606d1a6c6e6d6bee31738.tar.gz | |
Doc: Fix documentation issues for Qt WebEngine
API and documentation changes since 5.15 caused multiple warnings from
QDoc; this change addresses most of them. Some warnings indicate
missing documentation, those issues still remain.
Pick-to: 6.2
Change-Id: I96be38b7daac37a7e35c149b4b3ec3f18c4415c9
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'src/webenginequick/api/qquickwebenginesettings.cpp')
| -rw-r--r-- | src/webenginequick/api/qquickwebenginesettings.cpp | 31 |
1 files changed, 12 insertions, 19 deletions
diff --git a/src/webenginequick/api/qquickwebenginesettings.cpp b/src/webenginequick/api/qquickwebenginesettings.cpp index f1fd00b8d..aba47dfe6 100644 --- a/src/webenginequick/api/qquickwebenginesettings.cpp +++ b/src/webenginequick/api/qquickwebenginesettings.cpp @@ -54,7 +54,7 @@ QQuickWebEngineSettings::QQuickWebEngineSettings(QQuickWebEngineSettings *parent /*! \qmltype WebEngineSettings - \instantiates QQuickWebEngineSettings + //! \instantiates QQuickWebEngineSettings \inqmlmodule QtWebEngine \since QtWebEngine 1.1 \brief Allows configuration of browser properties and attributes. @@ -73,22 +73,6 @@ QQuickWebEngineSettings::~QQuickWebEngineSettings() { } /*! - \enum QQuickWebEngineSettings::UnknownUrlSchemePolicy - \since WebEngine 1.7 - - This enum describes how navigation requests to URLs with unknown schemes are handled. - - \value DisallowUnknownUrlSchemes - Disallows all navigation requests to URLs with unknown schemes. - \value AllowUnknownUrlSchemesFromUserInteraction - Allows navigation requests to URLs with unknown schemes that are issued from - user-interaction (like a mouse-click), whereas other navigation requests (for example - from JavaScript) are suppressed. - \value AllowAllUnknownUrlSchemes - Allows all navigation requests to URLs with unknown schemes. -*/ - -/*! \qmlproperty bool WebEngineSettings::autoLoadImages Automatically loads images on web pages. @@ -493,11 +477,20 @@ ASSERT_ENUMS_MATCH(QQuickWebEngineSettings::AllowUnknownUrlSchemesFromUserIntera ASSERT_ENUMS_MATCH(QQuickWebEngineSettings::AllowAllUnknownUrlSchemes, QWebEngineSettings::AllowAllUnknownUrlSchemes) /*! - \qmlproperty QWebEngineSettings::UnknownUrlSchemePolicy WebEngineSettings::unknownUrlSchemePolicy + \qmlproperty enumeration WebEngineSettings::unknownUrlSchemePolicy \since QtWebEngine 1.7 Specifies how navigation requests to URLs with unknown schemes are handled. - Default is \l{QWebEngineSettings::UnknownUrlSchemePolicy}{WebEngineSettings.AllowUnknownUrlSchemesFromUserInteraction}. + \value WebEngineSettings.DisallowUnknownUrlSchemes + Disallows all navigation requests to URLs with unknown schemes. + \value WebEngineSettings.AllowUnknownUrlSchemesFromUserInteraction + Allows navigation requests to URLs with unknown schemes that are issued from + user-interaction (like a mouse-click), whereas other navigation requests (for example + from JavaScript) are suppressed. + \value WebEngineSettings.AllowAllUnknownUrlSchemes + Allows all navigation requests to URLs with unknown schemes. + + Default value is \c {WebEngineSettings.AllowUnknownUrlSchemesFromUserInteraction}. */ QQuickWebEngineSettings::UnknownUrlSchemePolicy QQuickWebEngineSettings::unknownUrlSchemePolicy() const { |