Commit a839e463 authored by Jonathan Corbet's avatar Jonathan Corbet Committed by Johannes Berg

mac80211: Fix mac80211.h docbook comments

A couple of enums in mac80211.h became structures recently, but the
comments didn't follow suit, leading to errors like:

  Error(.//include/net/mac80211.h:367): Cannot parse enum!
  Documentation/DocBook/Makefile:93: recipe for target 'Documentation/DocBook/80211.xml' failed
  make[1]: *** [Documentation/DocBook/80211.xml] Error 1
  Makefile:1361: recipe for target 'mandocs' failed
  make: *** [mandocs] Error 2

Fix the comments comments accordingly.  Added a couple of other small
comment fixes while I was there to silence other recently-added docbook
warnings.
Reported-by: default avatarJim Davis <jim.epost@gmail.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
parent 35c347ac
...@@ -354,7 +354,7 @@ enum ieee80211_rssi_event_data { ...@@ -354,7 +354,7 @@ enum ieee80211_rssi_event_data {
}; };
/** /**
* enum ieee80211_rssi_event - data attached to an %RSSI_EVENT * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
* @data: See &enum ieee80211_rssi_event_data * @data: See &enum ieee80211_rssi_event_data
*/ */
struct ieee80211_rssi_event { struct ieee80211_rssi_event {
...@@ -388,7 +388,7 @@ enum ieee80211_mlme_event_status { ...@@ -388,7 +388,7 @@ enum ieee80211_mlme_event_status {
}; };
/** /**
* enum ieee80211_mlme_event - data attached to an %MLME_EVENT * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
* @data: See &enum ieee80211_mlme_event_data * @data: See &enum ieee80211_mlme_event_data
* @status: See &enum ieee80211_mlme_event_status * @status: See &enum ieee80211_mlme_event_status
* @reason: the reason code if applicable * @reason: the reason code if applicable
...@@ -401,9 +401,10 @@ struct ieee80211_mlme_event { ...@@ -401,9 +401,10 @@ struct ieee80211_mlme_event {
/** /**
* struct ieee80211_event - event to be sent to the driver * struct ieee80211_event - event to be sent to the driver
* @type The event itself. See &enum ieee80211_event_type. * @type: The event itself. See &enum ieee80211_event_type.
* @rssi: relevant if &type is %RSSI_EVENT * @rssi: relevant if &type is %RSSI_EVENT
* @mlme: relevant if &type is %AUTH_EVENT * @mlme: relevant if &type is %AUTH_EVENT
* @u: union holding the above two fields
*/ */
struct ieee80211_event { struct ieee80211_event {
enum ieee80211_event_type type; enum ieee80211_event_type type;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment