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/bat_iv_ogm.c | |
| parent | batman-adv: Use parentheses in function kernel-doc (diff) | |
| download | linux-dev-8b84cc4fb556b24fcd2c9529ad4b13556258f668.tar.xz linux-dev-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/bat_iv_ogm.c')
| -rw-r--r-- | net/batman-adv/bat_iv_ogm.c | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/net/batman-adv/bat_iv_ogm.c b/net/batman-adv/bat_iv_ogm.c index 1fc67aa8d7df..0973e8c5a063 100644 --- a/net/batman-adv/bat_iv_ogm.c +++ b/net/batman-adv/bat_iv_ogm.c @@ -73,16 +73,23 @@ static void batadv_iv_send_outstanding_bat_ogm_packet(struct work_struct *work); /** * enum batadv_dup_status - duplicate status - * @BATADV_NO_DUP: the packet is no duplicate - * @BATADV_ORIG_DUP: OGM is a duplicate in the originator (but not for the - * neighbor) - * @BATADV_NEIGH_DUP: OGM is a duplicate for the neighbor - * @BATADV_PROTECTED: originator is currently protected (after reboot) */ enum batadv_dup_status { + /** @BATADV_NO_DUP: the packet is no duplicate */ BATADV_NO_DUP = 0, + + /** + * @BATADV_ORIG_DUP: OGM is a duplicate in the originator (but not for + * the neighbor) + */ BATADV_ORIG_DUP, + + /** @BATADV_NEIGH_DUP: OGM is a duplicate for the neighbor */ BATADV_NEIGH_DUP, + + /** + * @BATADV_PROTECTED: originator is currently protected (after reboot) + */ BATADV_PROTECTED, }; |