summaryrefslogtreecommitdiffstats
path: root/net/batman-adv
diff options
context:
space:
mode:
authorAntonio Quartulli <antonio@open-mesh.com>2014-02-22 17:02:38 +0100
committerAntonio Quartulli <antonio@meshcoding.com>2014-03-22 09:18:59 +0100
commit151dcb3c56f56e1e5d75247f0dccdb5f6526cf39 (patch)
treea6beb5b00f15ca0cb4ca9cc18f361a75c397cf74 /net/batman-adv
parent43e6f65a3d777d8edf9f8d5083022a98baac850a (diff)
downloadlinux-151dcb3c56f56e1e5d75247f0dccdb5f6526cf39.tar.gz
linux-151dcb3c56f56e1e5d75247f0dccdb5f6526cf39.tar.bz2
linux-151dcb3c56f56e1e5d75247f0dccdb5f6526cf39.zip
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 <antonio@open-mesh.com> Signed-off-by: Marek Lindner <mareklindner@neomailbox.ch>
Diffstat (limited to 'net/batman-adv')
-rw-r--r--net/batman-adv/distributed-arp-table.h3
-rw-r--r--net/batman-adv/types.h5
2 files changed, 6 insertions, 2 deletions
diff --git a/net/batman-adv/distributed-arp-table.h b/net/batman-adv/distributed-arp-table.h
index ac9be9b67a25..d76e1d06c5b5 100644
--- a/net/batman-adv/distributed-arp-table.h
+++ b/net/batman-adv/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/net/batman-adv/types.h b/net/batman-adv/types.h
index d4b923c7229c..34891a56773f 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*
*/