Skip to contentSkip to conversation

mac80211: Fix mac80211.h docbook comments

PATCH Applied Jonathan Corbet 2 participants 2 messages Apr 13, 2015 – Apr 14, 2015 mac80211

lore
Share & tools
lore

Jonathan Corbet

author
#0 lore raw

PATCH 1/1 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 Jim Davis <[email protected]>
Signed-off-by Jonathan Corbet <[email protected]>
---
 include/net/mac80211.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
include/net/mac80211.h +4 -3
index 201bc68e0cff..f1f147e246ff 100644
@@ -321,7 +321,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 {

@@ -355,7 +355,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

@@ -368,9 +368,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;
Signature · 1 line
2.1.0
maintainer Applied
#1 lore raw
Quoted 9 lines · Jonathan Corbet

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

Quoted 3 lines

Fix the comments comments accordingly. Added a couple of other small comment fixes while I was there to silence other recently-added docbook warnings.

Applied, thanks!

johannes