diff --git a/cpu/cc2538/include/cc2538.h b/cpu/cc2538/include/cc2538.h index 3ae968a873..50b6292654 100644 --- a/cpu/cc2538/include/cc2538.h +++ b/cpu/cc2538/include/cc2538.h @@ -123,7 +123,7 @@ void SysTick_Handler(void); /**< SysTick handler */ typedef volatile uint32_t cc2538_reg_t; /**< Least-significant 32 bits of the IEEE address */ -/** @addtogroup Peripheral_memory_map +/** @addtogroup cpu_specific_Peripheral_memory_map * @{ */ diff --git a/cpu/mc1322x/maca/include/maca_packet.h b/cpu/mc1322x/maca/include/maca_packet.h index 092a93c8ec..389340f3c6 100644 --- a/cpu/mc1322x/maca/include/maca_packet.h +++ b/cpu/mc1322x/maca/include/maca_packet.h @@ -23,24 +23,30 @@ extern "C" { #define PACKET_STATS 0 +/** + * @brief MC1322x internal MACA packet format */ struct packet { - uint8_t length; /*< does not include FCS checksum */ - volatile struct packet * left; - volatile struct packet * right; - /* offset into data for first byte of the packet payload */ - /* On TX this should be 0 */ - /* On RX this should be 1 since the maca puts the length as the first byte*/ - uint8_t offset; - uint8_t lqi; - uint8_t status; - uint32_t rx_time; + uint8_t length; /**< does not include FCS checksum */ + volatile struct packet *left; /**< pointer to left neighbor in queue */ + volatile struct packet *right; /**< pointer to right neighbor in queue */ + uint8_t offset; /**< offset into data for first byte of the + * packet payload + * On TX this should be 0 + * On RX this should be 1 since the maca + * puts the length as the first byte + */ + uint8_t lqi; /**< link quality indicator */ + uint8_t status; /**< packet status */ + uint32_t rx_time; /**< receiving timestamp */ #if PACKET_STATS uint8_t seen; uint8_t post_tx; uint8_t get_free; uint8_t rxd; #endif - uint8_t data[MACA_MAX_PAYLOAD_SIZE+2+1]; /* +2 for FCS; + 1 since maca returns the length as the first byte */ + uint8_t data[MACA_MAX_PAYLOAD_SIZE+2+1]; /**< +2 for FCS; + 1 since maca + * returns the length as the + * first byte */ }; typedef struct packet maca_packet_t; diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index d2a396d24a..8c6614ed13 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -756,9 +756,9 @@ WARN_LOGFILE = INPUT = ../../core \ ../../cpu \ ../../boards \ + ../../drivers \ ../../sys \ - src/ \ - ../../drivers + src/ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/drivers/cc110x/cc110x-internal.h b/drivers/cc110x/cc110x-internal.h index ad04f3bbe7..b4d8d2c2f4 100644 --- a/drivers/cc110x/cc110x-internal.h +++ b/drivers/cc110x/cc110x-internal.h @@ -11,7 +11,7 @@ * @ingroup drivers_cc110x * @{ * - * @file cc110x-internal.h + * @file * @brief Driver internal constants for CC110x chip configuration * * @author Thomas Hillebrandt diff --git a/drivers/cc110x_legacy/cc110x-internal.h b/drivers/cc110x_legacy/cc110x-internal.h index 9b73bfbe8b..70f92943e9 100644 --- a/drivers/cc110x_legacy/cc110x-internal.h +++ b/drivers/cc110x_legacy/cc110x-internal.h @@ -11,7 +11,7 @@ * @ingroup drivers_cc110x_legacy * @{ * - * @file cc110x-internal.h + * @file * @brief Driver internal constants for 110x chip configuration * * @author Thomas Hillebrandt diff --git a/drivers/include/cc110x/cc110x-config.h b/drivers/include/cc110x/cc110x-config.h index d73b970cd0..74eb71323a 100644 --- a/drivers/include/cc110x/cc110x-config.h +++ b/drivers/include/cc110x/cc110x-config.h @@ -11,7 +11,7 @@ * @ingroup drivers_cc110x * @{ * - * @file cc110x-config.h + * @file * @brief Configuration parameters for the cc110x radio chip * * @author Oliver Hahm diff --git a/drivers/include/cc110x/cc110x-interface.h b/drivers/include/cc110x/cc110x-interface.h index 4228f741c4..82e20a60c7 100644 --- a/drivers/include/cc110x/cc110x-interface.h +++ b/drivers/include/cc110x/cc110x-interface.h @@ -13,7 +13,7 @@ * @ingroup drivers * @{ * - * @file cc110x-interface.h + * @file * @brief Data structures and variables for the cc110x driver interface * * @author Oliver Hahm diff --git a/drivers/include/cc110x/cc110x-reg.h b/drivers/include/cc110x/cc110x-reg.h index 213f8622fb..ce61449538 100644 --- a/drivers/include/cc110x/cc110x-reg.h +++ b/drivers/include/cc110x/cc110x-reg.h @@ -11,7 +11,7 @@ * @ingroup drivers_cc110x * @{ * - * @file cc110x-reg.h + * @file * @brief Access to CC110X registers * * @author Oliver Hahm diff --git a/drivers/include/cc110x_legacy/cc110x-config.h b/drivers/include/cc110x_legacy/cc110x-config.h index 90957f216e..8db6b7e42a 100644 --- a/drivers/include/cc110x_legacy/cc110x-config.h +++ b/drivers/include/cc110x_legacy/cc110x-config.h @@ -11,7 +11,7 @@ * @ingroup drivers_cc110x_legacy * @{ * - * @file cc110x-config.h + * @file * @brief Configuration parameters for the cc110x radio chip * * @author Oliver Hahm diff --git a/drivers/include/cc110x_legacy/cc110x-reg.h b/drivers/include/cc110x_legacy/cc110x-reg.h index efa2fe9192..eb2a3203b6 100644 --- a/drivers/include/cc110x_legacy/cc110x-reg.h +++ b/drivers/include/cc110x_legacy/cc110x-reg.h @@ -11,7 +11,7 @@ * @ingroup drivers_cc110x_legacy * @{ * - * @file cc110x-reg.h + * @file * @brief Access to CC110X registers * * @author Oliver Hahm diff --git a/drivers/include/netdev/802154.h b/drivers/include/netdev/802154.h index e949fe6069..b83e3e44af 100644 --- a/drivers/include/netdev/802154.h +++ b/drivers/include/netdev/802154.h @@ -7,10 +7,10 @@ */ /** - * @defgroup netdev_802154 IEEE 802.15.4 interface * @addtogroup netdev + * * @{ - * @file netdev/802154.h + * @file * @brief API definitions for 802.15.4 radio transceivers' drivers * @author Kévin Roussel * @author Martine Lenders diff --git a/drivers/include/nrf24l01p.h b/drivers/include/nrf24l01p.h index 03e3db888b..94f580502e 100644 --- a/drivers/include/nrf24l01p.h +++ b/drivers/include/nrf24l01p.h @@ -9,11 +9,12 @@ /** * @defgroup drivers_nrf24l01p NRF24L01+ Driver Interface * @ingroup drivers - * @{ * - * @file * @brief Low-level driver for nrf24l01+ transceiver * + * @{ + * @file + * * @author Hauke Petersen * @author Peter Kietzmann * diff --git a/drivers/include/radio_driver.h b/drivers/include/radio_driver.h index 1344b04822..7a39d1caf9 100644 --- a/drivers/include/radio_driver.h +++ b/drivers/include/radio_driver.h @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2014 INRIA * * This file is subject to the terms and conditions of the GNU Lesser @@ -7,10 +7,13 @@ */ /** + * @defgroup radio_driver IEEE 802.15.4 radio driver interface * @ingroup drivers - * @{ - * @file radio_driver.h + * * @brief API definitions for 802.15.4 radio transceivers' drivers + * + * @{ + * @file * @author Kévin Roussel * */ diff --git a/sys/include/pipe.h b/sys/include/pipe.h index f43ff631cb..c3d359211e 100644 --- a/sys/include/pipe.h +++ b/sys/include/pipe.h @@ -19,14 +19,16 @@ /** * @defgroup sys_pipe Pipe IPC * @ingroup sys - * @{ - * @file * * @brief Generic pipe implementation. * @details This pipe implementation is a tight wrapper around a ringbuffer. * It sends the calling thread to sleep if the ringbuffer is full * or empty, respectively. It can be used in ISRs, too. * + * + * @{ + * @file + * * @author René Kijewski */ diff --git a/sys/include/transceiver.h b/sys/include/transceiver.h index 9503d35760..4cb7ef32ca 100644 --- a/sys/include/transceiver.h +++ b/sys/include/transceiver.h @@ -9,10 +9,13 @@ /** * @defgroup sys_transceiver Transceiver * @ingroup sys + * + * @brief The transceiver module implements a generic link abstraction to + * any radio interface. + * * @{ * - * @file transceiver.h - * @brief Transceiver library + * @file * @author Oliver Hahm */ @@ -143,7 +146,7 @@ extern "C" { */ /** - * @brief The maximum of threads to register + * @brief The maximum of threads to register */ #define TRANSCEIVER_MAX_REGISTERED (4) @@ -207,7 +210,7 @@ enum transceiver_msg_type_t { SET_ADDRESS, /**< Set the radio address */ GET_LONG_ADDR, /**< Get the long radio address, if existing */ SET_LONG_ADDR, /**< Set the long radio address, if supported by hardware */ - SET_MONITOR, /**< Set transceiver to monitor mode (disable address + SET_MONITOR, /**< Set transceiver to monitor mode (disable address checking) */ GET_PAN, /**< Get current pan */ SET_PAN, /**< Set a new pan */ @@ -230,7 +233,7 @@ enum transceiver_msg_type_t { * @brief Manage registered threads per transceiver */ typedef struct { - transceiver_type_t transceivers; /**< the tranceivers the thread is + transceiver_type_t transceivers; /**< the tranceivers the thread is registered for */ kernel_pid_t pid; /**< the thread's pid */ } registered_t; @@ -249,7 +252,7 @@ typedef struct { extern volatile kernel_pid_t transceiver_pid; /** - * @brief An array of ignored link layer addresses + * @brief An array of ignored link layer addresses */ extern radio_address_t transceiver_ignored_addr[TRANSCEIVER_MAX_IGNORED_ADDR]; diff --git a/sys/net/include/rpl/rpl_storing.h b/sys/net/include/rpl/rpl_storing.h index 3ef84242ac..fee27eac14 100644 --- a/sys/net/include/rpl/rpl_storing.h +++ b/sys/net/include/rpl/rpl_storing.h @@ -7,7 +7,7 @@ */ /** - * @ingroup net + * @ingroup rpl * @brief Routing Protocol for Low power and Lossy Networks * @{ * diff --git a/sys/net/include/socket_base.h b/sys/net/include/socket_base.h index 8ed57a4942..b83d575cea 100644 --- a/sys/net/include/socket_base.h +++ b/sys/net/include/socket_base.h @@ -1,7 +1,4 @@ -/** - * socket_base.h - Wraps all API types, constants and functions of the transport - * layer implementation. - * +/* * Copyright (C) 2013 INRIA. * * This file is subject to the terms and conditions of the GNU Lesser @@ -11,10 +8,15 @@ /** * @defgroup socket_base Transport layer implementation + * * @ingroup net - * @brief This module implements the transport layer. This includes - * 6LoWPAN UDP header compression and (experimental) 6LoWPAN TCP header - * compression. + * @brief This module implements basic transport layer socket functionality. + * This includes 6LoWPAN UDP header compression and (experimental) + * 6LoWPAN TCP header compression. + * + * It wraps all API types, constants and functions of the transport layer + * implementation. + * * @see * RFC 6282 - Compression Format for IPv6 Datagrams over * IEEE 802.15.4-Based Networks - UDP Header Compression diff --git a/sys/oneway-malloc/include/malloc.h b/sys/oneway-malloc/include/malloc.h index e74d1b7b0f..4d61cc929d 100644 --- a/sys/oneway-malloc/include/malloc.h +++ b/sys/oneway-malloc/include/malloc.h @@ -7,18 +7,22 @@ */ /** - * @defgroup oneway_malloc Oneway malloc implementation + * @defgroup oneway_malloc Oneway malloc * @ingroup sys - * @{ - * @file malloc.h - * @brief A malloc implementation for MSP-430 boards without free. * - * @details The toolchain of MSP-430 does not contain malloc() and friends. - * These functions provide the same interface as the stdlib functions, - * but the option to free memory. + * @brief A malloc implementation without free for boards where the + * toolchain does not implement dynamic memory allocation. + * + * The toolchain of MSP-430, for example, does not contain + * malloc() and friends. These functions provide the same + * interface as the stdlib functions, but the option to free + * memory. * * @note You should prefer statically allocated memory whenever possible. * + * @{ + * @file + * * @author Kaspar Schleiser * @author René Kijewski */