[webkit-changes] [WebKit/WebKit] 429ffb: [GLib] Remove obsolete documentation from WebKitWe...

[Michael Catanzaro]

  Branch: refs/heads/main
  Home:   https://github.com/WebKit/WebKit
  Commit: 429ffbd25b0e23039bcad11555a17fcbe8e7047e
      https://github.com/WebKit/WebKit/commit/429ffbd25b0e23039bcad11555a17fcbe8e7047e
  Author: Michael Catanzaro <mcatanzaro at redhat.com>
  Date:   2023-05-18 (Thu, 18 May 2023)

  Changed paths:
    M Source/WebKit/UIProcess/API/glib/WebKitWebsiteDataManager.cpp

  Log Message:
  -----------
  [GLib] Remove obsolete documentation from WebKitWebsiteDataManager
https://bugs.webkit.org/show_bug.cgi?id=256912

Reviewed by Carlos Garcia Campos.

The WebKitWebsiteDataManager documentation has many references to
WebKitWebContext ownership of WebKitWebsiteDataManager, but in the 2022
API version it is owned by WebKitNetworkSession. It's hard to fix
because we cannot use conditional compilation inside doc comments. We
can either (a) move the doc comment to the header file and have two
different copies of the comment, or (b) simplify the comment by removing
info about behavior that varies between API versions. I've opted for
(b). I think most developers should still be able to figure out how to
use it... hopefully.

This is imperfect, but certainly better than having incorrect
information in the documentation.

* Source/WebKit/UIProcess/API/glib/WebKitWebsiteDataManager.cpp:

Canonical link: https://commits.webkit.org/264198@main