[PATCH] EDAC/octeon: fix kernel-doc comment for co_cache_error_event

hanzhijian <[email protected]>
Newsgroups org.kernel.vger.linux-edac,org.kernel.vger.linux-kernel,org.kernel.vger.linux-mips
Message-ID <[email protected]>
The comment for co_cache_error_event() starts with "/**" but lacks the
function name line, so scripts/kernel-doc reports "isn't a kernel-doc
comment" and it is silently dropped from the generated documentation.

Add the missing name line and document the parameters.

Signed-off-by: hanzhijian <[email protected]>
---
 drivers/edac/octeon_edac-pc.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/drivers/edac/octeon_edac-pc.c b/drivers/edac/octeon_edac-pc.c
index aa1219db0..076a3952f 100644
--- a/drivers/edac/octeon_edac-pc.c
+++ b/drivers/edac/octeon_edac-pc.c
@@ -31,9 +31,11 @@ struct co_cache_error {
 };
 
 /**
- * EDAC CPU cache error callback
+ * co_cache_error_event() - EDAC CPU cache error callback
  *
+ * @this: notifier block
  * @event: non-zero if unrecoverable.
+ * @ptr: unused
  */
 static int  co_cache_error_event(struct notifier_block *this,
 	unsigned long event, void *ptr)
-- 
2.43.0
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.