doc: fix remaining doxygen warnings

dev/timer
Oleg Hahm 8 years ago
parent 0ccf1043de
commit 43c86b5a3e

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

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

@ -73,7 +73,7 @@ static inline void __attribute__((always_inline, noreturn)) x86_hlt(void)
* 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 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.

@ -94,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 #X86_INT_PF!
* i.e. this is not the PC of the \#PF!
*/
static inline uint32_t X86_CR_ATTR cr2_read(void)
{

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

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

@ -186,11 +186,10 @@ void lm75A_reset(void);
* This function prints the values of all registers over
* the rs232 interface.
*
* @param[in] extern_interrupt_task 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));

@ -23,8 +23,6 @@
#include "netdev/base.h"
/**
* @def NETDEV_DEFAULT
*
* @brief Default device as a pointer of netdev_t.
*/
#ifdef MODULE_AT86RF231

@ -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,7 +99,6 @@ typedef struct CipherModeContext {
/**
* @brief struct for an archive of all available ciphers
* @typedef BlockCipher_Archive_t
*/
typedef struct {
// the number of available ciphers

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

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

Loading…
Cancel
Save