| Message ID | 20210317202144.20290-1-yashsri421@gmail.com |
|---|---|
| State | Accepted |
| Commit | cbdce7a3620c7daff6b8a2cb27b41bb0a2e6f78d |
| Headers | show |
| Series | ALSA: asihpi: fix comment syntax in file headers | expand |
On Wed, 17 Mar 2021 21:21:44 +0100, Aditya Srivastava wrote: > > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > There are files in sound/pci/asihpi which follow this syntax in their file > headers, i.e. start with '/**' like comments, which causes unexpected > warnings from kernel-doc. > > E.g., running scripts/kernel-doc -none on sound/pci/asihpi/hpidspcd.h > causes this warning: > "warning: Cannot understand > on line 4 - I thought it was a doc line" > > Provide a simple fix by replacing the kernel-doc like comment syntax with > general format, i.e. "/*", to prevent kernel-doc from parsing it. > > Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> Applied now. Thanks. Takashi
diff --git a/sound/pci/asihpi/hpicmn.h b/sound/pci/asihpi/hpicmn.h index de3bedd29d94..8ec656cf8848 100644 --- a/sound/pci/asihpi/hpicmn.h +++ b/sound/pci/asihpi/hpicmn.h @@ -1,5 +1,5 @@ /* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* AudioScience HPI driver Copyright (C) 1997-2014 AudioScience Inc. <support@audioscience.com> diff --git a/sound/pci/asihpi/hpidspcd.h b/sound/pci/asihpi/hpidspcd.h index a01e8c6092bd..9f1468ed7096 100644 --- a/sound/pci/asihpi/hpidspcd.h +++ b/sound/pci/asihpi/hpidspcd.h @@ -1,6 +1,6 @@ /* SPDX-License-Identifier: GPL-2.0-only */ /***********************************************************************/ -/** +/* AudioScience HPI driver Copyright (C) 1997-2011 AudioScience Inc. <support@audioscience.com>
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments. There are files in sound/pci/asihpi which follow this syntax in their file headers, i.e. start with '/**' like comments, which causes unexpected warnings from kernel-doc. E.g., running scripts/kernel-doc -none on sound/pci/asihpi/hpidspcd.h causes this warning: "warning: Cannot understand on line 4 - I thought it was a doc line" Provide a simple fix by replacing the kernel-doc like comment syntax with general format, i.e. "/*", to prevent kernel-doc from parsing it. Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> --- * Applies perfectly on next-20210312 sound/pci/asihpi/hpicmn.h | 2 +- sound/pci/asihpi/hpidspcd.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)