Re: [PATCH v3 3/4] staging: rtl8723bs: include: Further clean up function declarations
From: Aditya Jain
Date: Sun Jul 26 2020 - 14:15:49 EST
On Sun, Jul 26, 2020 at 10:45 PM Joe Perches <joe@xxxxxxxxxxx> wrote:
> On Sun, 2020-07-26 at 17:02 +0200, Greg KH wrote:
> > On Sun, Jul 26, 2020 at 07:50:12PM +0530, Aditya Jain wrote:
> > > Cleaning up messy multiline function declarations in hal_phy_cfg.h
> > > diff --git a/drivers/staging/rtl8723bs/include/hal_phy_cfg.h b/drivers/staging/rtl8723bs/include/hal_phy_cfg.h
Ok, I'll merge this patch with the previous one. Had separated the two
to make the diffs smaller thinking they'll
be easier to review. But yeah, I get the point.
> > > -void
> > > -PHY_SetSwChnlBWMode8723B(
> > > -struct adapter *Adapter,
> > > -u8 channel,
> > > -enum CHANNEL_WIDTH Bandwidth,
> > > -u8 Offset40,
> > > -u8 Offset80
> > > +void PHY_SetBWMode8723B(struct adapter *Adapter,
> > > + enum CHANNEL_WIDTH Bandwidth, /* 20M or 40M */
> > > + unsigned char Offset /* Upper, Lower, or Don't care */
> > Those comments should go at the top of the function declaration, in
> > kernel doc format.
> Not every external function needs kernel-doc.
> This is a realtek staging driver that likely it will never be
> moved out of staging.
Should I just remove the comments then? Sorry, but I'm a newbie, and
not really sure what the function is or supposed to do.
I can try looking it up if kernel-doc is required here.