riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed doxygen inconsistensies in sys

Browse Source
This commit is contained in:
Hauke Petersen 2013-11-28 13:25:33 +01:00
parent c629229e8d
commit 2df82017a8
16 changed files with 128 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
core/bitarithm.c
View File

@ -9,15 +9,10 @@
/** /**
* @ingroup core_util * @ingroup core_util
* @{ * @{
<<<<<<< HEAD
* *
* @file bitarithm.c * @file bitarithm.c
* @brief Bit arithmetic helper functions implementation * @brief Bit arithmetic helper functions implementation
* *
=======
* @file bitarithm.c
* @brief Bit arithmetic helper functions implementation
>>>>>>> 94fedda... Fixed a lot of comments by removing tabs and correcting format.
* @author Kaspar Schleiser <kaspar.schleiser@fu-berlin.de> * @author Kaspar Schleiser <kaspar.schleiser@fu-berlin.de>
* @author Martin Lenders <mlenders@inf.fu-berlin.de> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
* *

1
core/oneway_malloc.c
View File

@ -8,6 +8,7 @@
* 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 core_util * @ingroup core_util

23
sys/include/posix_io.h
View File

@ -7,18 +7,16 @@
*/ */
/** /**
* @defgroup sys_posixio Posix IO * @ingroup sys_posix
* @ingroup sys
* @brief Posix compatible IO
* @{ * @{
* @file * @file posix_io.h
* @brief POSIX-like IO * @brief POSIX-like IO
* *
* @author Freie Universität Berlin * @author Freie Universität Berlin
* @author Kaspar Schleiser <kaspar@schleiser.de> * @author Kaspar Schleiser <kaspar@schleiser.de>
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
* @author Oliver Hahm <oleg@hobbykeller.org> * @author Oliver Hahm <oleg@hobbykeller.org>
* @author Martin Lenders <mlenders@inf.fu-berlin.de> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
*/ */
#ifndef __READ_H #ifndef __READ_H
#define __READ_H #define __READ_H
@ -37,7 +35,6 @@ int posix_open(int pid, int flags);
int posix_close(int pid); int posix_close(int pid);
int posix_read(int pid, char *buffer, int bufsize); int posix_read(int pid, char *buffer, int bufsize);
int posix_write(int pid, char *buffer, int bufsize); int posix_write(int pid, char *buffer, int bufsize);
/**
* @} /** @} */
*/
#endif /* __READ_H */ #endif /* __READ_H */

2
sys/include/vtimer.h
View File

@ -1,6 +1,6 @@
/** /**
* @defgroup sys_vtimer Virtual (Software) Timer library * @defgroup sys_vtimer Virtual (Software) Timer library
* @addtogroup sys * @ingroup sys
* @brief Virtual software timer for general timer functionality in applications * @brief Virtual software timer for general timer functionality in applications
* @{ * @{
* *

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

@ -1,7 +1,4 @@
/** /*
* sixlowpan.h - Wraps all API types, constants and functions
* of 6LoWPAN concerning layers under 3.
*
* Copyright (C) 2013 INRIA. * 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
@ -10,11 +7,12 @@
*/ */
/** /**
* @defgroup sixlowpan 6LoWPAN * @defgroup net_sixlowpan 6LoWPAN
* @ingroup net * @ingroup net
* @brief 6LoWPAN module implements (parts of) the 6LoWPAN adaption layer * @brief 6LoWPAN module implements (parts of) the 6LoWPAN adaption layer
* for IPv6 over Low Power Wireless Personal Area Networks * for IPv6 over Low Power Wireless Personal Area Networks
* (6LoWPANs) * (6LoWPANs)
*
* @see <a href="http://tools.ietf.org/html/rfc4919"> * @see <a href="http://tools.ietf.org/html/rfc4919">
* RFC 4919 - IPv6 over Low-Power Wireless Personal Area * RFC 4919 - IPv6 over Low-Power Wireless Personal Area
* Networks (6LoWPANs): Overview, Assumptions, Problem * Networks (6LoWPANs): Overview, Assumptions, Problem
@ -34,9 +32,11 @@
* (6LoWPANs) * (6LoWPANs)
* </a> * </a>
* @{ * @{
* @file *
* @brief 6lowpan link layer and lowpan functions * @file sixlowpan.h
* @author Martin Lenders <mlenders@inf.fu-berlin.de> * @brief 6lowpan link layer and lowpan functions
*
* @author Martin Lenders <mlenders@inf.fu-berlin.de>
*/ */
#ifndef SIXLOWPAN_H #ifndef SIXLOWPAN_H
#define SIXLOWPAN_H #define SIXLOWPAN_H
@ -46,7 +46,5 @@
#include "sixlowpan/lowpan.h" #include "sixlowpan/lowpan.h"
#include "sixlowpan/mac.h" #include "sixlowpan/mac.h"
/** /** @} */
* @}
*/
#endif /* SIXLOWPAN_H */ #endif /* SIXLOWPAN_H */

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

