leon3: improve doxygen

Add doxygen to the bsp.h, tm27.h, amba.h and leon.h files
2026-08-30 06:17:12 +08:00 · 2013-12-04 15:29:47 -05:00
parent b5d2d4a61c
commit df217b0bcc
4 changed files with 23 additions and 1 deletions
@@ -1,3 +1,10 @@
+/**
+ * @file
+ * @defgroup amba AMBA Driver Handler
+ * @ingroup sparc_leon3
+ * @brief AMBA Plag & Play Bus Driver Macros
+ */
+
 /*
 *  AMBA Plag & Play Bus Driver Macros
 *
@@ -1,5 +1,8 @@
 /**
- * @defgroup sparc_leon3 Sparc Leon3 Handler
+ * @file
+ * @defgroup sparc_leon3 Sparc LEON3 Handler
+ * @ingroup bsp_kit
+ * @brief Handles Sparc LEON3 simulator
 */

 /*  bsp.h
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup sparc_leon3
+ * @brief LEON3 BSP data types and macros
+ */
+
 /*  leon.h
 *
 *  LEON3 BSP data types and macros.
@@ -1,3 +1,9 @@
+/**
+ * @file
+ * @ingroup sparc_leon3
+ * @brief Implementations for interrupt mechanisms for Time Test 27
+ */
+
 /*
 *  tm27.h
 *