diff mbox

batman-adv: improve DAT documentation

Message ID 1393084958-2133-1-git-send-email-antonio@meshcoding.com (mailing list archive)
State Accepted, archived
Commit 62ea441ee6ecdaa6187fab1458cbcc7e32429d2c
Headers

Commit Message

Antonio Quartulli Feb. 22, 2014, 4:02 p.m. UTC 
  From: Antonio Quartulli <antonio@open-mesh.com>

Add missing documentation for BATADV_DAT_ADDR_MAX and
convert an existing documentation to kerneldoc

Signed-off-by: Antonio Quartulli <antonio@open-mesh.com>
---
 distributed-arp-table.h | 3 +++
 types.h                 | 5 +++--
 2 files changed, 6 insertions(+), 2 deletions(-)

Comments

Marek Lindner March 11, 2014, 10:16 a.m. UTC | #1 
On Saturday 22 February 2014 17:02:38 Antonio Quartulli wrote:
> From: Antonio Quartulli <antonio@open-mesh.com>
> 
> Add missing documentation for BATADV_DAT_ADDR_MAX and
> convert an existing documentation to kerneldoc
> 
> Signed-off-by: Antonio Quartulli <antonio@open-mesh.com>
> ---
>  distributed-arp-table.h | 3 +++
>  types.h                 | 5 +++--
>  2 files changed, 6 insertions(+), 2 deletions(-)

Applied in revision 62ea441.

Thanks,
Marek
diff mbox

Patch

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 <linux/if_arp.h>
 
+/**
+ * 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*
  */