diff options
author | Jonathan Corbet <corbet@lwn.net> | 2015-04-13 12:27:35 -0400 |
---|---|---|
committer | Johannes Berg <johannes.berg@intel.com> | 2015-05-28 08:37:43 -0400 |
commit | 3a7af58faa7829faa26026c245d2a8a44e9605c5 (patch) | |
tree | 15eb8ffdbe76a5ec331189b65b764deb96bb3aea | |
parent | f9dca80b98caac8b4bfb43a2edf1e9f877ccf322 (diff) |
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 <jim.epost@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
-rw-r--r-- | include/net/mac80211.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/include/net/mac80211.h b/include/net/mac80211.h index 8e3668b44c29..fc57f6b82fc5 100644 --- a/include/net/mac80211.h +++ b/include/net/mac80211.h | |||
@@ -354,7 +354,7 @@ enum ieee80211_rssi_event_data { | |||
354 | }; | 354 | }; |
355 | 355 | ||
356 | /** | 356 | /** |
357 | * enum ieee80211_rssi_event - data attached to an %RSSI_EVENT | 357 | * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT |
358 | * @data: See &enum ieee80211_rssi_event_data | 358 | * @data: See &enum ieee80211_rssi_event_data |
359 | */ | 359 | */ |
360 | struct ieee80211_rssi_event { | 360 | struct ieee80211_rssi_event { |
@@ -388,7 +388,7 @@ enum ieee80211_mlme_event_status { | |||
388 | }; | 388 | }; |
389 | 389 | ||
390 | /** | 390 | /** |
391 | * enum ieee80211_mlme_event - data attached to an %MLME_EVENT | 391 | * struct ieee80211_mlme_event - data attached to an %MLME_EVENT |
392 | * @data: See &enum ieee80211_mlme_event_data | 392 | * @data: See &enum ieee80211_mlme_event_data |
393 | * @status: See &enum ieee80211_mlme_event_status | 393 | * @status: See &enum ieee80211_mlme_event_status |
394 | * @reason: the reason code if applicable | 394 | * @reason: the reason code if applicable |
@@ -401,9 +401,10 @@ struct ieee80211_mlme_event { | |||
401 | 401 | ||
402 | /** | 402 | /** |
403 | * struct ieee80211_event - event to be sent to the driver | 403 | * struct ieee80211_event - event to be sent to the driver |
404 | * @type The event itself. See &enum ieee80211_event_type. | 404 | * @type: The event itself. See &enum ieee80211_event_type. |
405 | * @rssi: relevant if &type is %RSSI_EVENT | 405 | * @rssi: relevant if &type is %RSSI_EVENT |
406 | * @mlme: relevant if &type is %AUTH_EVENT | 406 | * @mlme: relevant if &type is %AUTH_EVENT |
407 | * @u: union holding the above two fields | ||
407 | */ | 408 | */ |
408 | struct ieee80211_event { | 409 | struct ieee80211_event { |
409 | enum ieee80211_event_type type; | 410 | enum ieee80211_event_type type; |