The opening comment mark '/**' is used for highlighting the beginning
of
kernel-doc comments.
The header for drivers/ipack/devices/ipoctal follows this syntax, but
the
content inside does not comply with kernel-doc.
This line was probably not meant for kernel-doc parsing, but is
parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'),
which
causes unexpected warning from kernel-doc.
For e.g., running scripts/kernel-doc -none on
drivers/ipack/devices/ipoctal.h emits:
warning: This comment starts with '/**', but isn't a kernel-doc
comment. Refer Documentation/doc-guide/kernel-doc.rst
* ipoctal.h
Provide a simple fix by replacing this occurrence with general
comment
format, i.e. '/*', to prevent kernel-doc from parsing it.
Also remove the redundant file name from the comment headers.
Signed-off-by: Aditya Srivastava <redacted>
---
drivers/ipack/devices/ipoctal.c | 4 +---
drivers/ipack/devices/ipoctal.h | 6 ++----
2 files changed, 3 insertions(+), 7 deletions(-)
diff --git a/drivers/ipack/devices/ipoctal.c
b/drivers/ipack/devices/ipoctal.c
index 3940714e4397..2a3a94f72dfb 100644
--- a/drivers/ipack/devices/ipoctal.c
+++ b/drivers/ipack/devices/ipoctal.c
// SPDX-License-Identifier: GPL-2.0-only
-/**
- * ipoctal.c
- *
+/*
* driver for the GE IP-OCTAL boards
*
* Copyright (C) 2009-2012 CERN (www.cern.ch)
diff --git a/drivers/ipack/devices/ipoctal.h
b/drivers/ipack/devices/ipoctal.h
index 75f83ba774a4..773dc41bd667 100644
--- a/drivers/ipack/devices/ipoctal.h
+++ b/drivers/ipack/devices/ipoctal.h
/* SPDX-License-Identifier: GPL-2.0-only */
-/**
- * ipoctal.h
- *
+/*
* driver for the IPOCTAL boards
-
+ *
* Copyright (C) 2009-2012 CERN (www.cern.ch)
* Author: Nicolas Serafini, EIC2 SA
* Author: Samuel Iglesias Gonsalvez [off-list ref]