From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: From: Antonio Quartulli Date: Sat, 22 Feb 2014 17:02:38 +0100 Message-Id: <1393084958-2133-1-git-send-email-antonio@meshcoding.com> Subject: [B.A.T.M.A.N.] [PATCH] batman-adv: improve DAT documentation Reply-To: The list for a Better Approach To Mobile Ad-hoc Networking List-Id: The list for a Better Approach To Mobile Ad-hoc Networking List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: b.a.t.m.a.n@lists.open-mesh.org Cc: Antonio Quartulli From: Antonio Quartulli Add missing documentation for BATADV_DAT_ADDR_MAX and convert an existing documentation to kerneldoc Signed-off-by: Antonio Quartulli --- distributed-arp-table.h | 3 +++ types.h | 5 +++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/distributed-arp-table.h b/distributed-arp-table.h index ac9be9b..d76e1d0 100644 --- a/distributed-arp-table.h +++ b/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/types.h b/types.h index d4b923c..34891a5 100644 --- a/types.h +++ b/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* */ -- 1.8.4.5