[rtems commit] doc: Epiphany BSP SIM headers

[Gedare Bloom]

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

Author:    jfjhh <alex.striff1 at gmail.com>
Date:      Thu Dec 17 22:54:39 2015 -0800

doc: Epiphany BSP SIM headers

---

 .../lib/libbsp/epiphany/epiphany_sim/include/bsp.h | 18 ++++-
 .../libbsp/epiphany/epiphany_sim/include/bspopts.h | 79 ++++++++++++++++++----
 .../libbsp/epiphany/epiphany_sim/include/tm27.h    | 15 +++-
 3 files changed, 91 insertions(+), 21 deletions(-)

diff --git a/c/src/lib/libbsp/epiphany/epiphany_sim/include/bsp.h b/c/src/lib/libbsp/epiphany/epiphany_sim/include/bsp.h
index 1eb91ce..e9c5b55 100644
--- a/c/src/lib/libbsp/epiphany/epiphany_sim/include/bsp.h
+++ b/c/src/lib/libbsp/epiphany/epiphany_sim/include/bsp.h
@@ -1,5 +1,12 @@
-/*
+/**
+ * @defgroup bsp_epiphany Epiphany
+ *
+ * @ingroup bsp_epiphany
  *
+ * @brief Epiphany Support Package
+ */
+
+/*
  * Copyright (c) 2015 University of York.
  * Hesham ALMatary <hmka501 at york.ac.uk>
  *
@@ -44,12 +51,17 @@
 extern "C" {
 #endif
 
-/* Constants */
+/**
+ * @name Constants
+ *
+ * @{
+ */
 Thread clock_driver_sim_idle_body(uintptr_t);
 #define BSP_IDLE_TASK_BODY clock_driver_sim_idle_body
+/** @} */
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif /* LIBBSP_EPIPHANY_PARALLELLA_H */
+#endif /* LIBBSP_EPIPHANY_EPIPHANY_SIM_H */
diff --git a/c/src/lib/libbsp/epiphany/epiphany_sim/include/bspopts.h b/c/src/lib/libbsp/epiphany/epiphany_sim/include/bspopts.h
index 47c2f0d..c5d9a60 100644
--- a/c/src/lib/libbsp/epiphany/epiphany_sim/include/bspopts.h
+++ b/c/src/lib/libbsp/epiphany/epiphany_sim/include/bspopts.h
@@ -1,3 +1,9 @@
+/**
+ * @ingroup bsp_epiphany
+ *
+ * @brief Epiphany BSP Options
+ */
+
 /*
  *
  * Copyright (c) 2015 University of York.
@@ -30,39 +36,82 @@
 
 /* include/bspopts.h.in.  Generated from configure.ac by autoheader.  */
 
-/* If defined, then the BSP Framework will put a non-zero pattern into the
-   RTEMS Workspace and C program heap. This should assist in finding code that
-   assumes memory starts set to zero. */
+#ifndef LIBBSP_EPIPHANY_EPIPHANY_SIM_OPTS_H
+#define LIBBSP_EPIPHANY_EPIPHANY_SIM_OPTS_H
+
+/**
+ * @name Options
+ *
+ * @{
+ */
+
+/**
+ * @brief Dirties memory to test for programs that assume zeroed memory.
+ *
+ * If defined, then the BSP Framework will put a non-zero pattern into the
+ * RTEMS Workspace and C program heap. This should assist in finding code that
+ * assumes memory starts set to zero.
+ */
 #undef BSP_DIRTY_MEMORY
 
-/* If defined, print a message and wait until pressed before resetting board
-   when application exits. */
+/**
+ * @brief Print and wait for key press for reset.
+ *
+ * If defined, print a message and wait until pressed before resetting board
+ * when application exits.
+ */
 #undef BSP_PRESS_KEY_FOR_RESET
 
-/* If defined, prints the exception context when an unexpected exception
-   occurs. */
+/**
+ * @brief Prints exception context upon unexpected exceptions
+ *
+ * If defined, prints the exception context when an unexpected exception occurs.
+ */
 #undef BSP_PRINT_EXCEPTION_CONTEXT
 
-/* If defined, reset the board when the application exits. */
+/**
+ * @brief Resets on application exit.
+ *
+ * If defined, reset the board when the application exits.
+ */
 #undef BSP_RESET_BOARD_AT_EXIT
 
-/* reset vector address for BSP start */
+/**
+ * @brief Reset vector address for BSP start
+ */
 #undef BSP_START_RESET_VECTOR
 
-/* Define to the address where bug reports for this package should be sent. */
+/**
+ * @brief Define to the address where bug reports for this package should be
+ * sent.
+ */
 #undef PACKAGE_BUGREPORT
 
-/* Define to the full name of this package. */
+/**
+ * @brief Define to the full name of this package.
+ */
 #undef PACKAGE_NAME
 
-/* Define to the full name and version of this package. */
+/**
+ * @brief Define to the full name and version of this package.
+ */
 #undef PACKAGE_STRING
 
-/* Define to the one symbol short name of this package. */
+/**
+ * @brief Define to the one symbol short name of this package.
+ */
 #undef PACKAGE_TARNAME
 
-/* Define to the home page for this package. */
+/**
+ * @brief Define to the home page for this package.
+ */
 #undef PACKAGE_URL
 
-/* Define to the version of this package. */
+/**
+ * @brief Define to the version of this package.
+ */
 #undef PACKAGE_VERSION
+
+/** @} */
+
+#endif /* LIBBSP_EPIPHANY_EPIPHANY_SIM_OPTS_H */
diff --git a/c/src/lib/libbsp/epiphany/epiphany_sim/include/tm27.h b/c/src/lib/libbsp/epiphany/epiphany_sim/include/tm27.h
index 10dac82..6e3d305 100644
--- a/c/src/lib/libbsp/epiphany/epiphany_sim/include/tm27.h
+++ b/c/src/lib/libbsp/epiphany/epiphany_sim/include/tm27.h
@@ -1,3 +1,9 @@
+/**
+ * @ingroup bsp_epiphany
+ *
+ * @brief Epiphany Time Test 27 Routines
+ */
+
 /*
  *
  * Copyright (c) 2015 University of York.
@@ -32,11 +38,12 @@
 #error "This is an RTEMS internal file you must not include directly."
 #endif
 
-#ifndef __tm27_h
-#define __tm27_h
+#ifndef LIBBSP_EPIPHANY_EPIPHANY_SIM_TM27_H
+#define LIBBSP_EPIPHANY_EPIPHANY_SIM_TM27_H
 
 /**
  * @name Interrupt mechanisms for Time Test 27
+ *
  * @{
  */
 
@@ -50,4 +57,6 @@
 
 #define Lower_tm27_intr() /* empty */
 
-#endif
+/** @} */
+
+#endif /* LIBBSP_EPIPHANY_EPIPHANY_SIM_TM27_H */