From d4166facccb01d89e239a9211c61e1d5c2ce6f29 Mon Sep 17 00:00:00 2001 From: Oleg Hahm Date: Sat, 6 Dec 2014 14:29:28 +0100 Subject: [PATCH] doc: add or move module description where missing --- drivers/include/netdev/802154.h | 2 +- drivers/include/nrf24l01p.h | 3 +++ drivers/include/radio_driver.h | 3 ++- sys/include/pipe.h | 6 ++++-- sys/include/transceiver.h | 13 ++++++++----- sys/net/include/socket_base.h | 16 +++++++++------- sys/oneway-malloc/include/malloc.h | 18 +++++++++++------- 7 files changed, 38 insertions(+), 23 deletions(-) diff --git a/drivers/include/netdev/802154.h b/drivers/include/netdev/802154.h index cc9cc6bbe6..b83e3e44af 100644 --- a/drivers/include/netdev/802154.h +++ b/drivers/include/netdev/802154.h @@ -7,7 +7,7 @@ */ /** - * @ingroupgroup netdev + * @addtogroup netdev * * @{ * @file diff --git a/drivers/include/nrf24l01p.h b/drivers/include/nrf24l01p.h index f6becc55c1..94f580502e 100644 --- a/drivers/include/nrf24l01p.h +++ b/drivers/include/nrf24l01p.h @@ -9,6 +9,9 @@ /** * @defgroup drivers_nrf24l01p NRF24L01+ Driver Interface * @ingroup drivers + * + * @brief Low-level driver for nrf24l01+ transceiver + * * @{ * @file * diff --git a/drivers/include/radio_driver.h b/drivers/include/radio_driver.h index eb4c04260f..7a39d1caf9 100644 --- a/drivers/include/radio_driver.h +++ b/drivers/include/radio_driver.h @@ -8,9 +8,10 @@ /** * @defgroup radio_driver IEEE 802.15.4 radio driver interface - * @brief API definitions for 802.15.4 radio transceivers' drivers * @ingroup drivers * + * @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 5e36ca917d..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 - * @brief Transceiver library * @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/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 */