diff options
| author | Sven Eckelmann <sven@narfation.org> | 2015-09-15 19:00:48 +0200 |
|---|---|---|
| committer | Antonio Quartulli <a@unstable.cc> | 2016-02-02 12:40:31 +0800 |
| commit | 62fe710f6e2fdf4c337763bc0774cb3232fa2139 (patch) | |
| tree | 1491351056a65db85e60ad91ad896c5b6942cd25 /net/batman-adv/main.h | |
| parent | d1f6825067b9c167b3853c9af67e68d5412c2c63 (diff) | |
| download | linux-62fe710f6e2fdf4c337763bc0774cb3232fa2139.tar.bz2 | |
batman-adv: Fix kerneldoc parsing of return description
Signed-off-by: Sven Eckelmann <sven@narfation.org>
Signed-off-by: Marek Lindner <mareklindner@neomailbox.ch>
Signed-off-by: Antonio Quartulli <a@unstable.cc>
Diffstat (limited to 'net/batman-adv/main.h')
| -rw-r--r-- | net/batman-adv/main.h | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/net/batman-adv/main.h b/net/batman-adv/main.h index 9dbd9107e7e1..8a48d4a40828 100644 --- a/net/batman-adv/main.h +++ b/net/batman-adv/main.h @@ -273,9 +273,12 @@ static inline void _batadv_dbg(int type __always_unused, pr_err("%s: " fmt, _netdev->name, ## arg); \ } while (0) -/* returns 1 if they are the same ethernet addr +/** + * batadv_compare_eth - Compare two not u16 aligned Ethernet addresses * * note: can't use ether_addr_equal() as it requires aligned memory + * + * Return: 1 if they are the same ethernet addr */ static inline bool batadv_compare_eth(const void *data1, const void *data2) { @@ -287,7 +290,7 @@ static inline bool batadv_compare_eth(const void *data1, const void *data2) * @timestamp: base value to compare with (in jiffies) * @timeout: added to base value before comparing (in milliseconds) * - * Returns true if current time is after timestamp + timeout + * Return: true if current time is after timestamp + timeout */ static inline bool batadv_has_timed_out(unsigned long timestamp, unsigned int timeout) @@ -326,7 +329,11 @@ static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx, #define batadv_inc_counter(b, i) batadv_add_counter(b, i, 1) -/* Sum and return the cpu-local counters for index 'idx' */ +/** + * batadv_sum_counter - Sum the cpu-local counters for index 'idx' + * + * Return: sum of all cpu-local counters + */ static inline u64 batadv_sum_counter(struct batadv_priv *bat_priv, size_t idx) { u64 *counters, sum = 0; |