RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
Code Releases Activity

Merge pull request #1015 from OlegHahm/sixlowpan_doxygen_fix

Browse Source 
Some doxygen fixes
This commit is contained in:
Oleg Hahm 2014-05-22 13:21:50 +02:00
commit f54b363b6c
16 changed files with 71 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
cpu/lpc1768/include/cmsis.h
View File

@ -4,6 +4,16 @@
* A generic CMSIS include header, pulling in LPC1768 specifics
*/
/**
* @defgroup CMSIS
* @ingroup cpu
* @{
*
* @file cmsis.h
* @brief CMSIS interface pulling in LPC1768 specifics
*/
#ifndef MBED_CMSIS_H
#define MBED_CMSIS_H
@ -11,3 +21,4 @@
#include "cmsis_nvic.h"
#endif
/** @} */

7
cpu/lpc1768/include/core_cm3.h
View File

@ -1,4 +1,6 @@
/**************************************************************************//**
/**
* @ingroup CMSIS
*
* @file core_cm3.h
* @brief CMSIS Cortex-M3 Core Peripheral Access Layer Header File
* @version V3.02
@ -154,6 +156,7 @@
/* IO definitions (access restrictions to peripheral registers) */
/**
\defgroup CMSIS_glob_defs CMSIS Global Defines
\ingroup CMSIS
<strong>IO Type Qualifiers</strong> are used
\li to specify the access to peripheral variables.
@ -182,6 +185,7 @@
- Core MPU Register
******************************************************************************/
/** \defgroup CMSIS_core_register Defines and Type Definitions
* \ingroup CMSIS
\brief Type definitions and defines for Cortex-M processor based devices.
*/
@ -1252,6 +1256,7 @@ typedef struct
- Core Register Access Functions
******************************************************************************/
/** \defgroup CMSIS_Core_FunctionInterface Functions and Instructions Reference
* \ingroup CMSIS
*/

2
cpu/lpc1768/include/core_cmInstr.h
View File

@ -28,6 +28,8 @@
/* ########################## Core Instruction Access ######################### */
/** \defgroup CMSIS_Core_InstructionInterface CMSIS Core Instruction Interface
Access to dedicated instructions
\ingroup CMSIS
@{
*/

6
sys/include/transceiver.h
View File

@ -1,8 +1,11 @@
/**
* @defgroup sys_transceiver Transceiver
* @ingroup sys
* @{
*
* @file transceiver.h
* @brief Transceiver library
* @author Oliver Hahm <oliver.hahm@inria.fr>
*/
#ifndef TRANSCEIVER_H
@ -220,3 +223,4 @@ int transceiver_start(void);
uint8_t transceiver_register(transceiver_type_t transceivers, int pid);
#endif /* TRANSCEIVER_H */
/** @} */

1
sys/net/doc.txt
View File

@ -8,6 +8,5 @@
/**
* @defgroup net Net
* @ingroup sys
* @brief Networking libraries
*/

21
sys/net/include/ipv6.h
View File

@ -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 */

5
sys/net/include/sixlowpan.h
View File

@ -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 */
/** @} */

2
sys/net/include/sixlowpan/error.h
View File

@ -7,7 +7,7 @@
*/
/**
* @ingroup net_sixlowpan
* @ingroup net_sixlowpan_lowpan
* @{
*
* @file sixlowpan/error.h

7
sys/net/include/sixlowpan/icmp.h
View File

@ -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 */
/** @} */

6
sys/net/include/sixlowpan/ip.h
View File

@ -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 */
/** @} */

6
sys/net/include/sixlowpan/lowpan.h
View File

@ -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 */
/** @} */

2
sys/net/include/sixlowpan/mac.h
View File

@ -7,7 +7,7 @@
*/
/**
* @ingroup net_sixlowpan
* @ingroup net_sixlowpan_lowpan
* @{
*
* @file sixlowpan/mac.h

16
sys/net/include/sixlowpan/ndp.h
View File

@ -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

2
sys/net/include/sixlowpan/types.h
View File

@ -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

8
sys/net/network_layer/sixlowpan/icmp.h
View File

@ -6,10 +6,12 @@
* 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
* @file sixlowpan/icmp.h
* @brief 6lowpan neighbor discovery constants, data structs, and prototypes
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
* @author Martin Lenders <mlenders@inf.fu-berlin.de>

8
sys/net/network_layer/sixlowpan/lowpan.h
View File

@ -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 */