kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-30 17:01:19 +01:00
Code Releases Activity

Merge pull request #2117 from OlegHahm/doxygen_eliminate_warnings

Browse Source 
Doxygen eliminate warnings pt. 2
This commit is contained in:
Oleg Hahm 2014-12-04 17:18:42 +01:00
commit 000450c894
65 changed files with 200 additions and 190 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
boards/chronos/include/board.h
View File

@ -18,8 +18,8 @@
* @author unknwon
*/
#ifndef _MSB_BOARD_H
#define _MSB_BOARD_H
#ifndef _CHRONOS_BOARD_H
#define _CHRONOS_BOARD_H
#include <stdint.h>
@ -44,4 +44,5 @@ typedef uint8_t radio_packet_length_t;
}
#endif
#endif // _MSB_BOARD_H
#endif /* _CHRONOS_BOARD_H */
/** @} */

6
boards/mbed_lpc1768/include/board.h
View File

@ -33,12 +33,12 @@ extern "C" {
#endif
/**
* @name The nominal CPU core clock in this board
* @brief The nominal CPU core clock in this board
*/
#define F_CPU (96000000)
/**
* @name Assign the peripheral timer to be used as hardware timer
* @brief Assign the peripheral timer to be used as hardware timer
*/
#define HW_TIMER TIMER_0
@ -89,7 +89,7 @@ extern "C" {
/** @} */
/**
* @name define radio packet length
* @brief define radio packet length
*/
typedef uint8_t radio_packet_length_t;

1
boards/msb-430-common/include/board-conf.h
View File

@ -34,3 +34,4 @@ extern "C" {
#endif
#endif /* BOARD-CONF_H */
/** @} */

2
boards/msba2-common/include/msba2_common.h
View File

@ -12,7 +12,7 @@
* @brief Common files for all MSB-A2 based boards
* @{
*
* @files msba2-common.h
* @file
* @brief MSB-A2 Common Board Definitions
*
* @author Kaspar Schleiser <kaspar@schleiser.de>

1
boards/msba2/include/board.h
View File

@ -48,3 +48,4 @@ typedef uint8_t radio_packet_length_t;
#endif
#endif /* __BOARD_H */
/** @} */

3
boards/pca10000/include/board.h
View File

@ -34,7 +34,7 @@ extern "C" {
#define F_CPU (16000000UL)
/**
* @name Assign the hardware timer
* @brief Assign the hardware timer
*/
#define HW_TIMER TIMER_0
@ -70,6 +70,7 @@ extern "C" {
#define LED_BLUE_ON (NRF_GPIO->OUTCLR = LED_BLUE_PIN)
#define LED_BLUE_OFF (NRF_GPIO->OUTSET = LED_BLUE_PIN)
#define LED_BLUE_TOGGLE (NRF_GPIO->OUT ^= LED_BLUE_PIN)
/** @} */
/**

1
boards/redbee-econotag/include/board.h
View File

@ -40,3 +40,4 @@ typedef uint8_t radio_packet_length_t;
#endif
#endif
/** @} */

36
core/include/byteorder.h
View File

@ -230,7 +230,7 @@ static inline uint64_t byteorder_swapll(uint64_t v);
* @param[in] v The integer to convert.
* @returns Converted integer.
*/
static inline uint16_t HTONS(uint16_t a);
static inline uint16_t HTONS(uint16_t v);
/**
* @brief Convert from host byte order to network byte order, 32 bit.
@ -238,7 +238,7 @@ static inline uint16_t HTONS(uint16_t a);
* @param[in] v The integer to convert.
* @returns Converted integer.
*/
static inline uint32_t HTONL(uint32_t a);
static inline uint32_t HTONL(uint32_t v);
/**
* @brief Convert from host byte order to network byte order, 64 bit.
@ -246,7 +246,7 @@ static inline uint32_t HTONL(uint32_t a);
* @param[in] v The integer to convert.
* @returns Converted integer.
*/
static inline uint64_t HTONLL(uint64_t a);
static inline uint64_t HTONLL(uint64_t v);
/**
* @brief Convert from network byte order to host byte order, 16 bit.
@ -254,7 +254,7 @@ static inline uint64_t HTONLL(uint64_t a);
* @param[in] v The integer to convert.
* @returns Converted integer.
*/
static inline uint16_t NTOHS(uint16_t a);
static inline uint16_t NTOHS(uint16_t v);
/**
* @brief Convert from network byte order to host byte order, 32 bit.
@ -262,7 +262,7 @@ static inline uint16_t NTOHS(uint16_t a);
* @param[in] v The integer to convert.
* @returns Converted integer.
*/
static inline uint32_t NTOHL(uint32_t a);
static inline uint32_t NTOHL(uint32_t v);
/**
* @brief Convert from network byte order to host byte order, 64 bit.
@ -270,7 +270,7 @@ static inline uint32_t NTOHL(uint32_t a);
* @param[in] v The integer to convert.
* @returns Converted integer.
*/
static inline uint64_t NTOHLL(uint64_t a);
static inline uint64_t NTOHLL(uint64_t v);
/* **************************** IMPLEMENTATION ***************************** */
@ -379,36 +379,36 @@ static inline uint64_t byteorder_ntohll(network_uint64_t v)
return _byteorder_swap(v.u64, ll);
}
static inline uint16_t HTONS(uint16_t a)
static inline uint16_t HTONS(uint16_t v)
{
return byteorder_htons(a).u16;
return byteorder_htons(v).u16;
}
static inline uint32_t HTONL(uint32_t a)
static inline uint32_t HTONL(uint32_t v)
{
return byteorder_htonl(a).u32;
return byteorder_htonl(v).u32;
}
static inline uint64_t HTONLL(uint64_t a)
static inline uint64_t HTONLL(uint64_t v)
{
return byteorder_htonll(a).u64;
return byteorder_htonll(v).u64;
}
static inline uint16_t NTOHS(uint16_t a)
static inline uint16_t NTOHS(uint16_t v)
{
network_uint16_t input = { a };
network_uint16_t input = { v };
return byteorder_ntohs(input);
}
static inline uint32_t NTOHL(uint32_t a)
static inline uint32_t NTOHL(uint32_t v)
{
network_uint32_t input = { a };
network_uint32_t input = { v };
return byteorder_ntohl(input);
}
static inline uint64_t NTOHLL(uint64_t a)
static inline uint64_t NTOHLL(uint64_t v)
{
network_uint64_t input = { a };
network_uint64_t input = { v };
return byteorder_ntohll(input);
}

4
core/include/priority_queue.h
View File

@ -27,7 +27,7 @@
#endif
/**
* data type for priority queue nodes
* @brief data type for priority queue nodes
*/
typedef struct priority_queue_node_t {
struct priority_queue_node_t *next; /**< next queue node */
@ -36,7 +36,7 @@ typedef struct priority_queue_node_t {
} priority_queue_node_t;
/**
* data type for priority queues
* @brief data type for priority queues
*/
typedef struct queue {
priority_queue_node_t *first; /**< first queue node */

2
core/include/thread.h
View File

@ -72,7 +72,7 @@
* @param[in] stacksize the size of the thread's stack in bytes
* @param[in] priority priority of the new thread, lower mean higher priority
* @param[in] flags optional flags for the creation of the new thread
* @param[in] function pointer to the code that is executed in the new thread
* @param[in] task_func pointer to the code that is executed in the new thread
* @param[in] arg the argument to the function
* @param[in] name a human readable descriptor for the thread
*

34
cpu/atmega_common/avr-libc-extra/errno.h
View File

@ -28,27 +28,27 @@
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE. */
/* \cond DOXYGEN_BLACKLIST */
/* $Id$ */
#ifndef __ERRNO_H_
#define __ERRNO_H_ 1
/** \file */
/** \defgroup avr_errno <errno.h>: System Errors
\code #include <errno.h>\endcode
Some functions in the library set the global variable \c errno when an
error occurs. The file, \c <errno.h>, provides symbolic names for various
error codes.
\warning The \c errno global variable is not safe to use in a threaded or
multi-task system. A race condition can occur if a task is interrupted
between the call which sets \c error and when the task examines \c
errno. If another task changes \c errno during this time, the result will
be incorrect for the interrupted task. */
/**
* @file
*
* @defgroup avr_errno <errno.h>: System Errors
*
* @code #include <errno.h>@endcode
*
* Some functions in the library set the global variable @c errno when an
* error occurs. The file, @c <errno.h>, provides symbolic names for various
* error codes.
*
* @warning The @c errno global variable is not safe to use in a threaded or
* multi-task system. A race condition can occur if a task is interrupted
* between the call which sets @c error and when the task examines @c
* errno. If another task changes @c errno during this time, the result will
* be incorrect for the interrupted task.
*/
#ifdef __cplusplus
extern "C" {

1
cpu/cc2538/include/cc2538-uart.h
View File

@ -166,3 +166,4 @@ extern cc2538_uart_t * const UART1; /**< UART1 Instance */
#endif
#endif /* CC2538_UART_H */
/** @} */

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

@ -7,7 +7,7 @@
*/
/**
* @addtogroup cpu_cc2538_definitions
* @ingroup cpu_cc2538_definitions
* @{
*
* @file cc2538.h
@ -99,7 +99,7 @@ void SVC_Handler(void); /**< SVC handler */
void DebugMon_Handler(void); /**< Debug monitor handler */
void PendSV_Handler(void); /**< PendSV handler */
void SysTick_Handler(void); /**< SysTick handler */
/* @} */
/** @} */
/**
* @brief Configuration of the Cortex-M3 Processor and Core Peripherals

7
cpu/mc1322x/include/cpu.h
View File

@ -11,17 +11,12 @@
* @defgroup mc1322x Freescale MC1322x
* @ingroup cpu
* @brief Freescale MC1322x specific code
* @{
*/
#ifndef CPU_H
#define CPU_H
/**
* @defgroup mc1322x Freescale mc1322x
* @ingroup cpu
* @{
*/
#include <stdbool.h>
#include "arm_cpu.h"
#include "mc1322x.h"

3
cpu/native/include/native_internal.h
View File

@ -11,8 +11,7 @@
*/
/**
* @ingroup arch
* @defgroup native_cpu Native CPU
* @addtogroup native_cpu
* @{
* @author Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>
*/

8
cpu/native/include/nativenet.h
View File

@ -1,4 +1,4 @@
/**
/*
* nativenet transceiver interface
*
* A configurable transceiver for the native port.
@ -16,7 +16,7 @@
*/
/**
* @defgroup native_net
* @defgroup native_net Native network interface
* @ingroup native_cpu
* @{
* @author Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>
@ -62,7 +62,7 @@ extern "C" {
extern const netdev_driver_t nativenet_driver;
/**
* @brief Default @netdev API device
* @brief Default @ref netdev API device
*/
extern netdev_t nativenet_default_dev;
@ -144,7 +144,7 @@ int16_t nativenet_get_channel(void);
/**
* Set transceiver pan
*
* @param channel the pan
* @param pan the pan
* @return the pan
*/
uint16_t nativenet_set_pan(uint16_t pan);

4
cpu/sam3x8e/include/system_sam3xa.h
View File

@ -40,7 +40,7 @@
#ifndef SYSTEM_SAM3X_H_INCLUDED
#define SYSTEM_SAM3X_H_INCLUDED
/* @cond 0 */
/* @cond @false */
/**INDENT-OFF**/
/**INDENT-ON**/
/* @endcond */
@ -70,7 +70,7 @@ void SystemCoreClockUpdate(void);
*/
void system_init_flash(uint32_t dw_clk);
/* @cond 0 */
/* @cond @false */
/**INDENT-OFF**/
#ifdef __cplusplus
}

8
cpu/stm32f1/include/cpu-conf.h
View File

@ -20,8 +20,8 @@
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/
#ifndef CPUCONF_H_
#define CPUCONF_H_
#ifndef __CPU_CONF_H
#define __CPU_CONF_H
#include "stm32f10x.h"
@ -56,12 +56,12 @@ extern "C" {
/** @} */
/**
* @name Length for reading CPU_ID
* @brief Length for reading CPU_ID
*/
#define CPUID_ID_LEN (12)
/**
* @name Definition of different panic modes
* @brief Definition of different panic modes
*/
typedef enum {
HARD_FAULT,

18
cpu/x86/include/cpu.h
View File

@ -71,13 +71,13 @@ static inline void __attribute__((always_inline, noreturn)) x86_hlt(void)
* @brief Initialize subsystems and run kernel.
*
* Called by the board specific startup code.
* <li>The .bss has to be cleared before.
* <li>The stack has to be set up, probably somewhere in the low memory.
* <li>The A20 line has to be activated, because all the code is beyong 1MB.
* <li>Paging must be disabled.
* <li>The SS, DS, and CS must span the whole 4GB of RAM.
* <li>32 bit protected mode must be entered.
* <li>Interrupts must be disabled.
* @li The .bss has to be cleared before.
* @li The stack has to be set up, probably somewhere in the low memory.
* @li The A20 line has to be activated, because all the code is beyond 1MB.
* @li Paging must be disabled.
* @li The SS, DS, and CS must span the whole 4GB of RAM.
* @li 32 bit protected mode must be entered.
* @li Interrupts must be disabled.
*/
void x86_startup(void) NORETURN;
@ -90,8 +90,8 @@ void x86_startup(void) NORETURN;
* Interrupts may be enabled during the course of this function call.
*
* Probably most of the board specific initialization should be done in auto_init():
* <li>You must not spawn thread_create() in this function.
* <li>The hwtimer is not set up properly at this point of executation.
* @li You must not spawn thread_create() in this function.
* @li The hwtimer is not set up properly at this point of executation.
*/
void x86_init_board(void);

2
cpu/x86/include/x86_interrupts.h
View File

@ -79,7 +79,7 @@ enum x86_eflags {
X86_AF = 1 << 4, /**< adjust */
X86_ZF = 1 << 6, /**< zero */
X86_SF = 1 << 7, /**< signed */
X86_TF = 1 << 8, /**< singled step (throw #DB after each instruction) */
X86_TF = 1 << 8, /**< singled step (throw #X86_INT_DB after each instruction) */
X86_IF = 1 << 9, /**< interrupts enabled */
X86_DF = 1 << 10, /**< direction (0 = movs increses addresses, 1 = movs decreases addresses) */
X86_OF = 1 << 11, /**< overflow */

2
cpu/x86/include/x86_pic.h
View File

@ -140,7 +140,7 @@ typedef void (*x86_irq_handler_t)(uint8_t irq_num);
* The PIC default handler will still send an EOI.
* Especially the keyboard controller does not like it,
* if it is told that everything was done but it wasn't.
* A raised #GP might be the least of your problems.
* A raised #X86_INT_GP might be the least of your problems.
*/
void x86_pic_set_handler(unsigned irq, x86_irq_handler_t handler);

11
cpu/x86/include/x86_registers.h
View File

@ -37,8 +37,11 @@ extern "C" {
/* see "Intel® Quark SoC X1000 Core Developer’s Manual", § 4.4.1.1 (p. 47) */
#define CR0_PE (1u << 0) /**< 1 = protected mode */
#define CR0_MP (1u << 1) /**< 1 = monitor coprocessor (FWAIT causes an interrupt) */
#define CR0_EM (1u << 2) /**< 1 = FPU emulation (x87 instruction cause #NM, SSE causes #UD) */
#define CR0_TS (1u << 3) /**< 1 = task switched flag (causes #NM on x87/SSE instructions, set by CPU on hardware task switch) */
#define CR0_EM (1u << 2) /**< 1 = FPU emulation (x87 instructions cause
#X86_INT_NM, SSE causes #X86_INT_UD) */
#define CR0_TS (1u << 3) /**< 1 = task switched flag (causes #X86_INT_NM on
x87/SSE instructions, set by CPU on hardware
task switch) */
#define CR0_ET (1u << 4) /**< 1 = 80387; 0 = 80287 */
#define CR0_NE (1u << 5) /**< 1 = numeric error */
#define CR0_WP (1u << 16) /**< 1 = write proctected pages aren't writable in ring 0 either */
@ -59,7 +62,7 @@ extern "C" {
#define CR4_MCE (1u << 6) /**< 1 = machine-check enable */
#define CR4_PGE (1u << 7) /**< 1 = enable G flag in PT */
#define CR4_PCE (1u << 8) /**< 1 = allow RDPMC instruction in rings 1-3, too */
#define CR4_OSFXSR (1u << 9) /**< 1 = disable #NM if CR0.TS=1 */
#define CR4_OSFXSR (1u << 9) /**< 1 = disable #X86_INT_NM if CR0.TS=1 */
#define CR4_OSXMMEXCPT (1u << 10) /**< 1 = enable unmasked SSE exceptions */
#define CR4_SMEP (1u << 10) /**< 1 = enables supervisor-mode execution prevention */
@ -91,7 +94,7 @@ static inline void X86_CR_ATTR cr0_write(uint32_t value)
* @brief Read the Page Fault Linear Address.
*
* The PFLA is the address which was accessed when the page fauled occured,
* i.e. this is not the PC of the #PF!
* i.e. this is not the PC of the \#PF!
*/
static inline uint32_t X86_CR_ATTR cr2_read(void)
{

6
cpu/x86/include/x86_rtc.h
View File

@ -115,9 +115,9 @@ typedef union x86_rtc_data {
* You must not call this function on your own accord.
*
* The RTC subsystem will refuse to work if the CMOS says that
* <li>there was a power loss,
* <li>the stored time is invalid (i.e. February 30), or
* <li>the CMOS had a checksum failure.
* @li there was a power loss,
* @li the stored time is invalid (i.e. February 30), or
* @li the CMOS had a checksum failure.
*/
void x86_init_rtc(void);

2
cpu/x86/include/x86_videoram.h
View File

@ -37,7 +37,7 @@ extern "C" {
*
* This method can be used before the UART system was initialized.
*
* Special charactes that are understood: '\n' and '\r'.
* Special characters that are understood: '\\n' and '\\r'.
* Use DOS newlines.
*/
void videoram_putc(char c);

2
drivers/cc110x_legacy_csma/cc1100.h
View File

@ -191,7 +191,7 @@ char *cc1100_mode_to_text(uint8_t mode);
/**
* @brief Convert radio state to textual representation.
*
* @param mode The radio state to convert.
* @param state The radio state to convert.
*
* @return Textual representation of radio state.
*/

4
drivers/include/cc2420.h
View File

@ -73,7 +73,9 @@ Frame type value:
011 | MAC command
1xx | Reserved
</pre>
*/
* This corresponds to IEEE 802.15.4 frame format.
*/
#ifndef CC2420_H
#define CC2420_H

10
drivers/include/lm75a-temp-sensor.h
View File

@ -186,12 +186,10 @@ void lm75A_reset(void);
* This function prints the values of all registers over
* the rs232 interface.
*
* @param[in] external_interr_handler pointer to an external task handler
* which is performed, if an external
* interrupt is occurred and the external
* subroutine is leaved. This parameter
* is optional, the NULL-value can be
* entered.
* @param[in] extern_interrupt_task pointer to an external task handler that
* is executed, if an external interrupt
* occurrs left. This is an optional
* parameter therefore NULL is a legal value.
*/
void lm75A_start_sensor_sampling(void (*extern_interrupt_task)(void));

2
drivers/include/lps331ap.h
View File

@ -31,7 +31,7 @@ extern "C" {
#include "periph/i2c.h"
/**
* @name The sensors default I2C address
* @brief The sensors default I2C address
*/
#define LPS331AP_DEFAULT_ADDRESS 0x5c

14
drivers/include/netdev/base.h
View File

@ -60,14 +60,14 @@ typedef enum {
/**
* @brief Radio frame protocol
*
* @detail Sends frames as defined by radio_packet_t.
* @details Sends frames as defined by radio_packet_t.
*/
NETDEV_PROTO_RADIO = 0x0001,
/**
* @brief IEEE 802.15.4
*
* @detail Sends frames as defined by ieee802154_frame_t
* @details Sends frames as defined by ieee802154_frame_t
*/
NETDEV_PROTO_802154 = 0x0002,
NETDEV_PROTO_6LOWPAN = 0x0003, /**< 6LoWPAN. */
@ -92,7 +92,7 @@ typedef enum {
/**
* @brief Communication type for the device as defined by @ref netdev_proto_t
*
* @detail If a driver does not support the type (but the setting of the
* @details If a driver does not support the type (but the setting of the
* option is supported) it @ref netdev_driver_t::set_option() shall result
* with -EPROTONOSUPPORT.
*
@ -120,9 +120,9 @@ typedef enum {
EUI-64 in IEEE 802.15.4) */
/**
* @brief Last value for @netdev_opt_t defined here
* @brief Last value for @ref netdev_opt_t defined here
*
* @detail Specific devices or modules like @ref netapi that utilize these
* @details Specific devices or modules like @ref netapi that utilize these
* values to may define higher values, but they must be greater
* or equal to @ref NETDEV_OPT_LAST.
*/
@ -192,7 +192,7 @@ typedef int (*netdev_rcv_data_cb_t)(netdev_t *dev, void *src, size_t src_len,
/**
* @brief Network device API definition.
*
* @details This is a set of functions that must be implemented by any driver
* @details This is a set of functions that must be implemented by any driver
* for a network device.
*/
typedef struct {
@ -328,7 +328,7 @@ typedef struct {
*
* @param[in] dev the network device that fired the event.
* @param[in] event_type Event type. Values are free to choose for the
* driver. Must be given in the @ref msg_t::content::value
* driver. Must be given in the @ref msg_t::value
* of the received message
*/
void (*event)(netdev_t *dev, uint32_t event_type);

3
drivers/include/netdev/default.h
View File

@ -23,8 +23,6 @@
#include "netdev/base.h"
/**
* @def NETDEV_DEFAULT
*
* @brief Default device as a pointer of netdev_t.
*/
#ifdef MODULE_AT86RF231
@ -62,3 +60,4 @@ extern "C" {
#endif /* MODULE_NATIVENET */
#endif /* __NETDEV_DEFAULT_H_ */
/** @} */

4
drivers/include/nrf24l01p.h
View File

@ -139,7 +139,7 @@ int nrf24l01p_read_reg(nrf24l01p_t *dev, char reg, char *answer);
*
* @param[in] dev Transceiver device to use.
* @param[in] reg Register address to write to.
* @param[in] answer Byte to write.
* @param[in] write Byte to write.
*
* @return 1 on success.
* @return -1 on error.
@ -155,7 +155,7 @@ int nrf24l01p_write_reg(nrf24l01p_t *dev, char reg, char write);
* @param[in] dev Transceiver device to use.
* @param[in] spi SPI device to use.
* @param[in] ce GPIO pin to use for chip enable.
* @param[in] cs GPIO pin to use for chip select.
* @param[in] csn GPIO pin to use for chip select.
* @param[in] irq GPIO pin to use for interrupt request.
*
* @return 1 on success.

2
drivers/include/rgbled.h
View File

@ -29,7 +29,7 @@ extern "C" {
#endif
/**
* @name Descriptor struct for rgbleds
* @brief Descriptor struct for rgbleds
*/
typedef struct {
pwm_t device;

2
drivers/include/servo.h
View File

@ -28,7 +28,7 @@ extern "C" {
#endif
/**
* @name Descriptor struct for a servo
* @brief Descriptor struct for a servo
*/
typedef struct {
pwm_t device; /**< the PWM device driving the servo */

6
sys/include/bloom.h
View File

@ -153,7 +153,7 @@ typedef struct {
*
* @param size size of the bit array in the filter
* @param num_hashes the number of hash functions
* @param functions varg function pointers, use hashfp_t
* @param ... varg function pointers, use hashfp_t
*
* @return An allocated bloom filter
*
@ -176,7 +176,7 @@ void bloom_del(bloom_t *bloom);
* Once a string has been added to the filter, it cannot be "removed"!
*
* @param bloom Bloom filter
* @param s string to add
* @param buf string to add
* @return nothing
*
*/
@ -212,7 +212,7 @@ void bloom_add(bloom_t *bloom, const uint8_t *buf, size_t len);
* can only speak a qualified YES.
*
* @param bloom Bloom filter
* @param s string to check
* @param buf string to check
* @return false if string does not exist in the filter
* @return true if string is may be in the filter
*

2
sys/include/cbor.h
View File

@ -288,7 +288,7 @@ size_t cbor_serialize_map(cbor_stream_t *s, size_t map_length);
* offset += cbor_deserialize_byte_string(&stream, offset, value2, sizeof(value)); // read value 2
* @endcode
*
* @param array_length Where the array length is stored
* @param map_length Where the array length is stored
*/
size_t cbor_deserialize_map(const cbor_stream_t *s, size_t offset, size_t *map_length);

27
sys/include/crypto/aes.h
View File

@ -100,12 +100,12 @@ int aes_setup_key(cipher_context_t *context, uint8_t *key, uint8_t keysize);
* plainBlock to one blocksize long block of ciphertext which will be
* written to the the memory-area pointed to by cipherBlock
*
* @param context the cipher_context_t-struct to use for this
* encryption
* @param plainBlock a pointer to the plaintext-block (of size
* blocksize)
* @param cipherBlock a pointer to the place where the ciphertext will
* be stored
* @param context the cipher_context_t-struct to use for this
* encryption
* @param plain_block a pointer to the plaintext-block (of size
* blocksize)
* @param cipher_block a pointer to the place where the ciphertext will
* be stored
*
* @return 1 or result of aes_set_encrypt_key if it failed
*/
@ -118,14 +118,15 @@ int aes_encrypt(cipher_context_t *context, uint8_t *plain_block,
* cipherBlock to one blocksize long block of plaintext and stores
* the plaintext in the memory-area pointed to by plainBlock
*
* @param context the cipher_context_t-struct to use for this
* decryption
* @param cipherBlock a pointer to the ciphertext-block (of size
* blocksize) to be decrypted
* @param plainBlock a pointer to the place where the decrypted
* plaintext will be stored
* @param context the cipher_context_t-struct to use for this
* decryption
* @param cipher_block a pointer to the ciphertext-block (of size
* blocksize) to be decrypted
* @param plain_block a pointer to the place where the decrypted
* plaintext will be stored
*
* @return 1 or result of ::aes_set_decrypt_key if it failed
* @return 1 or negative value if cipher key cannot be expanded into
* decryption key schedule
*/
int aes_decrypt(cipher_context_t *context, uint8_t *cipher_block,
uint8_t *plain_block);

7
sys/include/crypto/cbcmode.h
View File

@ -10,7 +10,7 @@
* @ingroup sys_crypto
* @{
*
* @file cbcmode.h
* @file
* @brief Headers of the implementation of the CBC Mode of Operation
*
* Implementation of the CBC Mode of Operation with Ciphertext-Stealing for encryption.
@ -71,7 +71,6 @@ enum {
/**
* @struct CBCModeContext CBCMode.c "CBCMode.c"
* @brief The context for processing the en-/decryption in the CBC-Mode with
* CTS
*
@ -128,7 +127,7 @@ int block_cipher_mode_init(CipherModeContext *context, uint8_t key_size,
* invocations of this module which use this particular
* key. It also contains the opaque context for the
* underlying BlockCipher as well.
* @param keySize key size in bytes.
* @param key_size key size in bytes.
* @param key pointer to the key.
* @param cipher_index the index of the cipher-algorithm to init in the
* (cipher-)archive
@ -142,7 +141,7 @@ int block_cipher_mode_init0(CipherModeContext *context, uint8_t key_size,
uint8_t *key, uint8_t cipher_index);
/**
* @brief prints the debug-messages passed by ::dumpBuffer
* @brief prints the debug-messages passed by @ref dump_buffer
*
* @param mode the mode of the debug-message
* @param format pointer to the message

4
sys/include/crypto/ciphers.h
View File

@ -69,9 +69,7 @@ typedef struct {
/**
* @struct BlockCipherInterface_t
* @brief BlockCipher-Interface for the Cipher-Algorithms
* @typedef BlockCipherInterface_t
*/
typedef struct {
char name[10];
@ -101,8 +99,6 @@ typedef struct CipherModeContext {
/**
* @brief struct for an archive of all available ciphers
* @struct BlockCipher_Archive_t CipherManager.h "ciphers/CipherManager.h"
* @typedef BlockCipher_Archive_t
*/
typedef struct {
// the number of available ciphers

6
sys/include/crypto/rc5.h
View File

@ -91,13 +91,13 @@ int rc5_init(cipher_context_t *context, uint8_t blockSize, uint8_t keySize,
* 1776 cycles (avg case)
*
* @param context the cipher_context_t-struct to save the updated key in
* @param plainBlock a plaintext block of blockSize
* @param cipherBlock the resulting ciphertext block of blockSize
* @param plain_block a plaintext block of blockSize
* @param cipher_block the resulting ciphertext block of blockSize
*
* @return Whether the encryption was successful. Possible failure reasons
* include not calling init().
*/
int rc5_encrypt(cipher_context_t *context, uint8_t *block, uint8_t *cipherBlock);
int rc5_encrypt(cipher_context_t *context, uint8_t *plain_block, uint8_t *cipher_block);
/**
* @brief Decrypts a single block (of blockSize) using the key and the

1
sys/include/crypto/skipjack.h
View File

@ -89,7 +89,6 @@ extern "C" {
/**
* @brief The cipher_context_t adapted for SkipJack
* @typedef skipjack_context_t
*/
typedef struct {
// 2 times keysize. makes unrolling keystream easier / efficient

6
sys/include/crypto/twofish.h
View File

@ -218,8 +218,8 @@ typedef struct {
* call. It should be passed to future invocations of
* this module
* which use this particular key.
* @param blockSize size of the block in bytes.
* @param keySize key size in bytes
* @param block_size size of the block in bytes.
* @param key_size key size in bytes
* @param key pointer to the key
*
* @return Whether initialization was successful. The command may be
@ -233,7 +233,7 @@ int twofish_init(cipher_context_t *context, uint8_t block_size, uint8_t key_size
*
* @param context the CipherContext-struct to save the updated key in
* @param key a pointer to the secret key
* @param keysize the length of the secret key
* @param key_size the length of the secret key
*
* @return SUCCESS
*/

1
sys/include/fd.h
View File

@ -96,3 +96,4 @@ void fd_destroy(int fd);
#endif
#endif /* FD_H */
/** @} */

2
sys/include/hashes.h
View File

@ -99,7 +99,7 @@ uint32_t sdbm_hash(const uint8_t *buf, size_t len);
uint32_t kr_hash(const uint8_t *buf, size_t len);
/**
* @bief sax_hash
* @brief sax_hash
*
* Shift, Add, XOR
*

14
sys/include/tm.h
View File

@ -80,17 +80,18 @@ int tm_doomsday(int year) CONST;
* @details Illegal dates are not catched.
* @param[in] year The year. Probably should be ≥ 1582, but needs to be ≥ 1.
* @param[in] mon The month, TM_MON_JAN to TM_MON_DEC.
* @param[in] day The day in the month, 1 to 31.
* @param[in] mday The day in the month, 1 to 31.
* @param[out] wday Returns the day of the week.
* @param[out] yday Returns the day of the year (Jan 1st is 0).
*/
void tm_get_wyday(int year, int mon, int mday, int *wday, int *yday);
/**
* @brief Fills in `struct tm::tm_wday` and `struct tm::tm_yday` given a date.
* @details `struct tm::tm_year`, `struct tm::tm_mon`, and `struct tm::tm_mday`
* need to be set before you call this function.
* @param[in,out] The datum to operate on.
* @brief Fills in `struct tm::tm_wday` and `struct tm::tm_yday` given a date.
* @details `struct tm::tm_year`, `struct tm::tm_mon`, and `struct
* tm::tm_mday` need to be set before you call this
* function.
* @param[in,out] tm The datum to operate on.
*/
void tm_fill_derived_values(struct tm *tm);
@ -99,7 +100,7 @@ void tm_fill_derived_values(struct tm *tm);
* @details Dates before 1582-10-15 are invalid.
* @param[in] year The year.
* @param[in] mon The month.
* @param[in] day The day in the month.
* @param[in] mday The day in the month.
* @returns 0 iff the date is invalid.
*/
int tm_is_valid_date(int year, int mon, int mday) CONST;
@ -119,3 +120,4 @@ int tm_is_valid_time(int hour, int min, int sec) CONST;
#endif
#endif
/** @} */

3
sys/include/vtimer.h
View File

@ -32,6 +32,9 @@
extern "C" {
#endif
/**
* @brief IPC message type for vtimer msg callback
*/
#define MSG_TIMER 12345
/**

2
sys/net/include/ieee802154_frame.h
View File

@ -12,7 +12,7 @@
* @brief IEEE802.15.4 adapaption layer
* @{
*
* @file ieee802154/ieee802154_frame.h
* @file
* @brief IEEE 802.14.4 framing data structs and prototypes
*
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>

6
sys/net/include/net_if.h
View File

@ -352,8 +352,8 @@ int net_if_send_packet_long(int if_id, net_if_eui64_t *target,
* the destination broadcast address. Choose
* NET_IF_TRANS_ADDR_M_SHORT if you are not
* sure
* @param[in] packet_data The packet to send
* @param[in] packet_len The length of the packet's data in byte,
* @param[in] payload The packet to send
* @param[in] payload_len The length of the packet's data in byte,
* negative number on error.
*
* @return The number of bytes send on success, negative value on failure
@ -402,7 +402,7 @@ int net_if_get_eui64(net_if_eui64_t *eui64, int if_id, int force_generation);
/**
* @brief Parses a string to an EUI-64.
* @detail The parsing will be back to front, every non-hexadecimal character
* @details The parsing will be back to front, every non-hexadecimal character
* and every hexadecimal character beyond the count of 8 will be
* ignored
*

5
sys/net/include/netapi.h
View File

@ -128,8 +128,9 @@ typedef enum {
* but interpret them **always optimisticly**.
*
* A protocol should at least always answer with an acknowledgement of
* result @netapi NETAPI_STATUS_OK if the operation was successfull or
* with errno -ENOTSUP if the operation is not supported.
* result @ref netapi NETAPI_STATUS_OK if the operation was
* successfull or with errno -ENOTSUP if the operation is not
* supported.
*/
typedef enum {
/**

12
sys/net/include/pktbuf.h
View File

@ -37,9 +37,9 @@ extern "C" {
#ifndef PKTBUF_SIZE
/**
* @brief Maximum size of the packet buffer.
* @brief Maximum size of the packet buffer.
*
* @detail The rational here is to have at least space for 4 full-MTU IPv6
* @details The rational here is to have at least space for 4 full-MTU IPv6
* packages (2 incoming, 2 outgoing; 2 * 2 * 1280 B = 5 KiB) +
* Meta-Data (roughly estimated to 1 KiB; might be smaller)
*/
@ -63,7 +63,7 @@ void *pktbuf_alloc(size_t size);
* @brief Reallocates new space in the packet buffer, without changing the
* content.
*
* @datail If enough memory is available behind it or *size* is smaller than
* @details If enough memory is available behind it or *size* is smaller than
* the original size the packet will not be moved. Otherwise, it will
* be moved. If no space is available nothing happens.
*
@ -95,7 +95,7 @@ void *pktbuf_insert(const void *data, size_t size);
/**
* @brief Copies packet data into the packet buffer, safely.
*
* @detail Use this instead of memcpy, since it is thread-safe and checks if
* @details Use this instead of memcpy, since it is thread-safe and checks if
* *pkt* is
*
* -# in the buffer at all
@ -118,7 +118,7 @@ int pktbuf_copy(void *pkt, const void *data, size_t data_len);
/**
* @brief Marks the data as being processed.
*
* @detail Internally this increments just a counter on the data.
* @details Internally this increments just a counter on the data.
* @ref pktbuf_release() decrements it. If the counter is <=0 the
* reserved data block in the buffer will be made available again.
*
@ -131,7 +131,7 @@ void pktbuf_hold(const void *pkt);
*
* @param[in] pkt The packet you want mark as not being processed anymore.
*
* @detail Internally this decrements just a counter on the data.
* @details Internally this decrements just a counter on the data.
* @ref pktbuf_hold() increments and any allocation
* operation initializes it. If the counter is <=0 the reserved data
* block in the buffer will be made available again.

6
sys/net/include/pktqueue.h
View File

@ -13,7 +13,7 @@
* @{
*
* @file pktqueue.h
* @brief Pointer-centric wrapper for @ref priority_queue
* @brief Pointer-centric wrapper for @ref priority_queue_t
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/
@ -87,7 +87,7 @@ static inline void pktqueue_init(pktqueue_t *queue)
/**
* @brief get the packet queue's head without removing it
*
* @param[out] root the queue
* @param[out] queue the queue
*
* @return the head
*/
@ -99,7 +99,7 @@ static inline pktqueue_node_t *pktqueue_get_head(pktqueue_t *queue)
/**
* @brief remove the packet queue's head
*
* @param[in] root the queue
* @param[in] queue the queue
*
* @return the old head
*/

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

@ -11,7 +11,7 @@
* @brief Routing Protocol for Low power and Lossy Networks
* @{
*
* @file rpl_mode.h
* @file
* @brief RPL storing-mode header
*
* Header which includes all mode related RPL-functions. All functions are mandatory for any
@ -149,7 +149,7 @@ void rpl_recv_dao_ack_mode(void);
*
* @param[in] destination IPv6-address of the destination of the message.
* @param[in] payload Payload of the message.
* @param[in] len Length of the message
* @param[in] p_len Length of the message
* @param[in] next_header Index to next header in message.
*
*/

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

@ -218,15 +218,15 @@ void icmpv6_send_router_adv(ipv6_addr_t *addr, uint8_t sllao,
* *aro* == OPT_ARO add it, else not.
*/
void icmpv6_send_neighbor_sol(ipv6_addr_t *src, ipv6_addr_t *dest,
ipv6_addr_t *targ, uint8_t slloa,
ipv6_addr_t *targ, uint8_t sllao,
uint8_t aro);
/**
* @brief Send ICMPv6 neighbor advertisement.
*
* @param[in] src Source address for IPv6 header.
* @param[in] dest Destination address for IPv6 header.
* @param[in] targ Value for target address field of neighbor
* @param[in] dst Destination address for IPv6 header.
* @param[in] tgt Value for target address field of neighbor
* advertisement.
* @param[in] rso Value for flags field of neighbor advertisement.
* @param[in] sllao Flag to include source link-layer address

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

@ -68,7 +68,9 @@ extern "C" {
/**
* @brief Next header value for source routing
* @see <a href="http://tools.ietf.org/html/rfc5095#section-1">
*/
* RFC 5095, section 1
* </a>
*/
#define IPV6_PROTO_NUM_SRH (43)
/**
@ -492,7 +494,6 @@ static inline net_if_eui64_t *ipv6_addr_get_iid(const ipv6_addr_t *ipv6_addr,
*
* @param[in] if_id The interface's ID.
* @param[in] addr Address to be added to the interface.
* @param[in] type Type of this address.
* @param[in] state Initial state of the address.
* @param[in] val_ltime Valid lifetime of this address in seconds. Set 0
* for unspecified.
@ -520,7 +521,6 @@ int ipv6_net_if_add_addr(int if_id, const ipv6_addr_t *addr,
*
* @param[out] src The best source address for this node (may be
* all zero if ther is none).
* @param[in] if_id The interface's ID.
* @param[in] dest The destination address for a packet we search
* the source address for.
*/

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

@ -46,3 +46,4 @@ extern "C" {
#endif
#endif /* SOCKET_BASE_H */
/** @} */

4
sys/net/include/socket_base/socket.h
View File

@ -270,8 +270,8 @@ int32_t socket_base_send(int s, const void *buf, uint32_t len, int flags);
* @param[in] len Length of buffer.
* @param[in] flags Flags for possible later implementations (currently
* unused).
* @param[in] from IPv6 Address to send data to.
* @param[in] fromlen Length of address in *from* in byte (always 16).
* @param[in] to IPv6 Address to send data to.
* @param[in] tolen Length of address in *to* in byte (always 16).
*
* @return Number of send bytes, -1 on error.
*/

1
sys/net/include/tcp.h
View File

@ -46,3 +46,4 @@ int tcp_init_transport_layer(void);
#endif
#endif /* TCP_H */
/** @} */

3
sys/net/include/udp.h
View File

@ -7,7 +7,7 @@
*/
/**
* @defgroup tcp UDP implementation
* @defgroup udp UDP implementation
* @ingroup net
* @brief This module implements the transport layer protocol UDP.
* This includes 6LoWPAN UDP header compression.
@ -46,3 +46,4 @@ int udp_init_transport_layer(void);
#endif
#endif /* UDP_H */
/** @} */

2
sys/net/network_layer/sixlowpan/border/border.h
View File

@ -9,7 +9,7 @@
*
* @ingroup sixlowpan
* @{
* @file sixlowborder.h
* @file
* @brief header for 6lowpan border router
* @author Martin Lenders <mlenders@inf.fu-berlin.de>
* @author Oliver Hahm <oliver.hahm@inria.fr>

2
sys/net/network_layer/sixlowpan/icmp.h
View File

@ -11,7 +11,7 @@
/**
* @ingroup net_sixlowpan
* @{
* @file sixlowpan/icmp.h
* @file
* @brief 6lowpan neighbor discovery constants, data structs, and prototypes
* @author Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
* @author Martin Lenders <mlenders@inf.fu-berlin.de>

2
sys/net/transport_layer/tcp/tcp_hc.h
View File

@ -8,7 +8,7 @@
/**
* @{
* @file tcp_hc.c
* @file
* @author Oliver Gesch <oliver.gesch@googlemail.com>
*/
#ifndef TCP_HC_H_

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

@ -7,7 +7,7 @@
*/
/**
* @defgroup oneway_malloc
* @defgroup oneway_malloc Oneway malloc implementation
* @ingroup sys
* @{
* @file malloc.h

6
sys/posix/pnet/include/arpa/inet.h
View File

@ -66,7 +66,7 @@ struct in_addr {
* The Open Group Base Specification Issue 7, htons
* </a>
*
* @param[in] hostlong A 16 bit number.
* @param[in] hostshort A 16 bit number.
* @return The argument value converted from host to network byte
* order.
*/
@ -79,7 +79,7 @@ struct in_addr {
* The Open Group Base Specification Issue 7, ntohl
* </a>
*
* @param[in] hostlong A 32-bit integer number.
* @param[in] netlong A 32-bit integer number.
* @return The argument value converted from network to host byte
* order.
*/
@ -92,7 +92,7 @@ struct in_addr {
* The Open Group Base Specification Issue 7, ntohs
* </a>
*
* @param[in] hostlong A 16-bit integer number.
* @param[in] netshort A 16-bit integer number.
* @return The argument value converted from network to host byte
* order.
*/

20
sys/posix/pnet/include/sys/socket.h
View File

@ -211,7 +211,7 @@ int accept(int socket, struct sockaddr *__restrict address,
/**
* @brief Bind a name to a socket.
* @detail The bind() function shall assign a local socket address *address*
* @details The bind() function shall assign a local socket address *address*
* to a socket identified by descriptor socket that has no local
* socket address assigned. Sockets created with the socket() function
* are initially unnamed; they are identified only by their address
@ -238,7 +238,7 @@ int bind(int socket, const struct sockaddr *address,
/**
* @brief Connect a socket.
* @detail The connect() function shall attempt to make a connection on a
* @details The connect() function shall attempt to make a connection on a
* connection-mode socket or to set or reset the peer address of a
* connectionless-mode socket.
*
@ -306,7 +306,7 @@ int listen(int socket, int backlog);
/**
* @brief Receive a message from a connected socket.
* @detail Shall receive a message from a connection-mode or
* @details Shall receive a message from a connection-mode or
* connectionless-mode socket. It is normally used with connected
* sockets because it does not permit the application to retrieve the
* source address of received data.
@ -331,7 +331,7 @@ ssize_t recv(int socket, void *buffer, size_t length, int flags);
/**
* @brief Receive a message from a socket.
* @detail The recvfrom() function shall receive a message from a
* @details The recvfrom() function shall receive a message from a
* connection-mode or connectionless-mode socket. It is normally used
* with connectionless-mode sockets because it permits the application
* to retrieve the source address of received data.
@ -369,7 +369,7 @@ ssize_t recvfrom(int socket, void *__restrict buffer, size_t length, int flags,
/**
* @brief Send a message on a socket.
* @detail Shall initiate transmission of a message from the specified socket
* @details Shall initiate transmission of a message from the specified socket
* to its peer. The send() function shall send a message only when the
* socket is connected. If the socket is a connectionless-mode socket,
* the message shall be sent to the pre-specified peer address.
@ -392,7 +392,7 @@ ssize_t send(int socket, const void *buffer, size_t length, int flags);
/**
* @brief Send a message on a socket.
* @detail Shall send a message through a connection-mode or
* @details Shall send a message through a connection-mode or
* connectionless-mode socket. If the socket is a connectionless-mode
* socket, the message shall be sent to the address specified by
* *dest_addr* if no pre-specified peer address has been set. If a
@ -406,7 +406,7 @@ ssize_t send(int socket, const void *buffer, size_t length, int flags);
* </a>
*
* @param[in] socket Specifies the socket file descriptor.
* @param[in] buffer Points to the buffer containing the message to send.
* @param[in] message Points to the buffer containing the message to send.
* @param[in] length Specifies the length of the message in bytes.
* @param[in] flags Specifies the type of message reception. Support
* for values other than 0 is not implemented yet.
@ -447,16 +447,16 @@ int setsockopt(int socket, int level, int option_name, const void *option_value,
/**
* @brief Create an endpoint for communication.
* @detail Shall create an unbound socket in a communications domain, and
* @details Shall create an unbound socket in a communications domain, and
* return a file descriptor that can be used in later function calls
* that operate on sockets.
*
* @param[in] domain Specifies the communications domain in which a socket
* is to be created. Valid values are prefixed with ``AF_`
* and defined in @ref transport_layer/socket.h.
* and defined in @ref socket.h.
* @param[in] type Specifies the type of socket to be created. Valued
* values are prefixed with ``SOCK_`` and defined in
* @ref transport_layer/socket.h.
* @ref socket.h.
* @param[in] protocol Specifies a particular protocol to be used with the
* socket. Specifying a protocol of 0 causes socket() to
* use an unspecified default protocol appropriate for

2
sys/posix/pthread/include/pthread_barrier.h
View File

@ -31,7 +31,7 @@ extern "C" {
*/
#define PTHREAD_PROCESS_SHARED (0)
/**
* @def PTHREAD_PROCESS_SHARED
* @def PTHREAD_PROCESS_PRIVATE
* @brief Don't share the structure with child processes.
* @note RIOT is a single-process OS.
* Setting the value of `pshared` does not change anything.

3
sys/posix/pthread/include/pthread_cancellation.h
View File

@ -28,6 +28,9 @@ extern "C" {
#define PTHREAD_CANCEL_DEFERRED 0
#define PTHREAD_CANCEL_ASYNCHRONOUS 1
/**
* @brief Thread exit status after a canceled thread has terminated.
*/
#define PTHREAD_CANCELED ((void *) -2)
/**