From df217b0bcc16c523eef105ffb6fe75f79fbc214e Mon Sep 17 00:00:00 2001 From: Toma Radu Date: Wed, 4 Dec 2013 12:07:04 -0600 Subject: [PATCH] leon3: improve doxygen Add doxygen to the bsp.h, tm27.h, amba.h and leon.h files --- c/src/lib/libbsp/sparc/leon3/include/amba.h | 7 +++++++ c/src/lib/libbsp/sparc/leon3/include/bsp.h | 5 ++++- c/src/lib/libbsp/sparc/leon3/include/leon.h | 6 ++++++ c/src/lib/libbsp/sparc/leon3/include/tm27.h | 6 ++++++ 4 files changed, 23 insertions(+), 1 deletion(-) diff --git a/c/src/lib/libbsp/sparc/leon3/include/amba.h b/c/src/lib/libbsp/sparc/leon3/include/amba.h index cb45e58b61..3c726b20e2 100644 --- a/c/src/lib/libbsp/sparc/leon3/include/amba.h +++ b/c/src/lib/libbsp/sparc/leon3/include/amba.h @@ -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 * diff --git a/c/src/lib/libbsp/sparc/leon3/include/bsp.h b/c/src/lib/libbsp/sparc/leon3/include/bsp.h index 4f4c22b88d..9aeafa301d 100644 --- a/c/src/lib/libbsp/sparc/leon3/include/bsp.h +++ b/c/src/lib/libbsp/sparc/leon3/include/bsp.h @@ -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 diff --git a/c/src/lib/libbsp/sparc/leon3/include/leon.h b/c/src/lib/libbsp/sparc/leon3/include/leon.h index 42c47d69b6..21a46a8c8d 100644 --- a/c/src/lib/libbsp/sparc/leon3/include/leon.h +++ b/c/src/lib/libbsp/sparc/leon3/include/leon.h @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon3 + * @brief LEON3 BSP data types and macros + */ + /* leon.h * * LEON3 BSP data types and macros. diff --git a/c/src/lib/libbsp/sparc/leon3/include/tm27.h b/c/src/lib/libbsp/sparc/leon3/include/tm27.h index 8e8e43c19b..a994f831fd 100644 --- a/c/src/lib/libbsp/sparc/leon3/include/tm27.h +++ b/c/src/lib/libbsp/sparc/leon3/include/tm27.h @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup sparc_leon3 + * @brief Implementations for interrupt mechanisms for Time Test 27 + */ + /* * tm27.h *