lkml.org 
[lkml]   [2021]   [Feb]   [11]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] staging: rtl8723bs: fix function comments to follow kernel-doc
On Thu, Feb 11, 2021 at 12:40:15AM +0530, karthik alapati wrote:
> fix checkpatch.pl warning for "block comments should align the
> * on each line" and make function comments follow kernel-doc
>
> Signed-off-by: karthik alapati <mail@karthek.com>
> ---
> .../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 185 +++++++-----------
> 1 file changed, 73 insertions(+), 112 deletions(-)
>
> diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> index cf23414d7..1fd504181 100644
> --- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> +++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> @@ -20,16 +20,11 @@
> #define MAX_DOZE_WAITING_TIMES_9x 64
>
> /**
> -* Function: phy_CalculateBitShift
> -*
> -* OverView: Get shifted position of the BitMask
> -*
> -* Input:
> -* u32 BitMask,
> -*
> -* Output: none
> -* Return: u32 Return the shift bit bit position of the mask
> -*/
> + * phy_CalculateBitShift - Get shifted position of the BitMask.
> + * @BitMask: Bitmask.
> + *
> + * Return: Return the shift bit position of the mask
> + */

Why indent these comments by a tab? A single space is fine.

thanks,

greg k-h

\
 
 \ /
  Last update: 2021-02-11 12:45    [W:0.046 / U:0.260 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site