summaryrefslogtreecommitdiffstats
path: root/cpukit/score/cpu/sh
diff options
context:
space:
mode:
authorMathew Kallada <matkallada@gmail.com>2012-12-02 15:23:57 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2012-12-02 15:23:57 -0600
commit43e05991513c9d3d494b88920c0fbf3ef5b547bb (patch)
tree661a18ab99e775a084b2ba71485fda3b798403c0 /cpukit/score/cpu/sh
parentscore misc: Clean up Doxygen #12 (GCI 2012) (diff)
downloadrtems-43e05991513c9d3d494b88920c0fbf3ef5b547bb.tar.bz2
score misc: Clean up Doxygen #13 (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen comments in the RTEMS source. http://www.google-melange.com/gci/task/view/google/gci2012/8013205
Diffstat (limited to 'cpukit/score/cpu/sh')
-rw-r--r--cpukit/score/cpu/sh/context.c6
-rw-r--r--cpukit/score/cpu/sh/cpu.c12
-rw-r--r--cpukit/score/cpu/sh/rtems/score/cpu.h11
3 files changed, 21 insertions, 8 deletions
diff --git a/cpukit/score/cpu/sh/context.c b/cpukit/score/cpu/sh/context.c
index 597c868d00..e470e7a4ef 100644
--- a/cpukit/score/cpu/sh/context.c
+++ b/cpukit/score/cpu/sh/context.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief SuperH CPU Context
+ */
+
/*
* Authors: Ralf Corsepius (corsepiu@faw.uni-ulm.de) and
* Bernd Becker (becker@faw.uni-ulm.de)
diff --git a/cpukit/score/cpu/sh/cpu.c b/cpukit/score/cpu/sh/cpu.c
index d4f1644dd2..57d6ffc6db 100644
--- a/cpukit/score/cpu/sh/cpu.c
+++ b/cpukit/score/cpu/sh/cpu.c
@@ -1,7 +1,13 @@
-/*
- * This file contains information pertaining to the Hitachi SH
- * processor.
+/**
+ * @file
+ *
+ * @brief SuperH CPU Support
*
+ * This file contains information pertaining to the Hitachi SH
+ * processor.
+ */
+
+/*
* Authors: Ralf Corsepius (corsepiu@faw.uni-ulm.de) and
* Bernd Becker (becker@faw.uni-ulm.de)
*
diff --git a/cpukit/score/cpu/sh/rtems/score/cpu.h b/cpukit/score/cpu/sh/rtems/score/cpu.h
index 9a61b5e940..f5ad90c766 100644
--- a/cpukit/score/cpu/sh/rtems/score/cpu.h
+++ b/cpukit/score/cpu/sh/rtems/score/cpu.h
@@ -789,11 +789,12 @@ extern uint8_t _bit_set_table[];
/* functions */
/*
+ * @brief CPU Initialize
+ *
* _CPU_Initialize
*
* This routine performs CPU dependent initialization.
*/
-
void _CPU_Initialize(void);
/*
@@ -866,21 +867,21 @@ void _CPU_Context_restore(
) RTEMS_COMPILER_NO_RETURN_ATTRIBUTE;
/*
+ * @brief This routine saves the floating point context passed to it.
+ *
* _CPU_Context_save_fp
*
- * This routine saves the floating point context passed to it.
*/
-
void _CPU_Context_save_fp(
Context_Control_fp **fp_context_ptr
);
/*
+ * @brief This routine restores the floating point context passed to it.
+ *
* _CPU_Context_restore_fp
*
- * This routine restores the floating point context passed to it.
*/
-
void _CPU_Context_restore_fp(
Context_Control_fp **fp_context_ptr
);