summaryrefslogtreecommitdiffstats
path: root/net/batman-adv/send.h
diff options
context:
space:
mode:
authorSven Eckelmann2017-12-02 19:51:47 +0100
committerSimon Wunderlich2017-12-15 17:29:20 +0100
commit7e9a8c2ce7c5f8745c003e2ba4758c21c38a0419 (patch)
treea32a07bc993013e2a88a75322ae4bb89e93a3049 /net/batman-adv/send.h
parentbatman-adv: Add missing kernel-doc to packet.h (diff)
downloadkernel-qcow2-linux-7e9a8c2ce7c5f8745c003e2ba4758c21c38a0419.tar.gz
kernel-qcow2-linux-7e9a8c2ce7c5f8745c003e2ba4758c21c38a0419.tar.xz
kernel-qcow2-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/send.h')
-rw-r--r--net/batman-adv/send.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/net/batman-adv/send.h b/net/batman-adv/send.h
index eb36820e41bc..8c7399dd06ca 100644
--- a/net/batman-adv/send.h
+++ b/net/batman-adv/send.h
@@ -77,7 +77,7 @@ int batadv_send_skb_via_gw(struct batadv_priv *bat_priv, struct sk_buff *skb,
unsigned short vid);
/**
- * batadv_send_skb_via_tt - send an skb via TT lookup
+ * batadv_send_skb_via_tt() - send an skb via TT lookup
* @bat_priv: the bat priv with all the soft interface information
* @skb: the payload to send
* @dst_hint: can be used to override the destination contained in the skb
@@ -98,7 +98,7 @@ static inline int batadv_send_skb_via_tt(struct batadv_priv *bat_priv,
}
/**
- * batadv_send_skb_via_tt_4addr - send an skb via TT lookup
+ * batadv_send_skb_via_tt_4addr() - send an skb via TT lookup
* @bat_priv: the bat priv with all the soft interface information
* @skb: the payload to send
* @packet_subtype: the unicast 4addr packet subtype to use