the patch in the attachment gives doxygen header to files in the csb337/include diectory please check the changes made and if everything looks right , approve it.
--Shashvat
From 2e97a591f851c279774ff981312e4d87ac482992 Mon Sep 17 00:00:00 2001 From: shashvatjain <[email protected]> Date: Fri, 9 Nov 2018 23:46:27 +0530 Subject: [PATCH] arm/csb337: Update Doxygen (GCI 2018) --- bsps/arm/csb337/include/at91rm9200.h | 16 ++++++++++++++++ bsps/arm/csb337/include/at91rm9200_dbgu.h | 8 ++++++++ bsps/arm/csb337/include/at91rm9200_emac.h | 8 ++++++++ bsps/arm/csb337/include/at91rm9200_gpio.h | 8 ++++++++ bsps/arm/csb337/include/at91rm9200_mem.h | 8 ++++++++ bsps/arm/csb337/include/at91rm9200_pmc.h | 8 ++++++++ bsps/arm/csb337/include/at91rm9200_usart.h | 8 ++++++++ bsps/arm/csb337/include/bits.h | 17 +++++++++++++++++ bsps/arm/csb337/include/bsp/irq.h | 16 ++++++++++++++++ bsps/arm/csb337/include/tm27.h | 9 +++++++++ 10 files changed, 106 insertions(+) diff --git a/bsps/arm/csb337/include/at91rm9200.h b/bsps/arm/csb337/include/at91rm9200.h index 3ed64c7073..706b3cc03d 100644 --- a/bsps/arm/csb337/include/at91rm9200.h +++ b/bsps/arm/csb337/include/at91rm9200.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup csb337_at91rm9200 + * + * @brief Atmel AT91RM9200 Register Definitions + */ + /* * Atmel AT91RM9200 Register definitions, used in KIT637_V6 (CSB637) * @@ -342,3 +350,11 @@ typedef volatile unsigned long vulong; #endif /* __AT91RM9200_H__ */ +/** + * @defgroup csb337_at91rm9200 AT91RM9200 + * + * @ingroup arm_csb337 + * + * @brief Atmel Register Definitions, Used In KIT637_V6 (CSB637) + */ + diff --git a/bsps/arm/csb337/include/at91rm9200_dbgu.h b/bsps/arm/csb337/include/at91rm9200_dbgu.h index 250e0137d8..f37429cddc 100644 --- a/bsps/arm/csb337/include/at91rm9200_dbgu.h +++ b/bsps/arm/csb337/include/at91rm9200_dbgu.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup csb337_at91rm9200 + * + * @brief Atmel AT91RM9200_DBGU Register definitions + */ + /* * Atmel AT91RM9200_DBGU Register definitions * diff --git a/bsps/arm/csb337/include/at91rm9200_emac.h b/bsps/arm/csb337/include/at91rm9200_emac.h index 77c42d1526..824ba1c3aa 100644 --- a/bsps/arm/csb337/include/at91rm9200_emac.h +++ b/bsps/arm/csb337/include/at91rm9200_emac.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup csb337_at91rm9200 + * + * @brief Atmel AT91RM9200 EMAC Register definitions + */ + /* * Atmel AT91RM9200 EMAC Register definitions * diff --git a/bsps/arm/csb337/include/at91rm9200_gpio.h b/bsps/arm/csb337/include/at91rm9200_gpio.h index 9fa18ad476..4c2fcabc10 100644 --- a/bsps/arm/csb337/include/at91rm9200_gpio.h +++ b/bsps/arm/csb337/include/at91rm9200_gpio.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup csb337_at91rm9200 + * + * @brief AT91RM9200 GPIO definitions + */ + /* * AT91RM9200 GPIO definitions * diff --git a/bsps/arm/csb337/include/at91rm9200_mem.h b/bsps/arm/csb337/include/at91rm9200_mem.h index fafb18f6e8..aca99ea0a4 100644 --- a/bsps/arm/csb337/include/at91rm9200_mem.h +++ b/bsps/arm/csb337/include/at91rm9200_mem.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup csb337_at91rm9200 + * + * @brief AT91RM9200 Memory Controller definitions + */ + /* * AT91RM9200 Memory Controller definitions * diff --git a/bsps/arm/csb337/include/at91rm9200_pmc.h b/bsps/arm/csb337/include/at91rm9200_pmc.h index 70cf77fc5a..59860e4db0 100644 --- a/bsps/arm/csb337/include/at91rm9200_pmc.h +++ b/bsps/arm/csb337/include/at91rm9200_pmc.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup csb337_at91rm9200 + * + * @brief AT91RM9200 Power Management and Clock definitions + */ + /* * AT91RM9200 Power Management and Clock definitions * diff --git a/bsps/arm/csb337/include/at91rm9200_usart.h b/bsps/arm/csb337/include/at91rm9200_usart.h index 387f353992..c1f25bdd43 100644 --- a/bsps/arm/csb337/include/at91rm9200_usart.h +++ b/bsps/arm/csb337/include/at91rm9200_usart.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup csb337_at91rm9200 + * + * @brief Atmel AT91RM9200_USART Register definitions + */ + /* * Atmel AT91RM9200_USART Register definitions, used in KIT637_V6 (CSB637) * diff --git a/bsps/arm/csb337/include/bits.h b/bsps/arm/csb337/include/bits.h index 6f2c4036b6..09a5cd50b7 100644 --- a/bsps/arm/csb337/include/bits.h +++ b/bsps/arm/csb337/include/bits.h @@ -1,3 +1,12 @@ +/** + *@file + * + *@ingroup csb337_bits + * + *@brief Contains Defined Bits. + * + */ + /* * Bit position definitions * @@ -46,3 +55,11 @@ #endif /* __BITS_H__ */ +/** + *@defgroup csb337_bits Bits + * + *@ingroup arm_csb337 + * + *@brief + * + */ diff --git a/bsps/arm/csb337/include/bsp/irq.h b/bsps/arm/csb337/include/bsp/irq.h index 771059a3e4..ce683bc4ff 100644 --- a/bsps/arm/csb337/include/bsp/irq.h +++ b/bsps/arm/csb337/include/bsp/irq.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup csb337_interrupt + * + * @brief Interrupt Support. + */ + /* * Interrupt handler Header file * @@ -21,6 +29,14 @@ #endif /* __asm__ */ +/** + * @defgroup csb337_interrupt Interrrupt Support + * + * @ingroup arm_csb337 + * + * @brief Interrupt Support. + */ + /* possible interrupt sources on the AT91RM9200 */ #define AT91RM9200_INT_FIQ 0 #define AT91RM9200_INT_SYSIRQ 1 diff --git a/bsps/arm/csb337/include/tm27.h b/bsps/arm/csb337/include/tm27.h index 0dfa7bf628..80b371d20b 100644 --- a/bsps/arm/csb337/include/tm27.h +++ b/bsps/arm/csb337/include/tm27.h @@ -1 +1,10 @@ +/** + *@file + * + *@ingroup arm_csb337 + * + *@brief Implementations of interrupt mechanisms for Time Test 27. + * + */ + #include <rtems/tm27-default.h> -- 2.17.1
_______________________________________________ devel mailing list [email protected] http://lists.rtems.org/mailman/listinfo/devel
