From: Antonio Quartulli Date: Sat, 22 Feb 2014 16:02:38 +0000 (+0100) Subject: batman-adv: improve DAT documentation X-Git-Tag: v5.15~18171^2~107^2~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=151dcb3c56f56e1e5d75247f0dccdb5f6526cf39;p=platform%2Fkernel%2Flinux-starfive.git batman-adv: improve DAT documentation Add missing documentation for BATADV_DAT_ADDR_MAX and convert an existing documentation to kerneldoc Signed-off-by: Antonio Quartulli Signed-off-by: Marek Lindner --- diff --git a/net/batman-adv/distributed-arp-table.h b/net/batman-adv/distributed-arp-table.h index ac9be9b..d76e1d0 100644 --- a/net/batman-adv/distributed-arp-table.h +++ b/net/batman-adv/distributed-arp-table.h @@ -25,6 +25,9 @@ #include +/** + * BATADV_DAT_ADDR_MAX - maximum address value in the DHT space + */ #define BATADV_DAT_ADDR_MAX ((batadv_dat_addr_t)~(batadv_dat_addr_t)0) void batadv_dat_status_update(struct net_device *net_dev); diff --git a/net/batman-adv/types.h b/net/batman-adv/types.h index d4b923c..34891a5 100644 --- a/net/batman-adv/types.h +++ b/net/batman-adv/types.h @@ -24,8 +24,9 @@ #ifdef CONFIG_BATMAN_ADV_DAT -/* batadv_dat_addr_t is the type used for all DHT addresses. If it is changed, - * BATADV_DAT_ADDR_MAX is changed as well. +/** + * batadv_dat_addr_t - it is the type used for all DHT addresses. If it is + * changed, BATADV_DAT_ADDR_MAX is changed as well. * * *Please be careful: batadv_dat_addr_t must be UNSIGNED* */