diff --git a/sys/net/include/ipv6.h b/sys/net/include/ipv6.h index 9d5eabd494c3083d6d9f0ab6f9c0e98404f4acf1..b36e00e7ea2db4937e038bb51c7c6d008cfa7077 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 fafead8da55614a6df39b8d543eb6ed92ca42333..4869cd6c87a3a7ad5d00b38a48a12364d874c9ec 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 16e6645ca37567218570c527e0fc68817cefe011..de0ba8ff6627110c1bbea0d7e2012f14c5f9949f 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 4f21e90e7996beefb8466e1d5b0d02a831a1116b..6e18dc452cbf624fc1eab61b871c4916985a79f7 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 a6782aa3955c2ed19a036774ce1781596187706a..f1cdc77f0b732e3abb9224850bb4d9462ac24b94 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 67da952f7741a83b0bb2d2ffb1285c65a3ecd8a7..73bd74dad7604f6a6290d52996a857a3d2d11c22 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 84dbaef90e17abbdec0f6237d26b6fe4a0f030d9..1626552ee4ddfc1f2a60667cfd1358e394453af6 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 b941ae44b73414ac8a42aeb7dfed7e0501b25917..9b5f6b99081b24cadffbf56db04754b2945e8513 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 d8ebc0334e56815138abfe3b4a029ea8678c1757..7923beaedf5520dd07be844c640219098fd32968 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 a1fcf2f12ba01e558e9bb67d69548b4788f35266..c1abde0dc182e42b0b91806edc63ddc459172da9 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 e1c1af1a0029e5286a0dce1a4f051b400c84b375..689f3438e3ef8f34f97c0b91609d185e07b3d50a 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 */