From 0e8cfdef5df6f5804c1e310f0a975ea7af62c2dd Mon Sep 17 00:00:00 2001 From: Chirayu Desai Date: Sat, 7 Dec 2013 19:34:07 +0530 Subject: [PATCH] arm: gdbarmsim: Add doxygen --- c/src/lib/libbsp/arm/gdbarmsim/include/bsp.h | 24 +++++++++++++++++++- c/src/lib/libbsp/arm/gdbarmsim/include/swi.h | 8 +++++++ 2 files changed, 31 insertions(+), 1 deletion(-) diff --git a/c/src/lib/libbsp/arm/gdbarmsim/include/bsp.h b/c/src/lib/libbsp/arm/gdbarmsim/include/bsp.h index 2a7917c4a1..f9975f992b 100644 --- a/c/src/lib/libbsp/arm/gdbarmsim/include/bsp.h +++ b/c/src/lib/libbsp/arm/gdbarmsim/include/bsp.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_gdbarmsim + * + * @brief Global BSP definitions. + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). @@ -22,10 +30,24 @@ extern "C" { #include #include -/* support for simulated clock tick */ +/** + * @defgroup arm_gdbarmsim GDBARMSIM Support + * + * @ingroup bsp_arm + * + * @brief GDBARMSIM support package. + * + * @{ + */ + +/** + * @brief Support for simulated clock tick + */ Thread clock_driver_sim_idle_body(uintptr_t); #define BSP_IDLE_TASK_BODY clock_driver_sim_idle_body +/** @} */ + #ifdef __cplusplus } #endif diff --git a/c/src/lib/libbsp/arm/gdbarmsim/include/swi.h b/c/src/lib/libbsp/arm/gdbarmsim/include/swi.h index af46adaf54..305123263b 100644 --- a/c/src/lib/libbsp/arm/gdbarmsim/include/swi.h +++ b/c/src/lib/libbsp/arm/gdbarmsim/include/swi.h @@ -1,3 +1,11 @@ +/** + * @file + * + * @ingroup arm_gdbarmsim + * + * @brief Software interrupt definitions. + */ + /* * Copied from libgloss 1 Oct 2009. * Minor modifications to work with RTEMS.