[rtems commit] score misc: Clean up Doxygen GCI Task #12
Gedare Bloom
gedare at rtems.org
Fri Dec 7 14:52:56 UTC 2012
Module: rtems
Branch: master
Commit: b7185613e8a572fd35b0bed21a8e0f1fdecfc668
Changeset: http://git.rtems.org/rtems/commit/?id=b7185613e8a572fd35b0bed21a8e0f1fdecfc668
Author: Alex Ivanov <alexivanov97 at gmail.com>
Date: Fri Dec 7 09:57:04 2012 -0500
score misc: Clean up Doxygen GCI Task #12
http://www.google-melange.com/gci/task/view/google/gci2012/7983217
---
cpukit/score/cpu/arm/armv7m-context-initialize.c | 6 +++
cpukit/score/cpu/arm/armv7m-context-restore.c | 6 +++
.../score/cpu/arm/armv7m-exception-handler-get.c | 6 +++
.../score/cpu/arm/armv7m-exception-handler-set.c | 6 +++
.../score/cpu/arm/armv7m-exception-priority-get.c | 5 ++
.../score/cpu/arm/armv7m-exception-priority-set.c | 6 +++
cpukit/score/cpu/arm/armv7m-isr-enter-leave.c | 6 +++
cpukit/score/cpu/arm/armv7m-isr-level-get.c | 6 +++
cpukit/score/cpu/arm/armv7m-isr-level-set.c | 6 +++
cpukit/score/cpu/arm/armv7m-isr-vector-install.c | 6 +++
cpukit/score/cpu/arm/armv7m-thread-idle.c | 6 +++
cpukit/score/cpu/avr/cpu.c | 46 +++-----------------
cpukit/score/cpu/i386/cpu.c | 19 +++-----
cpukit/score/cpu/i386/sse_test.c | 6 +++
cpukit/score/cpu/m32c/context_init.c | 7 +++
cpukit/score/cpu/m68k/cpu.c | 35 +++------------
cpukit/score/cpu/no_cpu/cpu.c | 47 +++-----------------
cpukit/score/cpu/no_cpu/cpu_asm.c | 6 +++
cpukit/score/cpu/powerpc/cpu.c | 6 +++
cpukit/score/cpu/powerpc/ppc-isr-vector-install.c | 6 +++
20 files changed, 120 insertions(+), 123 deletions(-)
diff --git a/cpukit/score/cpu/arm/armv7m-context-initialize.c b/cpukit/score/cpu/arm/armv7m-context-initialize.c
index 451c6b5..640adae 100644
--- a/cpukit/score/cpu/arm/armv7m-context-initialize.c
+++ b/cpukit/score/cpu/arm/armv7m-context-initialize.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief CPU Initialize Context
+ */
+
/*
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
*
diff --git a/cpukit/score/cpu/arm/armv7m-context-restore.c b/cpukit/score/cpu/arm/armv7m-context-restore.c
index effa3e7..4779049 100644
--- a/cpukit/score/cpu/arm/armv7m-context-restore.c
+++ b/cpukit/score/cpu/arm/armv7m-context-restore.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief CPU Restore Context
+ */
+
/*
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
*
diff --git a/cpukit/score/cpu/arm/armv7m-exception-handler-get.c b/cpukit/score/cpu/arm/armv7m-exception-handler-get.c
index f6aa663..cf25caf 100644
--- a/cpukit/score/cpu/arm/armv7m-exception-handler-get.c
+++ b/cpukit/score/cpu/arm/armv7m-exception-handler-get.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief ARMV7M Get Exception Handler
+ */
+
/*
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
*
diff --git a/cpukit/score/cpu/arm/armv7m-exception-handler-set.c b/cpukit/score/cpu/arm/armv7m-exception-handler-set.c
index 1f2564f..ea3fce3 100644
--- a/cpukit/score/cpu/arm/armv7m-exception-handler-set.c
+++ b/cpukit/score/cpu/arm/armv7m-exception-handler-set.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief ARMV7M Set Exception Handler
+ */
+
/*
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
*
diff --git a/cpukit/score/cpu/arm/armv7m-exception-priority-get.c b/cpukit/score/cpu/arm/armv7m-exception-priority-get.c
index 446b5c1..79224e1 100644
--- a/cpukit/score/cpu/arm/armv7m-exception-priority-get.c
+++ b/cpukit/score/cpu/arm/armv7m-exception-priority-get.c
@@ -1,3 +1,8 @@
+/**
+ * @file
+ *
+ * @brief ARMV7M Get Exception Priority
+ */
/*
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
*
diff --git a/cpukit/score/cpu/arm/armv7m-exception-priority-set.c b/cpukit/score/cpu/arm/armv7m-exception-priority-set.c
index f9d2098..085ce2d 100644
--- a/cpukit/score/cpu/arm/armv7m-exception-priority-set.c
+++ b/cpukit/score/cpu/arm/armv7m-exception-priority-set.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief ARMV7M Set Exception Priority
+ */
+
/*
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
*
diff --git a/cpukit/score/cpu/arm/armv7m-isr-enter-leave.c b/cpukit/score/cpu/arm/armv7m-isr-enter-leave.c
index cd5844b..1bce10a 100644
--- a/cpukit/score/cpu/arm/armv7m-isr-enter-leave.c
+++ b/cpukit/score/cpu/arm/armv7m-isr-enter-leave.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief ARMV7M Interrupt Service Enter and Leave
+ */
+
/*
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
*
diff --git a/cpukit/score/cpu/arm/armv7m-isr-level-get.c b/cpukit/score/cpu/arm/armv7m-isr-level-get.c
index 79a03ee..887e308 100644
--- a/cpukit/score/cpu/arm/armv7m-isr-level-get.c
+++ b/cpukit/score/cpu/arm/armv7m-isr-level-get.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief CPU Get ISR Level
+ */
+
/*
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
*
diff --git a/cpukit/score/cpu/arm/armv7m-isr-level-set.c b/cpukit/score/cpu/arm/armv7m-isr-level-set.c
index 981ac06..2f4c363 100644
--- a/cpukit/score/cpu/arm/armv7m-isr-level-set.c
+++ b/cpukit/score/cpu/arm/armv7m-isr-level-set.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief CPU Set ISR Level
+ */
+
/*
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
*
diff --git a/cpukit/score/cpu/arm/armv7m-isr-vector-install.c b/cpukit/score/cpu/arm/armv7m-isr-vector-install.c
index c2f5294..82b8e02 100644
--- a/cpukit/score/cpu/arm/armv7m-isr-vector-install.c
+++ b/cpukit/score/cpu/arm/armv7m-isr-vector-install.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief CPU ISR Vector Install
+ */
+
/*
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
*
diff --git a/cpukit/score/cpu/arm/armv7m-thread-idle.c b/cpukit/score/cpu/arm/armv7m-thread-idle.c
index cc9a05c..52a3dbd 100644
--- a/cpukit/score/cpu/arm/armv7m-thread-idle.c
+++ b/cpukit/score/cpu/arm/armv7m-thread-idle.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief CPU Thread Idle Body
+ */
+
/*
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/score/cpu/avr/cpu.c b/cpukit/score/cpu/avr/cpu.c
index a3153fc..7508482 100644
--- a/cpukit/score/cpu/avr/cpu.c
+++ b/cpukit/score/cpu/avr/cpu.c
@@ -1,7 +1,10 @@
-/*
- * AVR CPU Dependent Source
- *
+/**
+ * @file
*
+ * @brief AVR CPU Dependent Source
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -20,16 +23,6 @@
#include <rtems/bspIo.h> /* XXX remove me later */
-/* _CPU_Initialize
- *
- * This routine performs processor dependent initialization.
- *
- * INPUT PARAMETERS: NONE
- *
- * NO_CPU Specific Information:
- *
- * XXX document implementation including references if appropriate
- */
void _CPU_Initialize(void)
{
@@ -43,14 +36,6 @@ void _CPU_Initialize(void)
/* FP context initialization support goes here */
}
-/*
- * _CPU_ISR_Get_level
- *
- * NO_CPU Specific Information:
- *
- * XXX document implementation including references if appropriate
- */
-
uint32_t _CPU_ISR_Get_level( void )
{
/*
@@ -81,25 +66,6 @@ void _CPU_ISR_install_raw_handler(
*/
}
-/*
- * _CPU_ISR_install_vector
- *
- * This kernel routine installs the RTEMS handler for the
- * specified vector.
- *
- * Input parameters:
- * vector - interrupt vector number
- * old_handler - former ISR for this vector number
- * new_handler - replacement ISR for this vector number
- *
- * Output parameters: NONE
- *
- *
- * NO_CPU Specific Information:
- *
- * XXX document implementation including references if appropriate
- */
-
void _CPU_ISR_install_vector(
uint32_t vector,
proc_ptr new_handler,
diff --git a/cpukit/score/cpu/i386/cpu.c b/cpukit/score/cpu/i386/cpu.c
index 15ff3c7..c87a76d 100644
--- a/cpukit/score/cpu/i386/cpu.c
+++ b/cpukit/score/cpu/i386/cpu.c
@@ -1,6 +1,10 @@
-/*
- * Intel i386 Dependent Source
+/**
+ * @file
*
+ * @brief Intel i386 Dependent Source
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -22,13 +26,6 @@
#include <rtems/bspIo.h>
#include <rtems/score/thread.h>
-/* _CPU_Initialize
- *
- * This routine performs processor dependent initialization.
- *
- * INPUT PARAMETERS: NONE
- */
-
void _CPU_Initialize(void)
{
#if CPU_HARDWARE_FP
@@ -91,10 +88,6 @@ void _CPU_Initialize(void)
#endif
}
-/*
- * _CPU_ISR_Get_level
- */
-
uint32_t _CPU_ISR_Get_level( void )
{
uint32_t level;
diff --git a/cpukit/score/cpu/i386/sse_test.c b/cpukit/score/cpu/i386/sse_test.c
index 1c8d852..416a07f 100644
--- a/cpukit/score/cpu/i386/sse_test.c
+++ b/cpukit/score/cpu/i386/sse_test.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Test FPU/SSE Context Save and Restore
+ */
+
/*
* Authorship
* ----------
diff --git a/cpukit/score/cpu/m32c/context_init.c b/cpukit/score/cpu/m32c/context_init.c
index 713f8fa..d7c1c5d 100644
--- a/cpukit/score/cpu/m32c/context_init.c
+++ b/cpukit/score/cpu/m32c/context_init.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Initialize Context Area
+ * @ingroup ScoreContext
+ */
+
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/score/cpu/m68k/cpu.c b/cpukit/score/cpu/m68k/cpu.c
index 23051c2..3776345 100644
--- a/cpukit/score/cpu/m68k/cpu.c
+++ b/cpukit/score/cpu/m68k/cpu.c
@@ -1,6 +1,10 @@
-/*
- * Motorola MC68xxx Dependent Source
+/**
+ * @file
*
+ * @brief Motorola MC68xxx Dependent Source
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -20,15 +24,6 @@
uint32_t _CPU_cacr_shadow;
#endif
-/* _CPU_Initialize
- *
- * This routine performs processor dependent initialization.
- *
- * INPUT PARAMETERS: NONE
- *
- * OUTPUT PARAMETERS: NONE
- */
-
void _CPU_Initialize(void)
{
#if ( M68K_HAS_VBR == 0 )
@@ -47,10 +42,6 @@ void _CPU_Initialize(void)
#endif /* M68K_HAS_VBR */
}
-/*
- * _CPU_ISR_Get_level
- */
-
uint32_t _CPU_ISR_Get_level( void )
{
uint32_t level;
@@ -111,20 +102,6 @@ void _CPU_ISR_install_raw_handler(
#endif /* M68K_HAS_VBR */
}
-/*
- * _CPU_ISR_install_vector
- *
- * This kernel routine installs the RTEMS handler for the
- * specified vector.
- *
- * Input parameters:
- * vector - interrupt vector number
- * new_handler - replacement ISR for this vector number
- * old_handler - former ISR for this vector number
- *
- * Output parameters: NONE
- */
-
void _CPU_ISR_install_vector(
uint32_t vector,
proc_ptr new_handler,
diff --git a/cpukit/score/cpu/no_cpu/cpu.c b/cpukit/score/cpu/no_cpu/cpu.c
index 89162bb..287e5d6 100644
--- a/cpukit/score/cpu/no_cpu/cpu.c
+++ b/cpukit/score/cpu/no_cpu/cpu.c
@@ -1,7 +1,10 @@
-/*
- * XXX CPU Dependent Source
- *
+/**
+ * @file
*
+ * @brief No CPU Dependent Source
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -18,17 +21,6 @@
#include <rtems/score/isr.h>
#include <rtems/score/wkspace.h>
-/* _CPU_Initialize
- *
- * This routine performs processor dependent initialization.
- *
- * INPUT PARAMETERS: NONE
- *
- * NO_CPU Specific Information:
- *
- * XXX document implementation including references if appropriate
- */
-
void _CPU_Initialize(void)
{
/*
@@ -41,14 +33,6 @@ void _CPU_Initialize(void)
/* FP context initialization support goes here */
}
-/*
- * _CPU_ISR_Get_level
- *
- * NO_CPU Specific Information:
- *
- * XXX document implementation including references if appropriate
- */
-
uint32_t _CPU_ISR_Get_level( void )
{
/*
@@ -78,25 +62,6 @@ void _CPU_ISR_install_raw_handler(
*/
}
-/*
- * _CPU_ISR_install_vector
- *
- * This kernel routine installs the RTEMS handler for the
- * specified vector.
- *
- * Input parameters:
- * vector - interrupt vector number
- * old_handler - former ISR for this vector number
- * new_handler - replacement ISR for this vector number
- *
- * Output parameters: NONE
- *
- *
- * NO_CPU Specific Information:
- *
- * XXX document implementation including references if appropriate
- */
-
void _CPU_ISR_install_vector(
uint32_t vector,
proc_ptr new_handler,
diff --git a/cpukit/score/cpu/no_cpu/cpu_asm.c b/cpukit/score/cpu/no_cpu/cpu_asm.c
index e2e466c..c1e008a 100644
--- a/cpukit/score/cpu/no_cpu/cpu_asm.c
+++ b/cpukit/score/cpu/no_cpu/cpu_asm.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief No CPU Assembly File
+ */
+
/* cpu_asm.c ===> cpu_asm.S or cpu_asm.s
*
* This file contains the basic algorithms for all assembly code used
diff --git a/cpukit/score/cpu/powerpc/cpu.c b/cpukit/score/cpu/powerpc/cpu.c
index a1ede94..1cac19c 100644
--- a/cpukit/score/cpu/powerpc/cpu.c
+++ b/cpukit/score/cpu/powerpc/cpu.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief PowerPC Dependent Source
+ */
+
/*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
diff --git a/cpukit/score/cpu/powerpc/ppc-isr-vector-install.c b/cpukit/score/cpu/powerpc/ppc-isr-vector-install.c
index 4b8e81a..98eff81 100644
--- a/cpukit/score/cpu/powerpc/ppc-isr-vector-install.c
+++ b/cpukit/score/cpu/powerpc/ppc-isr-vector-install.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Install Interrupt Handler Vector
+ */
+
/*
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
*
More information about the vc
mailing list