linux-kernel - [PATCH -next] cfg80211: fix a few kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Date:   Fri, 16 Apr 2021 23:01:42 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     linux-kernel@...r.kernel.org
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Johannes Berg <johannes@...solutions.net>,
        Johannes Berg <johannes.berg@...el.com>,
        Emmanuel Grumbach <emmanuel.grumbach@...el.com>,
        linux-wireless@...r.kernel.org
Subject: [PATCH -next] cfg80211: fix a few kernel-doc warnings

Fix multiple kernel-doc warnings in cfg80211.h.

cfg80211.h:363: warning: missing initial short description on line:
 * struct ieee80211_sband_iftype_data
cfg80211.h:6643: warning: expecting prototype for wiphy_rfkill_set_hw_state(). P
rototype was for wiphy_rfkill_set_hw_state_reason() instead
cfg80211.h:6743: warning: missing initial short description on line:
 * cfg80211_vendor_cmd_get_sender

Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Johannes Berg <johannes@...solutions.net>
Cc: Johannes Berg <johannes.berg@...el.com>
Cc: Emmanuel Grumbach <emmanuel.grumbach@...el.com>
Cc: linux-wireless@...r.kernel.org
---
 include/net/cfg80211.h |   11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

--- linux-next-20210416.orig/include/net/cfg80211.h
+++ linux-next-20210416/include/net/cfg80211.h
@@ -360,7 +360,7 @@ struct ieee80211_sta_he_cap {
 };
 
 /**
- * struct ieee80211_sband_iftype_data
+ * struct ieee80211_sband_iftype_data - sband data per interface type
  *
  * This structure encapsulates sband data that is relevant for the
  * interface types defined in @types_mask.  Each type in the
@@ -6633,15 +6633,14 @@ void cfg80211_notify_new_peer_candidate(
  * They can do this with a few helper functions documented here.
  */
 
+void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked,
+				      enum rfkill_hard_block_reasons reason);
+
 /**
  * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
  * @wiphy: the wiphy
  * @blocked: block status
- * @reason: one of reasons in &enum rfkill_hard_block_reasons
  */
-void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked,
-				      enum rfkill_hard_block_reasons reason);
-
 static inline void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked)
 {
 	wiphy_rfkill_set_hw_state_reason(wiphy, blocked,
@@ -6740,7 +6739,7 @@ cfg80211_vendor_cmd_alloc_reply_skb(stru
 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
 
 /**
- * cfg80211_vendor_cmd_get_sender
+ * cfg80211_vendor_cmd_get_sender - get the current netlink port ID of a wiphy
  * @wiphy: the wiphy
  *
  * Return the current netlink port ID in a vendor command handler.