summaryrefslogtreecommitdiffstats
path: root/net/batman-adv/bitarray.c
diff options
context:
space:
mode:
authorSven Eckelmann <sven@narfation.org>2017-12-02 19:51:47 +0100
committerSimon Wunderlich <sw@simonwunderlich.de>2017-12-15 17:29:20 +0100
commit7e9a8c2ce7c5f8745c003e2ba4758c21c38a0419 (patch)
treea32a07bc993013e2a88a75322ae4bb89e93a3049 /net/batman-adv/bitarray.c
parentbatman-adv: Add missing kernel-doc to packet.h (diff)
downloadlinux-7e9a8c2ce7c5f8745c003e2ba4758c21c38a0419.tar.xz
linux-7e9a8c2ce7c5f8745c003e2ba4758c21c38a0419.zip
batman-adv: Use parentheses in function kernel-doc
The documentation describing kernel-doc comments for functions ("How to format kernel-doc comments") uses parentheses at the end of the function name. Using this format allows to use a consistent style when adding documentation to a function and when referencing this function in a different kernel-doc section. Signed-off-by: Sven Eckelmann <sven@narfation.org> Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>
Diffstat (limited to 'net/batman-adv/bitarray.c')
-rw-r--r--net/batman-adv/bitarray.c2
1 files changed, 1 insertions, 1 deletions
diff --git a/net/batman-adv/bitarray.c b/net/batman-adv/bitarray.c
index 125817c389e5..bdc1ef06e05b 100644
--- a/net/batman-adv/bitarray.c
+++ b/net/batman-adv/bitarray.c
@@ -33,7 +33,7 @@ static void batadv_bitmap_shift_left(unsigned long *seq_bits, s32 n)
}
/**
- * batadv_bit_get_packet - receive and process one packet within the sequence
+ * batadv_bit_get_packet() - receive and process one packet within the sequence
* number window
* @priv: the bat priv with all the soft interface information
* @seq_bits: pointer to the sequence number receive packet