Commit 0419bf0f authored by Aditya Srivastava's avatar Aditya Srivastava Committed by Greg Kroah-Hartman

ipac: tpci200: fix kernel-doc syntax and remove filename from file header

The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for drivers/ipack/carriers/tpci200 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/carriers/tpci200.c emits:
warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * tpci200.c

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.
Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Acked-by: default avatarSamuel Iglesias Gonsalvez <siglesias@igalia.com>
Signed-off-by: default avatarAditya Srivastava <yashsri421@gmail.com>
Link: https://lore.kernel.org/r/20210522124051.12540-1-yashsri421@gmail.comSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent b716f42e
// SPDX-License-Identifier: GPL-2.0-only // SPDX-License-Identifier: GPL-2.0-only
/** /*
* tpci200.c
*
* driver for the TEWS TPCI-200 device * driver for the TEWS TPCI-200 device
* *
* Copyright (C) 2009-2012 CERN (www.cern.ch) * Copyright (C) 2009-2012 CERN (www.cern.ch)
......
/* SPDX-License-Identifier: GPL-2.0-only */ /* SPDX-License-Identifier: GPL-2.0-only */
/** /*
* tpci200.h
*
* driver for the carrier TEWS TPCI-200 * driver for the carrier TEWS TPCI-200
* *
* Copyright (C) 2009-2012 CERN (www.cern.ch) * Copyright (C) 2009-2012 CERN (www.cern.ch)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment