kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-25 22:43:50 +01:00
Code Releases Activity

Merge pull request #2150 from OlegHahm/more_doc_cleanup

Browse Source 
doc: More documentation cleanup
This commit is contained in:
Ludwig Ortmann 2014-12-22 11:58:59 +01:00
commit 5e0973ca89
18 changed files with 72 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cpu/cc2538/include/cc2538.h
View File

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

28
cpu/mc1322x/maca/include/maca_packet.h
View File

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

4
doc/doxygen/riot.doxyfile
View File

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

2
drivers/cc110x/cc110x-internal.h
View File

@ -11,7 +11,7 @@
* @ingroup drivers_cc110x
* @{
*
* @file cc110x-internal.h
* @file
* @brief Driver internal constants for CC110x chip configuration
*
* @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de>

2
drivers/cc110x_legacy/cc110x-internal.h
View File

@ -11,7 +11,7 @@
* @ingroup drivers_cc110x_legacy
* @{
*
* @file cc110x-internal.h
* @file
* @brief Driver internal constants for 110x chip configuration
*
* @author Thomas Hillebrandt <hillebra@inf.fu-berlin.de>

2
drivers/include/cc110x/cc110x-config.h
View File

@ -11,7 +11,7 @@
* @ingroup drivers_cc110x
* @{
*
* @file cc110x-config.h
* @file
* @brief Configuration parameters for the cc110x radio chip
*
* @author Oliver Hahm <oliver.hahm@inria.fr>

2
drivers/include/cc110x/cc110x-interface.h
View File

@ -13,7 +13,7 @@
* @ingroup drivers
* @{
*
* @file cc110x-interface.h
* @file
* @brief Data structures and variables for the cc110x driver interface
*
* @author Oliver Hahm <oliver.hahm@inria.fr>

2
drivers/include/cc110x/cc110x-reg.h
View File

@ -11,7 +11,7 @@
* @ingroup drivers_cc110x
* @{
*
* @file cc110x-reg.h
* @file
* @brief Access to CC110X registers
*
* @author Oliver Hahm <oliver.hahm@inria.fr>

2
drivers/include/cc110x_legacy/cc110x-config.h
View File

@ -11,7 +11,7 @@
* @ingroup drivers_cc110x_legacy
* @{
*
* @file cc110x-config.h
* @file
* @brief Configuration parameters for the cc110x radio chip
*
* @author Oliver Hahm <oliver.hahm@inria.fr>

2
drivers/include/cc110x_legacy/cc110x-reg.h
View File

@ -11,7 +11,7 @@
* @ingroup drivers_cc110x_legacy
* @{
*
* @file cc110x-reg.h
* @file
* @brief Access to CC110X registers
*
* @author Oliver Hahm <oliver.hahm@inria.fr>

4
drivers/include/netdev/802154.h
View File

@ -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 <Kevin.Roussel@inria.fr>
* @author Martine Lenders <mlenders@inf.fu-berlin.de>

5
drivers/include/nrf24l01p.h
View File

@ -9,11 +9,12 @@
/**
* @defgroup drivers_nrf24l01p NRF24L01+ Driver Interface
* @ingroup drivers
* @{
*
* @file
* @brief Low-level driver for nrf24l01+ transceiver
*
* @{
* @file
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Peter Kietzmann <peter.kietzmann@haw-hamburg.de>
*

9
drivers/include/radio_driver.h
View File

@ -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 <Kevin.Roussel@inria.fr>
*
*/

6
sys/include/pipe.h
View File

@ -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 <rene.kijewski@fu-berlin.de>
*/

15
sys/include/transceiver.h
View File

@ -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 <oliver.hahm@inria.fr>
*/
@ -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];

2
sys/net/include/rpl/rpl_storing.h
View File

@ -7,7 +7,7 @@
*/
/**
* @ingroup net
* @ingroup rpl
* @brief Routing Protocol for Low power and Lossy Networks
* @{
*

16
sys/net/include/socket_base.h
View File

@ -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 <a href="http://tools.ietf.org/html/rfc6282#section-4.3">
* RFC 6282 - Compression Format for IPv6 Datagrams over
* IEEE 802.15.4-Based Networks - UDP Header Compression

18
sys/oneway-malloc/include/malloc.h
View File

@ -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 <kaspar@schleiser.de>
* @author René Kijewski <rene.kijewski@fu-berlin.de>
*/