diff options
author | Sven Eckelmann <sven@narfation.org> | 2017-12-02 21:51:50 +0300 |
---|---|---|
committer | Simon Wunderlich <sw@simonwunderlich.de> | 2017-12-15 19:29:22 +0300 |
commit | c93effcf721ee0a171457fd2ef63367516e45d46 (patch) | |
tree | 7b8e7b68c3afe755cac94df234af5c2e0c29d1a8 /net/batman-adv/sysfs.h | |
parent | a07369d7fb0df37c61f271280b7497a882a3d291 (diff) | |
download | linux-c93effcf721ee0a171457fd2ef63367516e45d46.tar.xz |
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>
Diffstat (limited to 'net/batman-adv/sysfs.h')
-rw-r--r-- | net/batman-adv/sysfs.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/net/batman-adv/sysfs.h b/net/batman-adv/sysfs.h index 0384cb6c406b..bbeee61221fa 100644 --- 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); }; |