diff --git a/core/bitarithm.c b/core/bitarithm.c index 265362fcf9..398c85f815 100644 --- a/core/bitarithm.c +++ b/core/bitarithm.c @@ -9,15 +9,10 @@ /** * @ingroup core_util * @{ -<<<<<<< HEAD * * @file bitarithm.c * @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 * @author Martin Lenders * diff --git a/core/oneway_malloc.c b/core/oneway_malloc.c index fb4e952a96..e8bb8092c6 100644 --- a/core/oneway_malloc.c +++ b/core/oneway_malloc.c @@ -8,6 +8,7 @@ * 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 core_util diff --git a/sys/include/posix_io.h b/sys/include/posix_io.h index cddba17396..3395c3f836 100644 --- a/sys/include/posix_io.h +++ b/sys/include/posix_io.h @@ -7,18 +7,16 @@ */ /** - * @defgroup sys_posixio Posix IO - * @ingroup sys - * @brief Posix compatible IO + * @ingroup sys_posix * @{ - * @file - * @brief POSIX-like IO + * @file posix_io.h + * @brief POSIX-like IO * - * @author Freie Universität Berlin - * @author Kaspar Schleiser - * @author Stephan Zeisberg - * @author Oliver Hahm - * @author Martin Lenders + * @author Freie Universität Berlin + * @author Kaspar Schleiser + * @author Stephan Zeisberg + * @author Oliver Hahm + * @author Martin Lenders */ #ifndef __READ_H #define __READ_H @@ -37,7 +35,6 @@ int posix_open(int pid, int flags); int posix_close(int pid); int posix_read(int pid, char *buffer, int bufsize); int posix_write(int pid, char *buffer, int bufsize); -/** - * @} - */ + +/** @} */ #endif /* __READ_H */ diff --git a/sys/include/vtimer.h b/sys/include/vtimer.h index d256a4612e..27e705b113 100644 --- a/sys/include/vtimer.h +++ b/sys/include/vtimer.h @@ -1,6 +1,6 @@ /** * @defgroup sys_vtimer Virtual (Software) Timer library - * @addtogroup sys + * @ingroup sys * @brief Virtual software timer for general timer functionality in applications * @{ * diff --git a/sys/net/include/sixlowpan.h b/sys/net/include/sixlowpan.h index 8c9dd92e72..fafead8da5 100644 --- a/sys/net/include/sixlowpan.h +++ b/sys/net/include/sixlowpan.h @@ -1,7 +1,4 @@ -/** - * sixlowpan.h - Wraps all API types, constants and functions - * of 6LoWPAN concerning layers under 3. - * +/* * Copyright (C) 2013 INRIA. * * This file is subject to the terms and conditions of the GNU Lesser General @@ -10,11 +7,12 @@ */ /** - * @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) + * @defgroup net_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 @@ -34,9 +32,11 @@ * (6LoWPANs) * * @{ - * @file - * @brief 6lowpan link layer and lowpan functions - * @author Martin Lenders + * + * @file sixlowpan.h + * @brief 6lowpan link layer and lowpan functions + * + * @author Martin Lenders */ #ifndef SIXLOWPAN_H #define SIXLOWPAN_H @@ -46,7 +46,5 @@ #include "sixlowpan/lowpan.h" #include "sixlowpan/mac.h" -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_H */ diff --git a/sys/net/include/sixlowpan/error.h b/sys/net/include/sixlowpan/error.h index e6dc9ecbe9..16e6645ca3 100644 --- a/sys/net/include/sixlowpan/error.h +++ b/sys/net/include/sixlowpan/error.h @@ -1,18 +1,19 @@ -/** - * sixlowpan/error.h - 6LoWPAN error codes - * +/* * Copyright (C) 2013 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 - * @brief 6LoWPAN error codes + * + * @file sixlowpan/error.h + * @brief 6LoWPAN error codes + * * @author Martin Lenders - * @} */ #ifndef SIXLOWPAN_ERROR_H @@ -94,7 +95,5 @@ */ #define SIXLOWERROR_CSUM (141) -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_ERROR_H */ diff --git a/sys/net/include/sixlowpan/icmp.h b/sys/net/include/sixlowpan/icmp.h index 391f314268..6aa417c66c 100644 --- a/sys/net/include/sixlowpan/icmp.h +++ b/sys/net/include/sixlowpan/icmp.h @@ -1,21 +1,22 @@ -/** - * sixlowpan/icmp.h - 6LoWPAN constants, data structs, and prototypes - * related to ICMP - * +/* * Copyright (C) 2013 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 - * @brief 6LoWPAN ICMP related header - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/icmp.h + * @brief 6LoWPAN ICMP related header + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #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, uint8_t sllao, uint8_t aro); -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_ICMP_H */ diff --git a/sys/net/include/sixlowpan/ip.h b/sys/net/include/sixlowpan/ip.h index 16032b7a9a..56ac1c180f 100644 --- a/sys/net/include/sixlowpan/ip.h +++ b/sys/net/include/sixlowpan/ip.h @@ -1,21 +1,22 @@ -/** - * sixlowpan/ip.h - 6LoWPAN constants, data structs, and prototypes - * for network layer - * +/* * Copyright (C) 2013 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 - * @brief 6LoWPAN network layer header - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/ip.h + * @brief 6LoWPAN constants, data structs, and prototypes for network layer + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #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. */ uint16_t ipv6_csum(ipv6_hdr_t *ipv6_header, uint8_t *buf, uint16_t len, uint8_t proto); -/** - * @} - */ + +/** @} */ #endif /* SIXLOWPAN_IP_H */ diff --git a/sys/net/include/sixlowpan/lowpan.h b/sys/net/include/sixlowpan/lowpan.h index 13ea471f0c..bc0a1bdac1 100644 --- a/sys/net/include/sixlowpan/lowpan.h +++ b/sys/net/include/sixlowpan/lowpan.h @@ -1,21 +1,22 @@ -/** - * sixlowpan/lowpan.h - 6LoWPAN constants, data structs, and - * prototypes for 6LoWPAN layer - * +/* * Copyright (C) 2013 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 - * @brief 6LoWPAN LoWPAN layer header - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/lowpan.h + * @brief 6LoWPAN LoWPAN layer header + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #ifndef SIXLOWPAN_LOWPAN_H @@ -271,7 +272,5 @@ void sixlowpan_lowpan_print_fifo_buffers(void); void sixlowpan_lowpan_print_reassembly_buffers(void); #endif -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_LOWPAN_H */ diff --git a/sys/net/include/sixlowpan/mac.h b/sys/net/include/sixlowpan/mac.h index 690bd5999f..a09960d788 100644 --- a/sys/net/include/sixlowpan/mac.h +++ b/sys/net/include/sixlowpan/mac.h @@ -1,20 +1,22 @@ -/** - * sixlowpan/mac.h - 6LoWPAN data structs, and prototypes for MAC layer - * +/* * Copyright (C) 2013 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 - * @brief 6LoWPAN MAC layer header - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/mac.h + * @brief 6LoWPAN data structs, and prototypes for MAC layer + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #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); -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_MAC_H */ diff --git a/sys/net/include/sixlowpan/ndp.h b/sys/net/include/sixlowpan/ndp.h index 5cb7aca2fc..939844fa53 100644 --- a/sys/net/include/sixlowpan/ndp.h +++ b/sys/net/include/sixlowpan/ndp.h @@ -1,21 +1,22 @@ -/** - * sixlowpan/ndp.h - 6LoWPAN constants, data structs, and prototypes - * related to NDP - * +/* * Copyright (C) 2013 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 - * @brief 6LoWPAN NDP related header - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/ndp.h + * @brief 6LoWPAN constants, data structs, and prototypes related to NDP + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #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_oldest(void); -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_NDP_H */ diff --git a/sys/net/include/sixlowpan/types.h b/sys/net/include/sixlowpan/types.h index 8d9cd9724d..879d8e5d1d 100644 --- a/sys/net/include/sixlowpan/types.h +++ b/sys/net/include/sixlowpan/types.h @@ -1,20 +1,22 @@ -/** - * 6LoWPAN data types - * +/* * Copyright (C) 2013 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 sixlowpan/types.h - * @brief 6LoWPAN data types - * @author Stephan Zeisberg - * @author Martin Lenders - * @author Eric Engel - * @author Oliver Gesch + * + * @file sixlowpan/types.h + * @brief 6LoWPAN data types + * + * @author Stephan Zeisberg + * @author Martin Lenders + * @author Eric Engel + * @author Oliver Gesch */ #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_t; -/** - * @} - */ +/** @} */ #endif /* SIXLOWPAN_TYPES_H */ diff --git a/sys/net/sixlowpan/lowpan.h b/sys/net/sixlowpan/lowpan.h index 873c1dadf8..d4bd59e7d8 100644 --- a/sys/net/sixlowpan/lowpan.h +++ b/sys/net/sixlowpan/lowpan.h @@ -9,10 +9,10 @@ /** * @defgroup net_sixlowpan 6LoWPAN * @ingroup net - * @brief Riots 6LowPAN implementation + * @brief RIOTs 6LowPAN implementation * @{ * - * @file sixlowpan.h + * @file lowpan.h * @brief 6lowpan header * * @author Stephan Zeisberg diff --git a/sys/posix/doc.txt b/sys/posix/doc.txt index 60e41b850d..a2040a1b93 100644 --- a/sys/posix/doc.txt +++ b/sys/posix/doc.txt @@ -7,10 +7,10 @@ */ /** - * @defgroup posix POSIX wrapper of RIOT + * @defgroup sys_posix POSIX wrapper for RIOT * @brief POSIX header files * @see * The Open Group Specifications Issue 7 * - * @ingroup posix + * @ingroup sys */ diff --git a/sys/posix/include/strings.h b/sys/posix/include/strings.h index 7f08ea30a0..c1dc2095fd 100644 --- a/sys/posix/include/strings.h +++ b/sys/posix/include/strings.h @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2013 INRIA. * * 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 * @brief string operations * diff --git a/sys/posix/posix_io.c b/sys/posix/posix_io.c index efc731c9f0..4e78f54c5d 100644 --- a/sys/posix/posix_io.c +++ b/sys/posix/posix_io.c @@ -7,7 +7,7 @@ * Public License. See the file LICENSE in the top level directory for more * details. * - * @ingroup posix + * @ingroup sys_posix * @{ * @file posix_io.c * @brief Implementation of basic POSIX IO functionality.