[09/10] cfg80211: align documentation style of ieee80211_iface_combination

Message ID 20200221115604.594035-9-Jerome.Pouiller@silabs.com
State New
Headers show
Series
  • [01/10] cfg80211: drop duplicated documentation of field "probe_resp_offload"
Related show

Commit Message

Jerome Pouiller Feb. 21, 2020, 11:56 a.m.
From: Jérôme Pouiller <jerome.pouiller@silabs.com>

In cfg80211.h, all the structs but ieee80211_iface_combination are
documented above their definition.

Signed-off-by: Jérôme Pouiller <jerome.pouiller@silabs.com>
---
 include/net/cfg80211.h | 63 +++++++++++-------------------------------
 1 file changed, 16 insertions(+), 47 deletions(-)

Patch

diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h
index 1cc3442b540f..2f8c41993ed2 100644
--- a/include/net/cfg80211.h
+++ b/include/net/cfg80211.h
@@ -4103,62 +4103,31 @@  struct ieee80211_iface_limit {
  *		.num_different_channels = 2,
  *	};
  *
+ * @limits: limits for the given interface types
+ * @num_different_channels: can use up to this many different channels
+ * @max_interfaces:  maximum number of interfaces in total allowed in this group
+ * @n_limits: number of limitations
+ * @beacon_int_infra_match: In this combination, the beacon intervals between
+ *	infrastructure and AP types must match. This is required only in special
+ *	cases.
+ * @radar_detect_widths: bitmap of channel widths supported for radar detection
+ * @radar_detect_regions: bitmap of regions supported for radar detection
+ * @beacon_int_min_gcd: This interface combination supports different beacon
+ *	intervals:
+ *	    * = 0: all beacon intervals for different interface must be same.
+ *	    * > 0: any beacon interval for the interface part of this
+ *	      combination AND GCD of all beacon intervals from beaconing
+ *	      interfaces of this combination must be greater or equal to this
+ *	      value.
  */
 struct ieee80211_iface_combination {
-	/**
-	 * @limits:
-	 * limits for the given interface types
-	 */
 	const struct ieee80211_iface_limit *limits;
-
-	/**
-	 * @num_different_channels:
-	 * can use up to this many different channels
-	 */
 	u32 num_different_channels;
-
-	/**
-	 * @max_interfaces:
-	 * maximum number of interfaces in total allowed in this group
-	 */
 	u16 max_interfaces;
-
-	/**
-	 * @n_limits:
-	 * number of limitations
-	 */
 	u8 n_limits;
-
-	/**
-	 * @beacon_int_infra_match:
-	 * In this combination, the beacon intervals between infrastructure
-	 * and AP types must match. This is required only in special cases.
-	 */
 	bool beacon_int_infra_match;
-
-	/**
-	 * @radar_detect_widths:
-	 * bitmap of channel widths supported for radar detection
-	 */
 	u8 radar_detect_widths;
-
-	/**
-	 * @radar_detect_regions:
-	 * bitmap of regions supported for radar detection
-	 */
 	u8 radar_detect_regions;
-
-	/**
-	 * @beacon_int_min_gcd:
-	 * This interface combination supports different beacon intervals.
-	 *
-	 * = 0
-	 *   all beacon intervals for different interface must be same.
-	 * > 0
-	 *   any beacon interval for the interface part of this combination AND
-	 *   GCD of all beacon intervals from beaconing interfaces of this
-	 *   combination must be greater or equal to this value.
-	 */
 	u32 beacon_int_min_gcd;
 };