[rtems commit] lm32: Enhance Doxygen #2

Gedare Bloom gedare at rtems.org
Mon Dec 23 17:28:22 UTC 2013


Module:    rtems
Branch:    master
Commit:    9dc999af0107998037d55ddfc2d83b6b53383e64
Changeset: http://git.rtems.org/rtems/commit/?id=9dc999af0107998037d55ddfc2d83b6b53383e64

Author:    Chirayu Desai <cdesai at cyanogenmod.org>
Date:      Mon Dec 23 22:54:34 2013 +0530

lm32: Enhance Doxygen #2

---

 c/src/lib/libbsp/lm32/shared/console/uart.h        |   15 +++++++++++++++
 .../libbsp/lm32/shared/milkymist_console/uart.h    |   11 +----------
 .../lm32/shared/milkymist_flash/milkymist_flash.h  |   13 +++++++++++++
 3 files changed, 29 insertions(+), 10 deletions(-)

diff --git a/c/src/lib/libbsp/lm32/shared/console/uart.h b/c/src/lib/libbsp/lm32/shared/console/uart.h
index 002ce14..075382d 100644
--- a/c/src/lib/libbsp/lm32/shared/console/uart.h
+++ b/c/src/lib/libbsp/lm32/shared/console/uart.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_shared lm32_uart
+ * @brief LatticeMico32 UART definitions
+ */
+
 /*
  *  This file contains definitions for LatticeMico32 UART
  *
@@ -12,6 +18,13 @@
  *  Micro-Research Finland Oy
  */
 
+/**
+ * @defgroup lm32_uart LM32 UART
+ * @ingroup lm32_shared
+ * @brief LatticeMico32 UART definitions
+ * @{
+ */
+
 #ifndef _BSPUART_H
 #define _BSPUART_H
 
@@ -85,3 +98,5 @@ void BSP_uart_init(int baud);
 #define LM32_UART_DIV      (0x001C)
 
 #endif /* _BSPUART_H */
+
+/** @} */
diff --git a/c/src/lib/libbsp/lm32/shared/milkymist_console/uart.h b/c/src/lib/libbsp/lm32/shared/milkymist_console/uart.h
index 45979f3..2a0b92a 100644
--- a/c/src/lib/libbsp/lm32/shared/milkymist_console/uart.h
+++ b/c/src/lib/libbsp/lm32/shared/milkymist_console/uart.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * @ingroup lm32_milkymist_uart lm32_milkymist_shared
+ * @ingroup lm32_uart lm32_milkymist_shared
  * @brief Milkymist UART definitions
  */
 
@@ -12,13 +12,6 @@
  *  http://www.rtems.com/license/LICENSE.
  */
 
-/**
- * @defgroup lm32_milkymist_uart Milkymist UART
- * @ingroup lm32_milkymist_shared
- * @brief Milkymist UART definitions
- * @{
- */
-
 #ifndef _BSPUART_H
 #define _BSPUART_H
 
@@ -27,5 +20,3 @@ void BSP_uart_polled_write(char ch);
 int BSP_uart_polled_read(void);
 
 #endif /* _BSPUART_H */
-
-/** @} */
diff --git a/c/src/lib/libbsp/lm32/shared/milkymist_flash/milkymist_flash.h b/c/src/lib/libbsp/lm32/shared/milkymist_flash/milkymist_flash.h
index dacaf10..065e55d 100644
--- a/c/src/lib/libbsp/lm32/shared/milkymist_flash/milkymist_flash.h
+++ b/c/src/lib/libbsp/lm32/shared/milkymist_flash/milkymist_flash.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup lm32_milkymist_flash lm32_milkymist_shared
+ * @brief Milkymist Flash
+ */
+
 /*  milkymist_flash.h
  *  
  *  Copyright (C) 2010 Sebastien Bourdeauducq
@@ -8,6 +14,13 @@
  *
  */
 
+/**
+ * @defgroup lm32_milkymist_flash Milkymist Flash
+ * @ingroup lm32_milkymist_shared
+ * @brief Milkymist Flash
+ * @{
+ */
+
 #ifndef __MILKYMIST_FLASH_H_
 #define __MILKYMIST_FLASH_H_
 




More information about the vc mailing list