]> git.baikalelectronics.ru Git - kernel.git/commit
ptp: ptp_clockmatrix: repair non-kernel-doc comment
authorRandy Dunlap <rdunlap@infradead.org>
Thu, 11 Nov 2021 15:50:34 +0000 (07:50 -0800)
committerJakub Kicinski <kuba@kernel.org>
Sat, 13 Nov 2021 03:58:10 +0000 (19:58 -0800)
commitb6d135438bd09c1b5f6b71e09fd3319eeb13b08a
tree33d617b5bc8163feb15874bbf9d502200a1098f9
parent180a9ea28e8e85b2902c59e37e1a2e8d5b1b0258
ptp: ptp_clockmatrix: repair non-kernel-doc comment

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: 681256bc3600b ("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>
Acked-by: Richard Cochran <richardcochran@gmail.com>
Link: https://lore.kernel.org/r/20211111155034.29153-1-rdunlap@infradead.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
drivers/ptp/ptp_clockmatrix.c