summaryrefslogtreecommitdiffstats
path: root/net/batman-adv/bitarray.h
diff options
context:
space:
mode:
authorSven Eckelmann <sven@narfation.org>2015-09-15 19:00:48 +0200
committerAntonio Quartulli <a@unstable.cc>2016-02-02 12:40:31 +0800
commit62fe710f6e2fdf4c337763bc0774cb3232fa2139 (patch)
tree1491351056a65db85e60ad91ad896c5b6942cd25 /net/batman-adv/bitarray.h
parentd1f6825067b9c167b3853c9af67e68d5412c2c63 (diff)
downloadlinux-62fe710f6e2fdf4c337763bc0774cb3232fa2139.tar.gz
linux-62fe710f6e2fdf4c337763bc0774cb3232fa2139.tar.bz2
linux-62fe710f6e2fdf4c337763bc0774cb3232fa2139.zip
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/bitarray.h')
-rw-r--r--net/batman-adv/bitarray.h11
1 files changed, 8 insertions, 3 deletions
diff --git a/net/batman-adv/bitarray.h b/net/batman-adv/bitarray.h
index 0226b220fe5b..cf2aeb0831a4 100644
--- a/net/batman-adv/bitarray.h
+++ b/net/batman-adv/bitarray.h
@@ -24,7 +24,10 @@
#include <linux/compiler.h>
#include <linux/types.h>
-/* Returns 1 if the corresponding bit in the given seq_bits indicates true
+/**
+ * batadv_test_bit
+ *
+ * Return: 1 if the corresponding bit in the given seq_bits indicates true
* and curr_seqno is within range of last_seqno. Otherwise returns 0.
*/
static inline int batadv_test_bit(const unsigned long *seq_bits,
@@ -48,8 +51,10 @@ static inline void batadv_set_bit(unsigned long *seq_bits, s32 n)
set_bit(n, seq_bits); /* turn the position on */
}
-/* receive and process one packet, returns 1 if received seq_num is considered
- * new, 0 if old
+/**
+ * batadv_bit_get_packet - receive and process one packet
+ *
+ * Return: 1 if received seq_num is considered new, 0 if old
*/
int batadv_bit_get_packet(void *priv, unsigned long *seq_bits, s32 seq_num_diff,
int set_mark);