diff options
| author |  Sven Eckelmann <sven@narfation.org>
| 2017-12-02 19:51:48 +0100 |
|---|---|---|
| committer |  Simon Wunderlich <sw@simonwunderlich.de>
| 2017-12-15 17:29:20 +0100 |
| commit | 8b84cc4fb556b24fcd2c9529ad4b13556258f668 (patch) | |
| tree | 0df7e1324f214d83f31e5818d4fd28c18813deb0 /net/batman-adv/gateway_common.h | |
| parent | batman-adv: Use parentheses in function kernel-doc (diff) | |
| download | linux-8b84cc4fb556b24fcd2c9529ad4b13556258f668.tar.gz linux-8b84cc4fb556b24fcd2c9529ad4b13556258f668.tar.bz2 linux-8b84cc4fb556b24fcd2c9529ad4b13556258f668.zip | |
batman-adv: Use inline kernel-doc for enum/struct
The inline kernel-doc comments make it easier to keep changes to the
struct/enum synchronized with the documentation of the it. And it makes it
easier for larger structures like struct batadv_priv to read the
documentation inside the code.
Signed-off-by: Sven Eckelmann <sven@narfation.org>
Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>
Diffstat (limited to 'net/batman-adv/gateway_common.h')
| -rw-r--r-- | net/batman-adv/gateway_common.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/net/batman-adv/gateway_common.h b/net/batman-adv/gateway_common.h index 7c298b05c1dc..afebd9c7edf4 100644 --- a/net/batman-adv/gateway_common.h +++ b/net/batman-adv/gateway_common.h @@ -33,11 +33,12 @@ enum batadv_gw_modes { /** * enum batadv_bandwidth_units - bandwidth unit types - * @BATADV_BW_UNIT_KBIT: unit type kbit - * @BATADV_BW_UNIT_MBIT: unit type mbit */ enum batadv_bandwidth_units { + /** @BATADV_BW_UNIT_KBIT: unit type kbit */ BATADV_BW_UNIT_KBIT, + + /** @BATADV_BW_UNIT_MBIT: unit type mbit */ BATADV_BW_UNIT_MBIT, }; |