doc: fixed broken doxygen references

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

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

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

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

@ -37,8 +37,11 @@ extern "C" {
/* see "Intel® Quark SoC X1000 Core Developers 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 #X86_INT_PF!
*/
static inline uint32_t X86_CR_ATTR cr2_read(void)
{

@ -319,7 +319,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);

@ -125,7 +125,8 @@ int aes_encrypt(cipher_context_t *context, uint8_t *plain_block,
* @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);

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

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

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

@ -453,10 +453,10 @@ int setsockopt(int socket, int level, int option_name, const void *option_value,
*
* @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

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

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

Loading…
Cancel
Save