lpc2387/msba2/avsextrem: fix doxygen warnings

RIOT-OS · Aug 6, 2015 · c62d98e · c62d98e
1 parent d25972f
commit c62d98e
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 11 deletions.
diff --git a/boards/avsextrem/include/board.h b/boards/avsextrem/include/board.h
@@ -31,6 +31,10 @@
 extern "C" {
 #endif
 
+/**
+ * @brief Board LED defines
+ * @{
+ */
 #define LED_RED_PIN (BIT25)
 #define LED_GREEN_PIN (BIT26)
 
@@ -41,6 +45,7 @@ extern "C" {
 #define LED_RED_OFF (FIO3SET = LED_RED_PIN)
 #define LED_RED_ON (FIO3CLR = LED_RED_PIN)
 #define LED_RED_TOGGLE (FIO3PIN ^= LED_RED_PIN)
+/** @} */
 
 #ifdef MODULE_FAT
 #define CFG_CONF_MEM_SIZE             0x7FFFFFFF
@@ -58,10 +63,11 @@ extern "C" {
 #define STDIO_RX_BUFSIZE    (64U)
 /** @} */
 
+/**
+ * @brief Initialize the board's clock system
+ */
 void init_clks1(void);
 
-typedef uint8_t radio_packet_length_t;
-
 #ifdef __cplusplus
 }
 #endif

diff --git a/boards/msba2/include/board.h b/boards/msba2/include/board.h
@@ -28,6 +28,10 @@
 extern "C" {
 #endif
 
+/**
+ * @brief Board LED defines
+ * @{
+ */
 #define LED_RED_PIN (BIT25)
 #define LED_GREEN_PIN (BIT26)
 
@@ -38,6 +42,7 @@ extern "C" {
 #define LED_RED_OFF (FIO3SET = LED_RED_PIN)
 #define LED_RED_ON (FIO3CLR = LED_RED_PIN)
 #define LED_RED_TOGGLE (FIO3PIN ^= LED_RED_PIN)
+/** @} */
 
 /**
  * @name Define UART device and baudrate for stdio
@@ -48,10 +53,11 @@ extern "C" {
 #define STDIO_RX_BUFSIZE    (64U)
 /** @} */
 
+/**
+ * @brief initialize the board's clock system
+ */
 void init_clks1(void);
 
-typedef uint8_t radio_packet_length_t;
-
 #ifdef __cplusplus
 }
 #endif

diff --git a/cpu/lpc2387/include/cpu.h b/cpu/lpc2387/include/cpu.h
@@ -26,7 +26,15 @@ extern "C" {
 
 extern uintptr_t __stack_start;     ///< end of user stack memory space
 
+/**
+ * @brief Scale lpc2387 cpu speed
+ */
 void lpc2387_pclk_scale(uint32_t source, uint32_t target, uint32_t *pclksel, uint32_t *prescale);
+
+
+/**
+ * @brief install lpc2387 irq
+ */
 bool install_irq(int IntNumber, void (*HandlerAddr)(void), int Priority);
 
 #ifdef MODULE_PERIPH

diff --git a/cpu/lpc2387/include/periph_cpu.h b/cpu/lpc2387/include/periph_cpu.h
@@ -1,18 +1,53 @@
+/*
+ * Copyright (C) 2015 Kaspar Schleiser <[email protected]>
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+ */
+
+/**
+ * @ingroup         cpu_lpc2387
+ * @{
+ *
+ * @file
+ * @brief           CPU specific definitions for internal peripheral handling
+ *
+ * @author          Kaspar Schleiser <[email protected]>
+ */
+
+#ifndef PERIPH_CPU_H_
+#define PERIPH_CPU_H_
+
+#include "cpu.h"
+#include "periph/dev_enums.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 #ifndef PERIPH_CPU_H
 #define PERIPH_CPU_H
 
 #include <stdint.h>
 #include "cpu.h"
 
+/**
+ * @brief   LPC2387 MCU defines
+ * @{
+ */
 #define __IO volatile
 
+/**
+ * @brief Fast GPIO register definition struct
+ */
 typedef struct {
-    __IO uint32_t DIR;
-    uint32_t _reserved[3];
-    __IO uint32_t MASK;
-    __IO uint32_t PIN;
-    __IO uint32_t SET;
-    __IO uint32_t CLR;
+    __IO uint32_t DIR;      /**< he */
+    uint32_t _reserved[3];  /**< really */
+    __IO uint32_t MASK;     /**< wants */
+    __IO uint32_t PIN;      /**< to */
+    __IO uint32_t SET;      /**< know */
+    __IO uint32_t CLR;      /**< everything */
 } FIO_PORT_t;
 
 #define FIO_PORTS   ((FIO_PORT_t*)FIO_BASE_ADDR)
@@ -38,4 +73,13 @@ typedef enum {
     GPIO_BOTH = 3           /**< emit interrupt on both flanks */
 } gpio_flank_t;
 
-#endif /* PERIPH_CPU_H */
+/**
+ * @}
+ */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* PERIPH_CPU_H_ */
+/** @} */