Title: [292379] trunk/Source/WebKit
- Revision
- 292379
- Author
- ape...@igalia.com
- Date
- 2022-04-05 00:28:33 -0700 (Tue, 05 Apr 2022)
Log Message
[WPE] Mark "backend" parameters of web view constructors not nullable
https://bugs.webkit.org/show_bug.cgi?id=238734
Reviewed by Martin Robinson.
No new tests needed.
* UIProcess/API/wpe/WebKitWebViewWPE.cpp: Annotate web view constructors with (not nullable)
and while at it, fix documentation links, and improve the wording to better follow gi-docgen
copywriting style. Remove the mentions to the single process model, which is deprecated anyway.
Modified Paths
Diff
Modified: trunk/Source/WebKit/ChangeLog (292378 => 292379)
--- trunk/Source/WebKit/ChangeLog 2022-04-05 07:09:52 UTC (rev 292378)
+++ trunk/Source/WebKit/ChangeLog 2022-04-05 07:28:33 UTC (rev 292379)
@@ -1,3 +1,16 @@
+2022-04-05 Adrian Perez de Castro <ape...@igalia.com>
+
+ [WPE] Mark "backend" parameters of web view constructors not nullable
+ https://bugs.webkit.org/show_bug.cgi?id=238734
+
+ Reviewed by Martin Robinson.
+
+ No new tests needed.
+
+ * UIProcess/API/wpe/WebKitWebViewWPE.cpp: Annotate web view constructors with (not nullable)
+ and while at it, fix documentation links, and improve the wording to better follow gi-docgen
+ copywriting style. Remove the mentions to the single process model, which is deprecated anyway.
+
2022-04-04 Tim Horton <timothy_hor...@apple.com>
Stop generating WebKit system feature flags plists
Modified: trunk/Source/WebKit/UIProcess/API/wpe/WebKitWebViewWPE.cpp (292378 => 292379)
--- trunk/Source/WebKit/UIProcess/API/wpe/WebKitWebViewWPE.cpp 2022-04-05 07:09:52 UTC (rev 292378)
+++ trunk/Source/WebKit/UIProcess/API/wpe/WebKitWebViewWPE.cpp 2022-04-05 07:28:33 UTC (rev 292379)
@@ -62,15 +62,19 @@
/**
* webkit_web_view_new:
- * @backend: (transfer full): a #WebKitWebViewBackend
+ * @backend: (transfer full) (not nullable): wrapped WPE view backend which
+ * will determine the behaviour of the new [class@WebView].
*
- * Creates a new #WebKitWebView with the default #WebKitWebContext and
- * no #WebKitUserContentManager associated with it.
- * See also webkit_web_view_new_with_context(),
- * webkit_web_view_new_with_user_content_manager(), and
- * webkit_web_view_new_with_settings().
+ * Creates a new web view with a default configuration.
*
- * Returns: The newly created #WebKitWebView
+ * The new view will use the default [class@WebContext] and will not
+ * have an associated [class@UserContentManager].
+ *
+ * See also [id@webkit_web_view_new_with_context],
+ * [id@webkit_web_view_new_with_user_content_manager]), and
+ * [id@webkit_web_view_new_with_settings].
+ *
+ * Returns: The newly created web view.
*/
WebKitWebView* webkit_web_view_new(WebKitWebViewBackend* backend)
{
@@ -84,15 +88,19 @@
/**
* webkit_web_view_new_with_context:
- * @backend: (transfer full): a #WebKitWebViewBackend
- * @context: the #WebKitWebContext to be used by the #WebKitWebView
+ * @backend: (transfer full) (not nullable): wrapped WPE view backend which
+ * will determine the behaviour of the new [class@WebView].
+ * @context: the web context the new [class@WebView] will use.
*
- * Creates a new #WebKitWebView with the given #WebKitWebContext and
- * no #WebKitUserContentManager associated with it.
- * See also webkit_web_view_new_with_user_content_manager() and
- * webkit_web_view_new_with_settings().
+ * Creates a new web view with a given context.
*
- * Returns: The newly created #WebKitWebView
+ * The new web view will use the given [class@WebContext] and will not have
+ * an associated [class@UserContentManager].
+ *
+ * See also [id@webkit_web_view_new_with_user_content_manager] and
+ * [id@webkit_web_view_new_with_settings].
+ *
+ * Returns: The newly created web view.
*/
WebKitWebView* webkit_web_view_new_with_context(WebKitWebViewBackend* backend, WebKitWebContext* context)
{
@@ -108,22 +116,20 @@
/**
* webkit_web_view_new_with_related_view: (constructor)
- * @backend: (transfer full): a #WebKitWebViewBackend
- * @web_view: the related #WebKitWebView
+ * @backend: (transfer full) (not nullable): wrapped WPE view backend which
+ * will determine the behaviour of the new [class@WebView].
+ * @web_view: the related web view.
*
- * Creates a new #WebKitWebView sharing the same web process with @web_view.
- * This method doesn't have any effect when %WEBKIT_PROCESS_MODEL_SHARED_SECONDARY_PROCESS
- * process model is used, because a single web process is shared for all the web views in the
- * same #WebKitWebContext. When using %WEBKIT_PROCESS_MODEL_MULTIPLE_SECONDARY_PROCESSES process model,
- * this method should always be used when creating the #WebKitWebView in the #WebKitWebView::create signal.
- * You can also use this method to implement other process models based on %WEBKIT_PROCESS_MODEL_MULTIPLE_SECONDARY_PROCESSES,
- * like for example, sharing the same web process for all the views in the same security domain.
+ * Creates a new web view sharing the same configuration and web process as another.
*
- * The newly created #WebKitWebView will also have the same #WebKitUserContentManager
- * and #WebKitSettings as @web_view.
+ * A related view should always be set when creating a [class@WebView] in a handler
+ * for the [signal@WebView::create] signal.
*
- * Returns: (transfer full): The newly created #WebKitWebView
+ * The new view will also have the same [class@UserContentManager] and
+ * [class@Settings] as the related @web_view.
*
+ * Returns: (transfer full): The newly created web view.
+ *
* Since: 2.4
*/
WebKitWebView* webkit_web_view_new_with_related_view(WebKitWebViewBackend* backend, WebKitWebView* webView)
@@ -141,15 +147,17 @@
/**
* webkit_web_view_new_with_settings:
- * @backend: (nullable) (transfer full): a #WebKitWebViewBackend, or %NULL to use the default
- * @settings: a #WebKitSettings
+ * @backend: (transfer full) (not nullable): wrapped WPE view backend which
+ * will determine the behaviour of the new [class@WebView].
+ * @settings: settings for the new view.
*
- * Creates a new #WebKitWebView with the given #WebKitSettings.
- * See also webkit_web_view_new_with_context(), and
- * webkit_web_view_new_with_user_content_manager().
+ * Creates a new web view with the given settings.
*
- * Returns: The newly created #WebKitWebView
+ * See also [id@webkit_web_view_new_with_context], and
+ * [id@webkit_web_view_new_with_user_content_manager].
*
+ * Returns: (transfer full): The newly created web view.
+ *
* Since: 2.6
*/
WebKitWebView* webkit_web_view_new_with_settings(WebKitWebViewBackend* backend, WebKitSettings* settings)
@@ -165,15 +173,17 @@
/**
* webkit_web_view_new_with_user_content_manager:
- * @backend: (transfer full): a #WebKitWebViewBackend
- * @user_content_manager: a #WebKitUserContentManager.
+ * @backend: (transfer full) (not nullable): wrapped WPE view backend which
+ * will determine the behaviour of the new [class@WebView].
+ * @user_content_manager: the user content manager for the new view.
*
- * Creates a new #WebKitWebView with the given #WebKitUserContentManager.
- * The content loaded in the view may be affected by the content injected
- * in the view by the user content manager.
+ * Creates a new web view with the given user content manager.
*
- * Returns: The newly created #WebKitWebView
+ * The content loaded in the new [class@WebView] may be affected by the
+ * configuration of the given [class@UserContentManager].
*
+ * Returns: (transfer full): The newly created web view.
+ *
* Since: 2.6
*/
WebKitWebView* webkit_web_view_new_with_user_content_manager(WebKitWebViewBackend* backend, WebKitUserContentManager* userContentManager)
_______________________________________________
webkit-changes mailing list
webkit-changes@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-changes
