From 89a673d029acb0becd53d3bc00e13a7c0073ba09 Mon Sep 17 00:00:00 2001 From: authmillenon Date: Thu, 8 Aug 2013 14:44:28 +0200 Subject: [PATCH] Add documentation group for 6LoWPAN module --- sys/net/sixlowpan/include/sixlowpan.h | 40 ++++++++++++++++++++++----- 1 file changed, 33 insertions(+), 7 deletions(-) diff --git a/sys/net/sixlowpan/include/sixlowpan.h b/sys/net/sixlowpan/include/sixlowpan.h index 908e9ec56a..bf8521ecb1 100644 --- a/sys/net/sixlowpan/include/sixlowpan.h +++ b/sys/net/sixlowpan/include/sixlowpan.h @@ -1,19 +1,42 @@ -/* - * 6LoWPAN - Wraps all API types, constants and functions of 6LoWPAN concerning - * Layers under 3. +/** + * sixlowpan.h - Wraps all API types, constants and functions + * of 6LoWPAN concerning layers under 3. * * Copyright (C) 2013 INRIA. * * This file 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 + */ + +/** + * @defgroup sixlowpan 6LoWPAN + * @ingroup net + * @brief 6LoWPAN module implements (parts of) the 6LoWPAN adaption layer + * for IPv6 over Low Power Wireless Personal Area Networks + * (6LoWPANs) + * @see + * RFC 4919 - IPv6 over Low-Power Wireless Personal Area + * Networks (6LoWPANs): Overview, Assumptions, Problem + * Statement, and Goals + * + * @see + * RFC 4944 - Transmission of IPv6 Packets over + * IEEE 802.15.4 Networks + * + * @see + * RFC 6282 - Compression Format for IPv6 Datagrams over + * IEEE 802.15.4-Based Networks + * + * @see + * RFC 6775 - Neighbor Discovery Optimization for IPv6 + * over Low-Power Wireless Personal Area Networks + * (6LoWPANs) + * * @{ - * @file sixlowpan.h + * @file * @brief 6lowpan link layer and lowpan functions * @author Martin Lenders - * @} */ #ifndef SIXLOWPAN_H #define SIXLOWPAN_H @@ -28,4 +51,7 @@ #include "../lowpan.h" /* TODO: remove if not needed anymore */ #include "../mac.h" /* TODO: remove if not needed anymore */ +/** + * @} + */ #endif /* SIXLOWPAN_H */