From f8168c86d3f9a04db090a80aea8e01f058d2df0f Mon Sep 17 00:00:00 2001
From: Oleg Hahm <oleg@hobbykeller.org>
Date: Wed, 16 Apr 2014 12:09:49 +0200
Subject: [PATCH] documentation: fixed organization of 6LoWPAN doxygen
---
sys/net/include/ipv6.h | 21 ++++++++++++---------
sys/net/include/sixlowpan.h | 5 +++--
sys/net/include/sixlowpan/error.h | 2 +-
sys/net/include/sixlowpan/icmp.h | 7 +++++--
sys/net/include/sixlowpan/ip.h | 6 ++++--
sys/net/include/sixlowpan/lowpan.h | 6 ++++--
sys/net/include/sixlowpan/mac.h | 2 +-
sys/net/include/sixlowpan/ndp.h | 16 +++++++++-------
sys/net/include/sixlowpan/types.h | 2 ++
sys/net/network_layer/sixlowpan/icmp.h | 6 ++++--
sys/net/network_layer/sixlowpan/lowpan.h | 8 +-------
11 files changed, 46 insertions(+), 35 deletions(-)
diff --git a/sys/net/include/ipv6.h b/sys/net/include/ipv6.h
index 9d5eabd494..b36e00e7ea 100644
--- a/sys/net/include/ipv6.h
+++ b/sys/net/include/ipv6.h
@@ -1,17 +1,20 @@
-/**
- * ipv6.h - Wraps all API types, constants and functions of
- * 6LoWPAN in layer 3.
- *
- * Copyright (C) 2013 INRIA.
+/*
+ * Copyright (C) 2014 INRIA.
*
* This file is subject to the terms and conditions of the GNU Lesser General
* Public License. See the file LICENSE in the top level directory for more
* details.
- *
- * @ingroup sixlowpan
+ */
+
+/**
+ * @ingroup net_sixlowpan
* @{
- * @file
+ * @file ipv6.h
* @brief IPv6 and ICMP functions
+ *
+ * Wraps all API types, constants and functions of
+ * 6LoWPAN in layer 3.
+ *
* @author Martin Lenders <mlenders@inf.fu-berlin.de>
*/
#ifndef IPV6_H
@@ -25,7 +28,7 @@
#include "../network_layer/sixlowpan/icmp.h" /* TODO: remove if not needed anymore */
+#endif /* IPV6_H */
/**
* @}
*/
-#endif /* IPV6_H */
diff --git a/sys/net/include/sixlowpan.h b/sys/net/include/sixlowpan.h
index fafead8da5..4869cd6c87 100644
--- a/sys/net/include/sixlowpan.h
+++ b/sys/net/include/sixlowpan.h
@@ -31,8 +31,9 @@
* over Low-Power Wireless Personal Area Networks
* (6LoWPANs)
* </a>
- * @{
*
+ *
+ * @{
* @file sixlowpan.h
* @brief 6lowpan link layer and lowpan functions
*
@@ -46,5 +47,5 @@
#include "sixlowpan/lowpan.h"
#include "sixlowpan/mac.h"
-/** @} */
#endif /* SIXLOWPAN_H */
+/** @} */
diff --git a/sys/net/include/sixlowpan/error.h b/sys/net/include/sixlowpan/error.h
index 16e6645ca3..de0ba8ff66 100644
--- a/sys/net/include/sixlowpan/error.h
+++ b/sys/net/include/sixlowpan/error.h
@@ -7,7 +7,7 @@
*/
/**
- * @ingroup net_sixlowpan
+ * @ingroup net_sixlowpan_lowpan
* @{
*
* @file sixlowpan/error.h
diff --git a/sys/net/include/sixlowpan/icmp.h b/sys/net/include/sixlowpan/icmp.h
index 4f21e90e79..6e18dc452c 100644
--- a/sys/net/include/sixlowpan/icmp.h
+++ b/sys/net/include/sixlowpan/icmp.h
@@ -7,10 +7,13 @@
*/
/**
+ * @addtogroup net_sixlowpan_ndp Neighbor discovery
* @ingroup net_sixlowpan
+ * @brief Internet Control Message Protocol version 6
+ *
* @{
*
- * @file sixlowpan/icmp.h
+ * @file include/sixlowpan/icmp.h
* @brief 6LoWPAN ICMP related header
*
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
@@ -243,5 +246,5 @@ void icmpv6_send_neighbor_adv(ipv6_addr_t *src, ipv6_addr_t *dst,
* @return The internet checksum of the given ICMPv6 packet.
*/
uint16_t icmpv6_csum(ipv6_hdr_t *ipv6_buf, icmpv6_hdr_t *icmpv6_buf);
-/** @} */
#endif /* SIXLOWPAN_ICMP_H */
+/** @} */
diff --git a/sys/net/include/sixlowpan/ip.h b/sys/net/include/sixlowpan/ip.h
index a6782aa395..f1cdc77f0b 100644
--- a/sys/net/include/sixlowpan/ip.h
+++ b/sys/net/include/sixlowpan/ip.h
@@ -7,10 +7,12 @@
*/
/**
+ * @defgroup net_sixlowpan_ip IPv6
* @ingroup net_sixlowpan
+ * @brief Internet Protocol version 6
* @{
*
- * @file sixlowpan/ip.h
+ * @file include/sixlowpan/ip.h
* @brief 6LoWPAN constants, data structs, and prototypes for network layer
*
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
@@ -540,5 +542,5 @@ void ipv6_iface_set_routing_provider(ipv6_addr_t *(*next_hop)(ipv6_addr_t *dest)
*/
uint16_t ipv6_csum(ipv6_hdr_t *ipv6_header, uint8_t *buf, uint16_t len, uint8_t proto);
-/** @} */
#endif /* SIXLOWPAN_IP_H */
+/** @} */
diff --git a/sys/net/include/sixlowpan/lowpan.h b/sys/net/include/sixlowpan/lowpan.h
index 67da952f77..73bd74dad7 100644
--- a/sys/net/include/sixlowpan/lowpan.h
+++ b/sys/net/include/sixlowpan/lowpan.h
@@ -7,10 +7,12 @@
*/
/**
+ * @defgroup net_sixlowpan_lowpan 6LoWPAN adaptation layer
* @ingroup net_sixlowpan
+ * @brief IPv6 over LoW Power wireless Area Networks
* @{
*
- * @file sixlowpan/lowpan.h
+ * @file include/sixlowpan/lowpan.h
* @brief 6LoWPAN LoWPAN layer header
*
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
@@ -299,5 +301,5 @@ void sixlowpan_lowpan_print_reassembly_buffers(void);
*/
int sixlowpan_lowpan_init(void);
-/** @} */
#endif /* SIXLOWPAN_LOWPAN_H */
+/** @} */
diff --git a/sys/net/include/sixlowpan/mac.h b/sys/net/include/sixlowpan/mac.h
index 84dbaef90e..1626552ee4 100644
--- a/sys/net/include/sixlowpan/mac.h
+++ b/sys/net/include/sixlowpan/mac.h
@@ -7,7 +7,7 @@
*/
/**
- * @ingroup net_sixlowpan
+ * @ingroup net_sixlowpan_lowpan
* @{
*
* @file sixlowpan/mac.h
diff --git a/sys/net/include/sixlowpan/ndp.h b/sys/net/include/sixlowpan/ndp.h
index b941ae44b7..9b5f6b9908 100644
--- a/sys/net/include/sixlowpan/ndp.h
+++ b/sys/net/include/sixlowpan/ndp.h
@@ -7,7 +7,9 @@
*/
/**
+ * @addtogroup net_sixlowpan_ndp
* @ingroup net_sixlowpan
+ * @brief Neighbor discovery protocol for 6LoWPAN and IPv6
* @{
*
* @file sixlowpan/ndp.h
@@ -30,13 +32,13 @@
#define NDP_6LOWPAN_CONTEXT_MAX (16)
-#define NDP_OPT_SLLAO_TYPE (1)
-#define NDP_OPT_TLLAO_TYPE (2)
-#define NDP_OPT_PI_VLIFETIME_INFINITE (0xffffffff)
-#define NDP_OPT_PI_PLIFETIME_INFINITE (0xffffffff)
-#define NDP_OPT_ARO_STATE_SUCCESS (0)
-#define NDP_OPT_ARO_STATE_DUP_ADDR (1)
-#define NDP_OPT_ARO_STATE_NBR_CACHE_FULL (2)
+#define NDP_OPT_SLLAO_TYPE (1)
+#define NDP_OPT_TLLAO_TYPE (2)
+#define NDP_OPT_PI_VLIFETIME_INFINITE (0xffffffff)
+#define NDP_OPT_PI_PLIFETIME_INFINITE (0xffffffff)
+#define NDP_OPT_ARO_STATE_SUCCESS (0)
+#define NDP_OPT_ARO_STATE_DUP_ADDR (1)
+#define NDP_OPT_ARO_STATE_NBR_CACHE_FULL (2)
/**
* @brief Neighbor cache entry state according to
diff --git a/sys/net/include/sixlowpan/types.h b/sys/net/include/sixlowpan/types.h
index d8ebc0334e..7923beaedf 100644
--- a/sys/net/include/sixlowpan/types.h
+++ b/sys/net/include/sixlowpan/types.h
@@ -7,7 +7,9 @@
*/
/**
+ * @defgroup net_sixlowpan_types Type definitions and data structs for 6LoWPAN and IPv6
* @ingroup net_sixlowpan
+ * @brief Structs, constants, and enums for 6LoWPAN and IPv6 related functions
* @{
*
* @file sixlowpan/types.h
diff --git a/sys/net/network_layer/sixlowpan/icmp.h b/sys/net/network_layer/sixlowpan/icmp.h
index a1fcf2f12b..c1abde0dc1 100644
--- a/sys/net/network_layer/sixlowpan/icmp.h
+++ b/sys/net/network_layer/sixlowpan/icmp.h
@@ -6,8 +6,10 @@
* This file is subject to the terms and conditions of the GNU Lesser General
* Public License. See the file LICENSE in the top level directory for more
* details.
- *
- * @ingroup sixlowpan
+ */
+
+/**
+ * @ingroup net_sixlowpan
* @{
* @file sixlownd.h
* @brief 6lowpan neighbor discovery constants, data structs, and prototypes
diff --git a/sys/net/network_layer/sixlowpan/lowpan.h b/sys/net/network_layer/sixlowpan/lowpan.h
index e1c1af1a00..689f3438e3 100644
--- a/sys/net/network_layer/sixlowpan/lowpan.h
+++ b/sys/net/network_layer/sixlowpan/lowpan.h
@@ -7,12 +7,7 @@
*/
/**
- * @defgroup net_sixlowpan 6LoWPAN
- * @ingroup net
- * @brief RIOTs 6LowPAN implementation
- * @{
- *
- * @file lowpan.h
+ * @file network_layer/sixlowpan/lowpan.h
* @brief 6lowpan header
*
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
@@ -53,5 +48,4 @@ lowpan_context_t *lowpan_context_update(uint8_t num,
lowpan_context_t *lowpan_context_get(void);
lowpan_context_t *lowpan_context_num_lookup(uint8_t num);
-/** @} */
#endif /* _SIXLOWPAN_LOWPAN_H */
--
GitLab