summaryrefslogtreecommitdiff
path: root/net/batman-adv/originator.h
diff options
context:
space:
mode:
authorSven Eckelmann <sven@narfation.org>2017-12-02 21:51:52 +0300
committerSimon Wunderlich <sw@simonwunderlich.de>2017-12-15 19:29:23 +0300
commite57acf8e93fb65715af7595066d99d4c0c3f0235 (patch)
treede305cffed87501d2fe176fcd03c90946c1f9d4d /net/batman-adv/originator.h
parent73844a8c78cc975ac43fec05f7c90417f5f99742 (diff)
downloadlinux-e57acf8e93fb65715af7595066d99d4c0c3f0235.tar.xz
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/originator.h')
-rw-r--r--net/batman-adv/originator.h9
1 files changed, 7 insertions, 2 deletions
diff --git a/net/batman-adv/originator.h b/net/batman-adv/originator.h
index b5d2164532c9..8e543a3cdc6c 100644
--- a/net/batman-adv/originator.h
+++ b/net/batman-adv/originator.h
@@ -84,8 +84,13 @@ batadv_orig_node_vlan_get(struct batadv_orig_node *orig_node,
unsigned short vid);
void batadv_orig_node_vlan_put(struct batadv_orig_node_vlan *orig_vlan);
-/* hashfunction to choose an entry in a hash table of given size
- * hash algorithm from http://en.wikipedia.org/wiki/Hash_table
+/**
+ * batadv_choose_orig() - Return the index of the orig entry in the hash table
+ * @data: mac address of the originator node
+ * @size: the size of the hash table
+ *
+ * Return: the hash index where the object represented by @data should be
+ * stored at.
*/
static inline u32 batadv_choose_orig(const void *data, u32 size)
{