score misc: Clean up Doxygen GCI Task #12

http://www.google-melange.com/gci/task/view/google/gci2012/7983217
2012-12-07 09:57:04 -05:00
parent 4c98a3ea29
commit b7185613e8
20 changed files with 120 additions and 123 deletions
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- 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.
 *
--- a/cpukit/score/cpu/avr/cpu.c
+++ b/cpukit/score/cpu/avr/cpu.c
@@ -1,7 +1,10 @@
+/**
+ *  @file
+ *
+ *  @brief AVR CPU Dependent Source
+ */
+
 /*
- *  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,
--- 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;
--- 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
 * ----------
--- 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).
--- 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,
--- a/cpukit/score/cpu/no_cpu/cpu.c
+++ b/cpukit/score/cpu/no_cpu/cpu.c
@@ -1,7 +1,10 @@
+/**
+ *  @file
+ *
+ *  @brief No CPU Dependent Source
+ */
+
 /*
- *  XXX 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,
--- 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
--- 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
--- 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.
 *