cfg80211: fix a documentation warning
authorJohannes Berg <johannes.berg@intel.com>
Fri, 13 Jan 2017 09:02:13 +0000 (10:02 +0100)
committerJohannes Berg <johannes.berg@intel.com>
Tue, 24 Jan 2017 10:07:33 +0000 (11:07 +0100)
The new restructured text parser complains about the formatting,
and really this should be a definition list.

In order to fix this without introducing trailing whitespace,
convert to the inline kernel-doc format.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
include/net/cfg80211.h

index b7aba6e..8705494 100644 (file)
@@ -3178,22 +3178,6 @@ struct ieee80211_iface_limit {
 
 /**
  * struct ieee80211_iface_combination - possible interface combination
- * @limits: limits for the given interface types
- * @n_limits: number of limitations
- * @num_different_channels: can use up to this many different channels
- * @max_interfaces: maximum number of interfaces in total allowed in this
- *     group
- * @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.
  *
  * With this structure the driver can describe which interface
  * combinations it supports concurrently.
@@ -3252,13 +3236,60 @@ struct ieee80211_iface_limit {
  *
  */
 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;
 };