batman-adv: Add kernel-doc to structs in headers

All structs in types.h are already documented. But some other headers
still have private structs which also should be documented.

Signed-off-by: Sven Eckelmann <sven@narfation.org>
Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>

diff --git a/net/batman-adv/hash.h b/net/batman-adv/hash.h
index c92fde593959f3cc26bf95e5e53f08acfe872605..65396b126f3b1a55dbbf81ad5acc734401aa2edd 100644 (file)
--- a/net/batman-adv/hash.h
+++ b/net/batman-adv/hash.h
@@ -46,10 +46,18 @@ typedef bool (*batadv_hashdata_compare_cb)(const struct hlist_node *,
 typedef u32 (*batadv_hashdata_choose_cb)(const void *, u32);
 typedef void (*batadv_hashdata_free_cb)(struct hlist_node *, void *);
 
+/**
+ * struct batadv_hashtable - Wrapper of simple hlist based hashtable
+ */
 struct batadv_hashtable {
-       struct hlist_head *table;   /* the hashtable itself with the buckets */
-       spinlock_t *list_locks;     /* spinlock for each hash list entry */
-       u32 size;                   /* size of hashtable */
+       /** @table: the hashtable itself with the buckets */
+       struct hlist_head *table;
+
+       /** @list_locks: spinlock for each hash list entry */
+       spinlock_t *list_locks;
+
+       /** @size: size of hashtable */
+       u32 size;
 };
 
 /* allocates and clears the hash */

diff --git a/net/batman-adv/sysfs.h b/net/batman-adv/sysfs.h
index 0384cb6c406b759342acf6b3d868ed90ff4d0810..bbeee61221fae6b9e1ca69cb4da8fc23483705a9 100644 (file)
--- a/net/batman-adv/sysfs.h
+++ b/net/batman-adv/sysfs.h
@@ -36,10 +36,23 @@ struct net_device;
  */
 #define BATADV_SYSFS_VLAN_SUBDIR_PREFIX "vlan"
 
+/**
+ * struct batadv_attribute - sysfs export helper for batman-adv attributes
+ */
 struct batadv_attribute {
+       /** @attr: sysfs attribute file */
        struct attribute attr;
+
+       /**
+        * @show: function to export the current attribute's content to sysfs
+        */
        ssize_t (*show)(struct kobject *kobj, struct attribute *attr,
                        char *buf);
+
+       /**
+        * @store: function to load new value from character buffer and save it
+        * in batman-adv attribute
+        */
        ssize_t (*store)(struct kobject *kobj, struct attribute *attr,
                         char *buf, size_t count);
 };