lkml.org 
[lkml]   [2021]   [Mar]   [17]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH] ALSA: asihpi: fix comment syntax in file headers
From
Date
On 3/17/21 1:21 PM, 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>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> * Applies perfectly on next-20210312
>
> sound/pci/asihpi/hpicmn.h | 2 +-
> sound/pci/asihpi/hpidspcd.h | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
> 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>
>


--
~Randy

\
 
 \ /
  Last update: 2021-03-17 21:42    [W:0.036 / U:0.524 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site