diff options
| author | Sven Eckelmann <sven@narfation.org> | 2017-12-02 19:51:52 +0100 |
|---|---|---|
| committer | Simon Wunderlich <sw@simonwunderlich.de> | 2017-12-15 17:29:23 +0100 |
| commit | e57acf8e93fb65715af7595066d99d4c0c3f0235 (patch) | |
| tree | de305cffed87501d2fe176fcd03c90946c1f9d4d /net/batman-adv/hash.h | |
| parent | 73844a8c78cc975ac43fec05f7c90417f5f99742 (diff) | |
| download | linux-e57acf8e93fb65715af7595066d99d4c0c3f0235.tar.gz linux-e57acf8e93fb65715af7595066d99d4c0c3f0235.tar.bz2 linux-e57acf8e93fb65715af7595066d99d4c0c3f0235.zip | |
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/hash.h')
| -rw-r--r-- | net/batman-adv/hash.h | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/net/batman-adv/hash.h b/net/batman-adv/hash.h index 65396b126f3b..4ce1b6d3ad5c 100644 --- a/net/batman-adv/hash.h +++ b/net/batman-adv/hash.h @@ -121,8 +121,15 @@ out: return ret; } -/* removes data from hash, if found. data could be the structure you use with - * just the key filled, we just need the key for comparing. +/** + * batadv_hash_remove() - Removes data from hash, if found + * @hash: hash table + * @compare: callback to determine if 2 hash elements are identical + * @choose: callback calculating the hash index + * @data: data passed to the aforementioned callbacks as argument + * + * ata could be the structure you use with just the key filled, we just need + * the key for comparing. * * Return: returns pointer do data on success, so you can remove the used * structure yourself, or NULL on error |