cfg80211: add documentation for max_num_csa_counters
authorLuciano Coelho <luciano.coelho@intel.com>
Thu, 15 May 2014 17:18:09 +0000 (20:18 +0300)
committerJohannes Berg <johannes.berg@intel.com>
Mon, 19 May 2014 12:38:53 +0000 (14:38 +0200)
Move the comment in the structure to a description of the
max_num_csa_counters field in the docbook area.

This fixes a warning when building htmldocs (at least):

 Warning(include/net/cfg80211.h:3064): No description found for parameter 'max_num_csa_counters'

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

index 447cb58..955fdec 100644 (file)
@@ -2936,6 +2936,11 @@ struct wiphy_vendor_command {
  *     (including P2P GO) or 0 to indicate no such limit is advertised. The
  *     driver is allowed to advertise a theoretical limit that it can reach in
  *     some cases, but may not always reach.
+ *
+ * @max_num_csa_counters: Number of supported csa_counters in beacons
+ *     and probe responses.  This value should be set if the driver
+ *     wishes to limit the number of csa counters. Default (0) means
+ *     infinite.
  */
 struct wiphy {
        /* assign these fields before you register the wiphy */
@@ -3053,11 +3058,6 @@ struct wiphy {
 
        u16 max_ap_assoc_sta;
 
-       /*
-        * Number of supported csa_counters in beacons and probe responses.
-        * This value should be set if the driver wishes to limit the number of
-        * csa counters. Default (0) means infinite.
-        */
        u8 max_num_csa_counters;
 
        char priv[0] __aligned(NETDEV_ALIGN);