Skip to content

Commit

Permalink
mac80211: Fix mac80211.h docbook comments
Browse files Browse the repository at this point in the history
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: Jim Davis <jim.epost@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
  • Loading branch information
Jonathan Corbet authored and Johannes Berg committed Apr 20, 2015
1 parent 35c347a commit a839e46
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions include/net/mac80211.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
struct ieee80211_rssi_event {
Expand Down Expand Up @@ -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
* @status: See &enum ieee80211_mlme_event_status
* @reason: the reason code if applicable
Expand All @@ -401,9 +401,10 @@ struct ieee80211_mlme_event {

/**
* 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
* @mlme: relevant if &type is %AUTH_EVENT
* @u: union holding the above two fields
*/
struct ieee80211_event {
enum ieee80211_event_type type;
Expand Down

0 comments on commit a839e46

Please sign in to comment.