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/multicast.h | |
| parent | 7e9a8c2ce7c5f8745c003e2ba4758c21c38a0419 (diff) | |
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/multicast.h')
| -rw-r--r-- | net/batman-adv/multicast.h | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/net/batman-adv/multicast.h b/net/batman-adv/multicast.h index 51f273b5b77d..3ac06337ab71 100644 --- a/net/batman-adv/multicast.h +++ b/net/batman-adv/multicast.h @@ -26,15 +26,21 @@ struct sk_buff; /** * enum batadv_forw_mode - the way a packet should be forwarded as - * @BATADV_FORW_ALL: forward the packet to all nodes (currently via classic - * flooding) - * @BATADV_FORW_SINGLE: forward the packet to a single node (currently via the - * BATMAN unicast routing protocol) - * @BATADV_FORW_NONE: don't forward, drop it */ enum batadv_forw_mode { + /** + * @BATADV_FORW_ALL: forward the packet to all nodes (currently via + * classic flooding) + */ BATADV_FORW_ALL, + + /** + * @BATADV_FORW_SINGLE: forward the packet to a single node (currently + * via the BATMAN unicast routing protocol) + */ BATADV_FORW_SINGLE, + + /** @BATADV_FORW_NONE: don't forward, drop it */ BATADV_FORW_NONE, }; |