aboutsummaryrefslogtreecommitdiffstats
path: root/net/batman-adv/bridge_loop_avoidance.h
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/bridge_loop_avoidance.h
parentbatman-adv: Add missing kernel-doc to packet.h (diff)
downloadlinux-dev-7e9a8c2ce7c5f8745c003e2ba4758c21c38a0419.tar.xz
linux-dev-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/bridge_loop_avoidance.h')
-rw-r--r--net/batman-adv/bridge_loop_avoidance.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/net/batman-adv/bridge_loop_avoidance.h b/net/batman-adv/bridge_loop_avoidance.h
index b568cec819c5..b27571abcd2f 100644
--- a/net/batman-adv/bridge_loop_avoidance.h
+++ b/net/batman-adv/bridge_loop_avoidance.h
@@ -31,8 +31,8 @@ struct seq_file;
struct sk_buff;
/**
- * batadv_bla_is_loopdetect_mac - check if the mac address is from a loop detect
- * frame sent by bridge loop avoidance
+ * batadv_bla_is_loopdetect_mac() - check if the mac address is from a loop
+ * detect frame sent by bridge loop avoidance
* @mac: mac address to check
*
* Return: true if the it looks like a loop detect frame