@ -1,18 +1,19 @@
/** /*
* sixlowpan/error.h - 6LoWPAN error codes
*
* Copyright (C) 2013 INRIA. * 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 *
* @brief 6LoWPAN error codes * @file sixlowpan/error.h
* @brief 6LoWPAN error codes
*
* @author Martin Lenders <mlenders@inf.fu-berlin.de> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @}
*/ */
#ifndef SIXLOWPAN_ERROR_H #ifndef SIXLOWPAN_ERROR_H
@ -94,7 +95,5 @@
*/ */
#define SIXLOWERROR_CSUM (141) #define SIXLOWERROR_CSUM (141)
/** /** @} */
* @}
*/
#endif /* SIXLOWPAN_ERROR_H */ #endif /* SIXLOWPAN_ERROR_H */

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

@ -1,21 +1,22 @@
/** /*
* sixlowpan/icmp.h - 6LoWPAN constants, data structs, and prototypes
* related to ICMP
*
* Copyright (C) 2013 INRIA. * 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 *
* @brief 6LoWPAN ICMP related header * @file sixlowpan/icmp.h
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @brief 6LoWPAN ICMP related header
* @author Martin Lenders <mlenders@inf.fu-berlin.de> *
* @author Eric Engel <eric.engel@fu-berlin.de> * @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @author Eric Engel <eric.engel@fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com>
*/ */
#ifndef SIXLOWPAN_ICMP_H #ifndef SIXLOWPAN_ICMP_H
@ -231,7 +232,5 @@ void icmpv6_send_neighbor_adv(ipv6_addr_t *src, ipv6_addr_t *dst,
ipv6_addr_t *tgt, uint8_t rso, ipv6_addr_t *tgt, uint8_t rso,
uint8_t sllao, uint8_t aro); uint8_t sllao, uint8_t aro);
/** /** @} */
* @}
*/
#endif /* SIXLOWPAN_ICMP_H */ #endif /* SIXLOWPAN_ICMP_H */

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

@ -1,21 +1,22 @@
/** /*
* sixlowpan/ip.h - 6LoWPAN constants, data structs, and prototypes
* for network layer
*
* Copyright (C) 2013 INRIA. * 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 *
* @brief 6LoWPAN network layer header * @file sixlowpan/ip.h
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @brief 6LoWPAN constants, data structs, and prototypes for network layer
* @author Martin Lenders <mlenders@inf.fu-berlin.de> *
* @author Eric Engel <eric.engel@fu-berlin.de> * @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @author Eric Engel <eric.engel@fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com>
*/ */
#ifndef SIXLOWPAN_IP_H #ifndef SIXLOWPAN_IP_H
@ -384,7 +385,6 @@ void ipv6_iface_set_routing_provider(ipv6_addr_t *(*next_hop)(ipv6_addr_t* dest)
* @return The IPv6 upper-layer checksum. * @return The IPv6 upper-layer checksum.
*/ */
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 */

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

@ -1,21 +1,22 @@
/** /*
* sixlowpan/lowpan.h - 6LoWPAN constants, data structs, and
* prototypes for 6LoWPAN layer
*
* Copyright (C) 2013 INRIA. * 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 *
* @brief 6LoWPAN LoWPAN layer header * @file sixlowpan/lowpan.h
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @brief 6LoWPAN LoWPAN layer header
* @author Martin Lenders <mlenders@inf.fu-berlin.de> *
* @author Eric Engel <eric.engel@fu-berlin.de> * @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @author Eric Engel <eric.engel@fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com>
*/ */
#ifndef SIXLOWPAN_LOWPAN_H #ifndef SIXLOWPAN_LOWPAN_H
@ -271,7 +272,5 @@ void sixlowpan_lowpan_print_fifo_buffers(void);
void sixlowpan_lowpan_print_reassembly_buffers(void); void sixlowpan_lowpan_print_reassembly_buffers(void);
#endif #endif
/** /** @} */
* @}
*/
#endif /* SIXLOWPAN_LOWPAN_H */ #endif /* SIXLOWPAN_LOWPAN_H */

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

