diff mbox series

[16/18] wifi: cfg80211: wext: convert return value to kernel-doc

Message ID 20230928172905.ab3b9274bf07.If263f9f6726d6ad4661f8603e6a4485e0385d67f@changeid (mailing list archive)
State Accepted
Delegated to: Johannes Berg
Headers show
Series cfg80211/mac80211 patches from our internal tree 2023-09-28 | expand

Commit Message

Greenman, Gregory Sept. 28, 2023, 2:35 p.m. UTC
From: Johannes Berg <johannes.berg@intel.com>

Since I'm getting a warning here right now, fix the
kernel-doc to be "Returns:" rather than just writing
that out in the doc paragraph.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: Gregory Greenman <gregory.greenman@intel.com>
---
 net/wireless/wext-compat.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Jeff Johnson Sept. 29, 2023, midnight UTC | #1
On 9/28/2023 7:35 AM, gregory.greenman@intel.com wrote:
> From: Johannes Berg <johannes.berg@intel.com>
> 
> Since I'm getting a warning here right now, fix the
> kernel-doc to be "Returns:" rather than just writing
> that out in the doc paragraph.
> 
> Signed-off-by: Johannes Berg <johannes.berg@intel.com>
> Signed-off-by: Gregory Greenman <gregory.greenman@intel.com>
> ---
>   net/wireless/wext-compat.c | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/net/wireless/wext-compat.c b/net/wireless/wext-compat.c
> index d23ce088bffa..2371069f3c43 100644
> --- a/net/wireless/wext-compat.c
> +++ b/net/wireless/wext-compat.c
> @@ -7,7 +7,7 @@
>    * we directly assign the wireless handlers of wireless interfaces.
>    *
>    * Copyright 2008-2009	Johannes Berg <johannes@sipsolutions.net>
> - * Copyright (C) 2019-2022 Intel Corporation
> + * Copyright (C) 2019-2023 Intel Corporation
>    */
>   
>   #include <linux/export.h>
> @@ -227,7 +227,7 @@ EXPORT_WEXT_HANDLER(cfg80211_wext_giwrange);
>    * cfg80211_wext_freq - get wext frequency for non-"auto"
>    * @freq: the wext freq encoding
>    *
> - * Returns a frequency, or a negative error code, or 0 for auto.
> + * Returns: a frequency, or a negative error code, or 0 for auto.

again, shouldn't this be Return:

>    */
>   int cfg80211_wext_freq(struct iw_freq *freq)
>   {
diff mbox series

Patch

diff --git a/net/wireless/wext-compat.c b/net/wireless/wext-compat.c
index d23ce088bffa..2371069f3c43 100644
--- a/net/wireless/wext-compat.c
+++ b/net/wireless/wext-compat.c
@@ -7,7 +7,7 @@ 
  * we directly assign the wireless handlers of wireless interfaces.
  *
  * Copyright 2008-2009	Johannes Berg <johannes@sipsolutions.net>
- * Copyright (C) 2019-2022 Intel Corporation
+ * Copyright (C) 2019-2023 Intel Corporation
  */
 
 #include <linux/export.h>
@@ -227,7 +227,7 @@  EXPORT_WEXT_HANDLER(cfg80211_wext_giwrange);
  * cfg80211_wext_freq - get wext frequency for non-"auto"
  * @freq: the wext freq encoding
  *
- * Returns a frequency, or a negative error code, or 0 for auto.
+ * Returns: a frequency, or a negative error code, or 0 for auto.
  */
 int cfg80211_wext_freq(struct iw_freq *freq)
 {