Bug 247313

Summary: Code style does not allow currently used member function explanation comments for vfuncs, ipc messages
Product: WebKit Reporter: Kimmo Kinnunen <kkinnunen>
Component: Tools / TestsAssignee: Kimmo Kinnunen <kkinnunen>
Status: RESOLVED FIXED    
Severity: Normal CC: cdumez, rniwa, webkit-bug-importer
Priority: P2 Keywords: InRadar
Version: Safari Technology Preview   
Hardware: Unspecified   
OS: Unspecified   

Description Kimmo Kinnunen 2022-11-01 05:08:02 PDT
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.
Comment 1 Radar WebKit Bug Importer 2022-11-01 05:08:57 PDT
<rdar://problem/101801434>
Comment 2 Kimmo Kinnunen 2022-11-01 05:10:10 PDT
Pull request: https://github.com/WebKit/WebKit/pull/5996
Comment 3 EWS 2022-11-02 02:29:10 PDT
Committed 256221@main (09420100638c): <https://commits.webkit.org/256221@main>

Reviewed commits have been landed. Closing PR #5996 and removing active labels.