@ -1,20 +1,22 @@
/** /*
* sixlowpan/mac.h - 6LoWPAN data structs, and prototypes for MAC layer
*
* Copyright (C) 2013 INRIA. * 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 *
* @brief 6LoWPAN MAC layer header * @file sixlowpan/mac.h
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @brief 6LoWPAN data structs, and prototypes for MAC layer
* @author Martin Lenders <mlenders@inf.fu-berlin.de> *
* @author Eric Engel <eric.engel@fu-berlin.de> * @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @author Eric Engel <eric.engel@fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com>
*/ */
#ifndef SIXLOWPAN_MAC_H #ifndef SIXLOWPAN_MAC_H
@ -105,7 +107,5 @@ void sixlowpan_mac_init(transceiver_type_t type);
*/ */
char *sixlowpan_mac_802154_long_addr_to_str(char *addr_str, const ieee_802154_long_t *laddr); char *sixlowpan_mac_802154_long_addr_to_str(char *addr_str, const ieee_802154_long_t *laddr);
/** /** @} */
* @}
*/
#endif /* SIXLOWPAN_MAC_H */ #endif /* SIXLOWPAN_MAC_H */

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

@ -1,21 +1,22 @@
/** /*
* sixlowpan/ndp.h - 6LoWPAN constants, data structs, and prototypes
* related to NDP
*
* Copyright (C) 2013 INRIA. * 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 *
* @brief 6LoWPAN NDP related header * @file sixlowpan/ndp.h
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @brief 6LoWPAN constants, data structs, and prototypes related to NDP
* @author Martin Lenders <mlenders@inf.fu-berlin.de> *
* @author Eric Engel <eric.engel@fu-berlin.de> * @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @author Eric Engel <eric.engel@fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com>
*/ */
#ifndef SIXLOWPAN_NDP_H #ifndef SIXLOWPAN_NDP_H
@ -123,7 +124,5 @@ uint8_t ndp_prefix_list_search(ipv6_addr_t *addr);
ndp_a6br_cache_t *ndp_a6br_cache_get_most_current(void); ndp_a6br_cache_t *ndp_a6br_cache_get_most_current(void);
ndp_a6br_cache_t *ndp_a6br_cache_get_oldest(void); ndp_a6br_cache_t *ndp_a6br_cache_get_oldest(void);
/** /** @} */
* @}
*/
#endif /* SIXLOWPAN_NDP_H */ #endif /* SIXLOWPAN_NDP_H */

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

@ -1,20 +1,22 @@
/** /*
* 6LoWPAN data types
*
* Copyright (C) 2013 INRIA. * 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 sixlowpan/types.h *
* @brief 6LoWPAN data types * @file sixlowpan/types.h
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de> * @brief 6LoWPAN data types
* @author Martin Lenders <mlenders@inf.fu-berlin.de> *
* @author Eric Engel <eric.engel@fu-berlin.de> * @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com> * @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @author Eric Engel <eric.engel@fu-berlin.de>
* @author Oliver Gesch <oliver.gesch@googlemail.com>
*/ */
#ifndef SIXLOWPAN_TYPES_H #ifndef SIXLOWPAN_TYPES_H
@ -394,7 +396,5 @@ typedef enum __attribute__((packed)) {
NDP_ADDR_STATE_ANY ///< addresses of this state are always permitted. NDP_ADDR_STATE_ANY ///< addresses of this state are always permitted.
} ndp_addr_state_t; } ndp_addr_state_t;
/** /** @} */
* @}
*/
#endif /* SIXLOWPAN_TYPES_H */ #endif /* SIXLOWPAN_TYPES_H */

4
sys/net/sixlowpan/lowpan.h
View File

@ -9,10 +9,10 @@
/** /**
* @defgroup net_sixlowpan 6LoWPAN * @defgroup net_sixlowpan 6LoWPAN
* @ingroup net * @ingroup net
* @brief Riots 6LowPAN implementation * @brief RIOTs 6LowPAN implementation
* @{ * @{
* *
* @file sixlowpan.h * @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>

4
sys/posix/doc.txt
View File

@ -7,10 +7,10 @@
*/ */
/** /**
* @defgroup posix POSIX wrapper of RIOT * @defgroup sys_posix POSIX wrapper for RIOT
* @brief POSIX header files * @brief POSIX header files
* @see <a href="http://pubs.opengroup.org/onlinepubs/9699919799/"> * @see <a href="http://pubs.opengroup.org/onlinepubs/9699919799/">
* The Open Group Specifications Issue 7 * The Open Group Specifications Issue 7
* </a> * </a>
* @ingroup posix * @ingroup sys
*/ */

8
sys/posix/include/strings.h
View File

@ -1,4 +1,4 @@
/** /*
* Copyright (C) 2013 INRIA. * 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
@ -7,11 +7,9 @@
*/ */
/** /**
* @addtogroup posix * @ingroup sys_posix
* @{ * @{
*/ *
/**
* @file strings.h * @file strings.h
* @brief string operations * @brief string operations
* *

2
sys/posix/posix_io.c
View File

@ -7,7 +7,7 @@
* 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 posix * @ingroup sys_posix
* @{ * @{
* @file posix_io.c * @file posix_io.c
* @brief Implementation of basic POSIX IO functionality. * @brief Implementation of basic POSIX IO functionality.