Skip to content
Snippets Groups Projects
Commit f8168c86 authored by Oleg Hahm's avatar Oleg Hahm
Browse files

documentation: fixed organization of 6LoWPAN doxygen

parent 9efc0d22
No related branches found
No related tags found
No related merge requests found
/** /*
* ipv6.h - Wraps all API types, constants and functions of * Copyright (C) 2014 INRIA.
* 6LoWPAN in layer 3.
*
* Copyright (C) 2013 INRIA.
* *
* This file is subject to the terms and conditions of the GNU Lesser General * 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 * Public License. See the file LICENSE in the top level directory for more
* details. * details.
* */
* @ingroup sixlowpan
/**
* @ingroup net_sixlowpan
* @{ * @{
* @file * @file ipv6.h
* @brief IPv6 and ICMP functions * @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> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
*/ */
#ifndef IPV6_H #ifndef IPV6_H
...@@ -25,7 +28,7 @@ ...@@ -25,7 +28,7 @@
#include "../network_layer/sixlowpan/icmp.h" /* TODO: remove if not needed anymore */ #include "../network_layer/sixlowpan/icmp.h" /* TODO: remove if not needed anymore */
#endif /* IPV6_H */
/** /**
* @} * @}
*/ */
#endif /* IPV6_H */
...@@ -31,8 +31,9 @@ ...@@ -31,8 +31,9 @@
* over Low-Power Wireless Personal Area Networks * over Low-Power Wireless Personal Area Networks
* (6LoWPANs) * (6LoWPANs)
* </a> * </a>
* @{
* *
*
* @{
* @file sixlowpan.h * @file sixlowpan.h
* @brief 6lowpan link layer and lowpan functions * @brief 6lowpan link layer and lowpan functions
* *
...@@ -46,5 +47,5 @@ ...@@ -46,5 +47,5 @@
#include "sixlowpan/lowpan.h" #include "sixlowpan/lowpan.h"
#include "sixlowpan/mac.h" #include "sixlowpan/mac.h"
/** @} */
#endif /* SIXLOWPAN_H */ #endif /* SIXLOWPAN_H */
/** @} */
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup net_sixlowpan * @ingroup net_sixlowpan_lowpan
* @{ * @{
* *
* @file sixlowpan/error.h * @file sixlowpan/error.h
......
...@@ -7,10 +7,13 @@ ...@@ -7,10 +7,13 @@
*/ */
/** /**
* @addtogroup net_sixlowpan_ndp Neighbor discovery
* @ingroup net_sixlowpan * @ingroup net_sixlowpan
* @brief Internet Control Message Protocol version 6
*
* @{ * @{
* *
* @file sixlowpan/icmp.h * @file include/sixlowpan/icmp.h
* @brief 6LoWPAN ICMP related header * @brief 6LoWPAN ICMP related header
* *
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @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, ...@@ -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. * @return The internet checksum of the given ICMPv6 packet.
*/ */
uint16_t icmpv6_csum(ipv6_hdr_t *ipv6_buf, icmpv6_hdr_t *icmpv6_buf); uint16_t icmpv6_csum(ipv6_hdr_t *ipv6_buf, icmpv6_hdr_t *icmpv6_buf);
/** @} */
#endif /* SIXLOWPAN_ICMP_H */ #endif /* SIXLOWPAN_ICMP_H */
/** @} */
...@@ -7,10 +7,12 @@ ...@@ -7,10 +7,12 @@
*/ */
/** /**
* @defgroup net_sixlowpan_ip IPv6
* @ingroup net_sixlowpan * @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 * @brief 6LoWPAN constants, data structs, and prototypes for network layer
* *
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @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) ...@@ -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); uint16_t ipv6_csum(ipv6_hdr_t *ipv6_header, uint8_t *buf, uint16_t len, uint8_t proto);
/** @} */
#endif /* SIXLOWPAN_IP_H */ #endif /* SIXLOWPAN_IP_H */
/** @} */
...@@ -7,10 +7,12 @@ ...@@ -7,10 +7,12 @@
*/ */
/** /**
* @defgroup net_sixlowpan_lowpan 6LoWPAN adaptation layer
* @ingroup net_sixlowpan * @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 * @brief 6LoWPAN LoWPAN layer header
* *
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
...@@ -299,5 +301,5 @@ void sixlowpan_lowpan_print_reassembly_buffers(void); ...@@ -299,5 +301,5 @@ void sixlowpan_lowpan_print_reassembly_buffers(void);
*/ */
int sixlowpan_lowpan_init(void); int sixlowpan_lowpan_init(void);
/** @} */
#endif /* SIXLOWPAN_LOWPAN_H */ #endif /* SIXLOWPAN_LOWPAN_H */
/** @} */
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup net_sixlowpan * @ingroup net_sixlowpan_lowpan
* @{ * @{
* *
* @file sixlowpan/mac.h * @file sixlowpan/mac.h
......
...@@ -7,7 +7,9 @@ ...@@ -7,7 +7,9 @@
*/ */
/** /**
* @addtogroup net_sixlowpan_ndp
* @ingroup net_sixlowpan * @ingroup net_sixlowpan
* @brief Neighbor discovery protocol for 6LoWPAN and IPv6
* @{ * @{
* *
* @file sixlowpan/ndp.h * @file sixlowpan/ndp.h
...@@ -30,13 +32,13 @@ ...@@ -30,13 +32,13 @@
#define NDP_6LOWPAN_CONTEXT_MAX (16) #define NDP_6LOWPAN_CONTEXT_MAX (16)
#define NDP_OPT_SLLAO_TYPE (1) #define NDP_OPT_SLLAO_TYPE (1)
#define NDP_OPT_TLLAO_TYPE (2) #define NDP_OPT_TLLAO_TYPE (2)
#define NDP_OPT_PI_VLIFETIME_INFINITE (0xffffffff) #define NDP_OPT_PI_VLIFETIME_INFINITE (0xffffffff)
#define NDP_OPT_PI_PLIFETIME_INFINITE (0xffffffff) #define NDP_OPT_PI_PLIFETIME_INFINITE (0xffffffff)
#define NDP_OPT_ARO_STATE_SUCCESS (0) #define NDP_OPT_ARO_STATE_SUCCESS (0)
#define NDP_OPT_ARO_STATE_DUP_ADDR (1) #define NDP_OPT_ARO_STATE_DUP_ADDR (1)
#define NDP_OPT_ARO_STATE_NBR_CACHE_FULL (2) #define NDP_OPT_ARO_STATE_NBR_CACHE_FULL (2)
/** /**
* @brief Neighbor cache entry state according to * @brief Neighbor cache entry state according to
......
...@@ -7,7 +7,9 @@ ...@@ -7,7 +7,9 @@
*/ */
/** /**
* @defgroup net_sixlowpan_types Type definitions and data structs for 6LoWPAN and IPv6
* @ingroup net_sixlowpan * @ingroup net_sixlowpan
* @brief Structs, constants, and enums for 6LoWPAN and IPv6 related functions
* @{ * @{
* *
* @file sixlowpan/types.h * @file sixlowpan/types.h
......
...@@ -6,8 +6,10 @@ ...@@ -6,8 +6,10 @@
* This file is subject to the terms and conditions of the GNU Lesser General * 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 * Public License. See the file LICENSE in the top level directory for more
* details. * details.
* */
* @ingroup sixlowpan
/**
* @ingroup net_sixlowpan
* @{ * @{
* @file sixlownd.h * @file sixlownd.h
* @brief 6lowpan neighbor discovery constants, data structs, and prototypes * @brief 6lowpan neighbor discovery constants, data structs, and prototypes
......
...@@ -7,12 +7,7 @@ ...@@ -7,12 +7,7 @@
*/ */
/** /**
* @defgroup net_sixlowpan 6LoWPAN * @file network_layer/sixlowpan/lowpan.h
* @ingroup net
* @brief RIOTs 6LowPAN implementation
* @{
*
* @file lowpan.h
* @brief 6lowpan header * @brief 6lowpan header
* *
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
...@@ -53,5 +48,4 @@ lowpan_context_t *lowpan_context_update(uint8_t num, ...@@ -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_get(void);
lowpan_context_t *lowpan_context_num_lookup(uint8_t num); lowpan_context_t *lowpan_context_num_lookup(uint8_t num);
/** @} */
#endif /* _SIXLOWPAN_LOWPAN_H */ #endif /* _SIXLOWPAN_LOWPAN_H */
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment