diff options
| author | Sven Eckelmann <sven@narfation.org> | 2017-12-02 19:51:53 +0100 |
|---|---|---|
| committer | Simon Wunderlich <sw@simonwunderlich.de> | 2017-12-15 17:29:24 +0100 |
| commit | ff15c27c97303fbe5abc49c25c73ea299ab72d31 (patch) | |
| tree | ec78240c800bdf7a1ef3322175c5648a9ffa6d41 /net/batman-adv/hash.c | |
| parent | e57acf8e93fb65715af7595066d99d4c0c3f0235 (diff) | |
batman-adv: Add kernel-doc to externally visible functions
According to the kernel-doc documentation, externally visible functions
should be documented. This refers to all all non-static function which can
(and will) be used by functions in other sources files.
Signed-off-by: Sven Eckelmann <sven@narfation.org>
Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>
Diffstat (limited to 'net/batman-adv/hash.c')
| -rw-r--r-- | net/batman-adv/hash.c | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/net/batman-adv/hash.c b/net/batman-adv/hash.c index 2ce0d5673f40..04d964358c98 100644 --- a/net/batman-adv/hash.c +++ b/net/batman-adv/hash.c @@ -34,7 +34,10 @@ static void batadv_hash_init(struct batadv_hashtable *hash) } } -/* free only the hashtable and the hash itself. */ +/** + * batadv_hash_destroy() - Free only the hashtable and the hash itself + * @hash: hash object to destroy + */ void batadv_hash_destroy(struct batadv_hashtable *hash) { kfree(hash->list_locks); @@ -42,7 +45,12 @@ void batadv_hash_destroy(struct batadv_hashtable *hash) kfree(hash); } -/* allocates and clears the hash */ +/** + * batadv_hash_new() - Allocates and clears the hashtable + * @size: number of hash buckets to allocate + * + * Return: newly allocated hashtable, NULL on errors + */ struct batadv_hashtable *batadv_hash_new(u32 size) { struct batadv_hashtable *hash; @@ -71,6 +79,11 @@ free_hash: return NULL; } +/** + * batadv_hash_set_lock_class() - Set specific lockdep class for hash spinlocks + * @hash: hash object to modify + * @key: lockdep class key address + */ void batadv_hash_set_lock_class(struct batadv_hashtable *hash, struct lock_class_key *key) { |