1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-27 07:21:18 +01:00

Add documentation group for 6LoWPAN module

This commit is contained in:
authmillenon 2013-08-08 14:44:28 +02:00 committed by authmillenon
parent 0399e26f17
commit 89a673d029

View File

@ -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 <a href="http://tools.ietf.org/html/rfc4919">
* RFC 4919 - IPv6 over Low-Power Wireless Personal Area
* Networks (6LoWPANs): Overview, Assumptions, Problem
* Statement, and Goals
* </a>
* @see <a href="http://tools.ietf.org/html/rfc4944">
* RFC 4944 - Transmission of IPv6 Packets over
* IEEE 802.15.4 Networks
* </a>
* @see <a href="http://tools.ietf.org/html/rfc6282">
* RFC 6282 - Compression Format for IPv6 Datagrams over
* IEEE 802.15.4-Based Networks
* </a>
* @see <a href="http://tools.ietf.org/html/rfc6775">
* RFC 6775 - Neighbor Discovery Optimization for IPv6
* over Low-Power Wireless Personal Area Networks
* (6LoWPANs)
* </a>
* @{
* @file sixlowpan.h
* @file
* @brief 6lowpan link layer and lowpan functions
* @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @}
*/
#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 */