[Webkit-unassigned] [Bug 247313] New: Code style does not allow currently used member function explanation comments for vfuncs, ipc messages

bugzilla-daemon at webkit.org bugzilla-daemon at webkit.org
Tue Nov 1 05:08:02 PDT 2022


https://bugs.webkit.org/show_bug.cgi?id=247313

            Bug ID: 247313
           Summary: Code style does not allow currently used member
                    function explanation comments for vfuncs, ipc messages
           Product: WebKit
           Version: Safari Technology Preview
          Hardware: Unspecified
                OS: Unspecified
            Status: NEW
          Severity: Normal
          Priority: P2
         Component: Tools / Tests
          Assignee: webkit-unassigned at lists.webkit.org
          Reporter: kkinnunen at apple.com

Code style does not allow currently used member function explanation comments for vfuncs, ipc messages

Current style defines that comments must be English sentences.

Currently code uses:
  class GPUProcessConnection : public RefCounted<GPUProcessConnection>, public IPC::Connection::Client {
  public:
      /// ...

      // IPC::Connection::Client
      void didClose(IPC::Connection&) override;
     // ...
  };

When trying to solve this by using:
 // IPC::Connection::Client overrides.
.. then some reviewer complains.

When trying to solve this by using:
 // IPC::Connection::Client
.. then another reviewer complains.

It is not good that review results of seemingly deterministic rule-based system depends on personal preferences of who happens to review the patch.

This causes non-deterministic churn during reviews.

The code style could define this case so that there would be no need for personal preferences.

-- 
You are receiving this mail because:
You are the assignee for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.webkit.org/pipermail/webkit-unassigned/attachments/20221101/59dec686/attachment.htm>


More information about the webkit-unassigned mailing list