diff options
| author |   Sven Eckelmann <sven@narfation.org> | 2017-12-02 19:51:52 +0100 |
|---|---|---|
| committer |   Simon Wunderlich <sw@simonwunderlich.de> | 2017-12-15 17:29:23 +0100 |
| commit | e57acf8e93fb65715af7595066d99d4c0c3f0235 (patch) | |
| tree | de305cffed87501d2fe176fcd03c90946c1f9d4d /net/batman-adv/hard-interface.h | |
| parent | batman-adv: Add kernel-doc to enums in headers (diff) | |
| download | linux-dev-e57acf8e93fb65715af7595066d99d4c0c3f0235.tar.xz linux-dev-e57acf8e93fb65715af7595066d99d4c0c3f0235.zip | |
batman-adv: Add kernel-doc to functions in headers
Externally visible functions should be documented with kernel-doc. This
usually refers to non-static functions but also static inline files in
headers are visible in other files and should therefore be documented.
Signed-off-by: Sven Eckelmann <sven@narfation.org>
Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>
Diffstat (limited to 'net/batman-adv/hard-interface.h')
| -rw-r--r-- | net/batman-adv/hard-interface.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/net/batman-adv/hard-interface.h b/net/batman-adv/hard-interface.h index 1e61aacac539..de5e9a374ece 100644 --- a/net/batman-adv/hard-interface.h +++ b/net/batman-adv/hard-interface.h @@ -130,6 +130,12 @@ static inline void batadv_hardif_put(struct batadv_hard_iface *hard_iface) kref_put(&hard_iface->refcount, batadv_hardif_release); } +/** + * batadv_primary_if_get_selected() - Get reference to primary interface + * @bat_priv: the bat priv with all the soft interface information + * + * Return: primary interface (with increased refcnt), otherwise NULL + */ static inline struct batadv_hard_iface * batadv_primary_if_get_selected(struct batadv_priv *bat_priv) { |