| Message ID | 1621933165-9661-1-git-send-email-chunfeng.yun@mediatek.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [1/3] usb: common: move usb_get_dr_mode() kerneldoc next to its definition | expand |
On Tue, May 25, 2021 at 04:59:23PM +0800, Chunfeng Yun wrote: > Following a general rule, add the kerneldoc for a function next > to it's definition, but not next to its declaration in a header > file, meanwhile fix typo 'correspondig' > > Signed-off-by: Chunfeng Yun <chunfeng.yun@mediatek.com> > --- > drivers/usb/common/common.c | 7 +++++++ > include/linux/usb/otg.h | 7 ------- > 2 files changed, 7 insertions(+), 7 deletions(-) Does not apply to my usb-next branch :( thanks, greg k-h
diff --git a/drivers/usb/common/common.c b/drivers/usb/common/common.c index 347fb3d3894a..fff318597337 100644 --- a/drivers/usb/common/common.c +++ b/drivers/usb/common/common.c @@ -187,6 +187,13 @@ static enum usb_dr_mode usb_get_dr_mode_from_string(const char *str) return (ret < 0) ? USB_DR_MODE_UNKNOWN : ret; } +/** + * usb_get_dr_mode - Get dual role mode for given device + * @dev: Pointer to the given device + * + * The function gets phy interface string from property 'dr_mode', + * and returns the corresponding enum usb_dr_mode + */ enum usb_dr_mode usb_get_dr_mode(struct device *dev) { const char *dr_mode; diff --git a/include/linux/usb/otg.h b/include/linux/usb/otg.h index 69f1b6328532..a86ee6aad51b 100644 --- a/include/linux/usb/otg.h +++ b/include/linux/usb/otg.h @@ -120,13 +120,6 @@ enum usb_dr_mode { USB_DR_MODE_OTG, }; -/** - * usb_get_dr_mode - Get dual role mode for given device - * @dev: Pointer to the given device - * - * The function gets phy interface string from property 'dr_mode', - * and returns the correspondig enum usb_dr_mode - */ extern enum usb_dr_mode usb_get_dr_mode(struct device *dev); #endif /* __LINUX_USB_OTG_H */
Following a general rule, add the kerneldoc for a function next to it's definition, but not next to its declaration in a header file, meanwhile fix typo 'correspondig' Signed-off-by: Chunfeng Yun <chunfeng.yun@mediatek.com> --- drivers/usb/common/common.c | 7 +++++++ include/linux/usb/otg.h | 7 ------- 2 files changed, 7 insertions(+), 7 deletions(-)