wifi: mac80211: correctly document struct mesh_table
authorJeff Johnson <quic_jjohnson@quicinc.com>
Fri, 29 Mar 2024 05:44:13 +0000 (22:44 -0700)
committerJohannes Berg <johannes.berg@intel.com>
Mon, 8 Apr 2024 18:19:14 +0000 (20:19 +0200)
Currently kernel-doc -Wall reports:

net/mac80211/ieee80211_i.h:687: warning: missing initial short description on line:
 * struct mesh_table

So add a short description.

Reported-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/linux-wireless/a009a21a-56d7-4a1a-aaf9-feefa5acc561@infradead.org/
Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://msgid.link/20240328-mesh_table-kerneldoc-v1-1-174c4df341b1@quicinc.com
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
net/mac80211/ieee80211_i.h

index 458f63ce9a32a8a1f5df40be8c8f1345b5da4090..81a9c5b7642dd1db7874a4d84d57675453b545ff 100644 (file)
@@ -686,7 +686,7 @@ struct mesh_csa_settings {
 };
 
 /**
- * struct mesh_table
+ * struct mesh_table - mesh hash table
  *
  * @known_gates: list of known mesh gates and their mpaths by the station. The
  * gate's mpath may or may not be resolved and active.