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

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

[Randy Dunlap]

Do not use "/**" to begin a comment that is not in kernel-doc format.

Prevents this docs build warning:

drivers/ptp/ptp_clockmatrix.c:1679: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Maximum absolute value for write phase offset in picoseconds

Then remove the kernel-doc-like function parameter descriptions
since they don't add any useful info. (suggested by Jakub)

Fixes: 794c3dffacc16 ("ptp: ptp_clockmatrix: Add support for FW 5.2 (8A34005)")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Min Li <min.li.xe@renesas.com>
Cc: Richard Cochran <richardcochran@gmail.com>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
---
v2: remove useless function argument descriptions

 drivers/ptp/ptp_clockmatrix.c |    5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

--- linux-next-20211110.orig/drivers/ptp/ptp_clockmatrix.c
+++ linux-next-20211110/drivers/ptp/ptp_clockmatrix.c
@@ -1699,12 +1699,9 @@ static int initialize_dco_operating_mode
 
 /* PTP Hardware Clock interface */
 
-/**
+/*
  * Maximum absolute value for write phase offset in picoseconds
  *
- * @channel:  channel
- * @delta_ns: delta in nanoseconds
- *
  * Destination signed register is 32-bit register in resolution of 50ps
  *
  * 0x7fffffff * 50 =  2147483647 * 50 = 107374182350

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

[Richard Cochran]

On Thu, Nov 11, 2021 at 07:50:34AM -0800, Randy Dunlap wrote:
> Do not use "/**" to begin a comment that is not in kernel-doc format.
> 
> Prevents this docs build warning:
> 
> drivers/ptp/ptp_clockmatrix.c:1679: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * Maximum absolute value for write phase offset in picoseconds
> 
> Then remove the kernel-doc-like function parameter descriptions
> since they don't add any useful info. (suggested by Jakub)
> 
> Fixes: 794c3dffacc16 ("ptp: ptp_clockmatrix: Add support for FW 5.2 (8A34005)")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Cc: Min Li <min.li.xe@renesas.com>
> Cc: Richard Cochran <richardcochran@gmail.com>
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: Jakub Kicinski <kuba@kernel.org>

Acked-by: Richard Cochran <richardcochran@gmail.com>

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

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (master)
by Jakub Kicinski <kuba@kernel.org>:

On Thu, 11 Nov 2021 07:50:34 -0800 you wrote:
> Do not use "/**" to begin a comment that is not in kernel-doc format.
> 
> Prevents this docs build warning:
> 
> drivers/ptp/ptp_clockmatrix.c:1679: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * Maximum absolute value for write phase offset in picoseconds
> 
> [...]

Here is the summary with links:
  - [v2] ptp: ptp_clockmatrix: repair non-kernel-doc comment
    https://git.kernel.org/netdev/net/c/87530779de04

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html