summaryrefslogtreecommitdiff
path: root/net/batman-adv/bitarray.h
diff options
context:
space:
mode:
authorSven Eckelmann <sven@narfation.org>2017-12-02 19:51:52 +0100
committerSimon Wunderlich <sw@simonwunderlich.de>2017-12-15 17:29:23 +0100
commite57acf8e93fb65715af7595066d99d4c0c3f0235 (patch)
treede305cffed87501d2fe176fcd03c90946c1f9d4d /net/batman-adv/bitarray.h
parent73844a8c78cc975ac43fec05f7c90417f5f99742 (diff)
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/bitarray.h')
-rw-r--r--net/batman-adv/bitarray.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/net/batman-adv/bitarray.h b/net/batman-adv/bitarray.h
index 0508353fa28d..ca9d0753dd6b 100644
--- a/net/batman-adv/bitarray.h
+++ b/net/batman-adv/bitarray.h
@@ -47,7 +47,12 @@ static inline bool batadv_test_bit(const unsigned long *seq_bits,
return test_bit(diff, seq_bits) != 0;
}
-/* turn corresponding bit on, so we can remember that we got the packet */
+/**
+ * batadv_set_bit() - Turn corresponding bit on, so we can remember that we got
+ * the packet
+ * @seq_bits: bitmap of the packet receive window
+ * @n: relative sequence number of newly received packet
+ */
static inline void batadv_set_bit(unsigned long *seq_bits, s32 n)
{
/* if too old, just drop it */