summaryrefslogtreecommitdiff
path: root/net/batman-adv/bat_algo.c
diff options
context:
space:
mode:
authorSven Eckelmann <sven@narfation.org>2017-12-02 21:51:47 +0300
committerSimon Wunderlich <sw@simonwunderlich.de>2017-12-15 19:29:20 +0300
commit7e9a8c2ce7c5f8745c003e2ba4758c21c38a0419 (patch)
treea32a07bc993013e2a88a75322ae4bb89e93a3049 /net/batman-adv/bat_algo.c
parent6a3038f07c59152fb640a3cd274afdf909640e4b (diff)
downloadlinux-7e9a8c2ce7c5f8745c003e2ba4758c21c38a0419.tar.xz
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/bat_algo.c')
-rw-r--r--net/batman-adv/bat_algo.c7
1 files changed, 4 insertions, 3 deletions
diff --git a/net/batman-adv/bat_algo.c b/net/batman-adv/bat_algo.c
index fa306b25a78b..aed7ced059df 100644
--- a/net/batman-adv/bat_algo.c
+++ b/net/batman-adv/bat_algo.c
@@ -38,7 +38,8 @@ char batadv_routing_algo[20] = "BATMAN_IV";
static struct hlist_head batadv_algo_list;
/**
- * batadv_algo_init - Initialize batman-adv algorithm management data structures
+ * batadv_algo_init() - Initialize batman-adv algorithm management data
+ * structures
*/
void batadv_algo_init(void)
{
@@ -149,7 +150,7 @@ module_param_cb(routing_algo, &batadv_param_ops_ra, &batadv_param_string_ra,
0644);
/**
- * batadv_algo_dump_entry - fill in information about one supported routing
+ * batadv_algo_dump_entry() - fill in information about one supported routing
* algorithm
* @msg: netlink message to be sent back
* @portid: Port to reply to
@@ -180,7 +181,7 @@ static int batadv_algo_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
}
/**
- * batadv_algo_dump - fill in information about supported routing
+ * batadv_algo_dump() - fill in information about supported routing
* algorithms
* @msg: netlink message to be sent back
* @cb: Parameters to the netlink request