Re: [PATCH] ptp: ptp_clockmatrix: repair non-kernel-doc comment

On Wed, 10 Nov 2021 18:09:20 -0800 Randy Dunlap wrote:

On 11/10/21 5:49 PM, Jakub Kicinski wrote:

quoted

On Wed, 10 Nov 2021 14:53:06 -0800 Randy Dunlap wrote:  

quoted

-/**
+/*
   * Maximum absolute value for write phase offset in picoseconds
   *
   * @channel:  channel  

Looks like it documents parameters to the function, should we either
fix it to make it valid kdoc or remove the params (which TBH aren't
really adding much value)?
  

a. It would be the only kernel-doc in that source file and
b. we usually want to document exported or at least non-static
functions and don't try very hard to document static ones.

I don't care much about whether we remove the other comments
that are there...
If you want them removed, I can do that.

Yeah, lest remove the "@channel: channel" etc. while at it.

Thanks, Randy!