score: Doxygen Clean Up Task #3

1 files changed, 32 insertions, 30 deletions

diff --git a/cpukit/score/include/rtems/score/isr.h b/cpukit/score/include/rtems/score/isr.h
index 0d93d29de9..b58f8a4cff 100644
--- a/cpukit/score/include/rtems/score/isr.h
+++ b/cpukit/score/include/rtems/score/isr.h
@@ -1,6 +1,8 @@
 /**
  *  @file  rtems/score/isr.h
  *
+ *  @brief Data Related to the Management of Processor Interrupt Levels
+ *
  *  This include file contains all the constants and structures associated
  *  with the management of processor interrupt levels.  This handler
  *  supports interrupt critical sections, vectoring of user interrupt
@@ -87,19 +89,19 @@ SCORE_EXTERN ISR_Handler_entry *_ISR_Vector_table;
 #endif
 
 /**
- *  @brief Initialize the ISR Handler
+ *  @brief Initialize the ISR handler.
  *
  *  This routine performs the initialization necessary for the ISR handler.
  */
 void _ISR_Handler_initialization ( void );
 
 /**
- *  @brief Disable Interrupts on This Core
+ *  @brief Disable interrupts on this core.
  *
  *  This routine disables all interrupts so that a critical section
  *  of code can be executing without being interrupted.
  *
- *  @return The argument @a _level will contain the previous interrupt
+ *  @retval The argument @a _level will contain the previous interrupt
  *          mask level.
  */
 #define _ISR_Disable_on_this_core( _level ) \
@@ -109,7 +111,7 @@ void _ISR_Handler_initialization ( void );
   } while (0)
 
 /**
- *  @brief Enable Interrupts on This Core
+ *  @brief Enable interrupts on this core.
  *
  *  This routine enables interrupts to the previous interrupt mask
  *  LEVEL.  It is used at the end of a critical section of code to
@@ -125,7 +127,7 @@ void _ISR_Handler_initialization ( void );
   } while (0)
 
 /**
- *  @brief Temporarily Enable Interrupts on This Core
+ *  @brief Temporarily enable interrupts on this core.
  *
  *  This routine temporarily enables interrupts to the previous
  *  interrupt mask level and then disables all interrupts so that
@@ -153,7 +155,7 @@ void _ISR_Handler_initialization ( void );
 #if defined(RTEMS_SMP)
 
 /**
- *  @brief Initialize SMP Interrupt Critical Section Support
+ *  @brief Initialize SMP interrupt critical section support.
  *
  *  This method initializes the variables required by the SMP implementation
  *  of interrupt critical section management.
@@ -161,17 +163,17 @@ void _ISR_Handler_initialization ( void );
 void _ISR_SMP_Initialize(void);
 
 /**
- *  @brief Enter Interrupt Critical Section on SMP System
+ *  @brief Enter interrupt critical section on SMP system.
  *
  *  This method is used to enter an interrupt critical section that
  *  is honored across all cores in an SMP system.
  *
- *  @return This method returns the previous interrupt mask level.
+ *  @retval This method returns the previous interrupt mask level.
  */
 ISR_Level _ISR_SMP_Disable(void);
 
 /**
- *  @brief Exit Interrupt Critical Section on SMP System
+ *  @brief Exit interrupt critical section on SMP system.
  *
  *  This method is used to exit an interrupt critical section that
  *  is honored across all cores in an SMP system.
@@ -182,7 +184,7 @@ ISR_Level _ISR_SMP_Disable(void);
 void _ISR_SMP_Enable(ISR_Level level);
 
 /**
- *  @brief Temporarily Exit Interrupt Critical Section on SMP System
+ *  @brief Temporarily exit interrupt critical section on SMP system.
  *
  *  This method is used to temporarily exit an interrupt critical section
  *  that is honored across all cores in an SMP system.
@@ -193,20 +195,20 @@ void _ISR_SMP_Enable(ISR_Level level);
 void _ISR_SMP_Flash(ISR_Level level);
 
 /**
- *  @brief Enter SMP interrupt code
+ *  @brief Enter SMP interrupt code.
  *
  *  This method is used to enter the SMP interrupt section.
  *
- *  @return This method returns the isr level.
+ *  @retval This method returns the isr level.
  */
 int _ISR_SMP_Enter(void);
 
 /**
- *  @brief Exit SMP interrupt code
+ *  @brief Exit SMP interrupt code.
  *
  *  This method is used to exit the SMP interrupt.
  *
- *  @return This method returns 0 on a simple return and returns 1 on a
+ *  @retval This method returns 0 on a simple return and returns 1 on a
  *  dispatching return.
  */
 int _ISR_SMP_Exit(void);
@@ -214,7 +216,7 @@ int _ISR_SMP_Exit(void);
 #endif
 
 /**
- *  @brief Enter Interrupt Disable Critical Section
+ *  @brief Enter interrupt disable critical section.
  *
  *  This routine enters an interrupt disable critical section.  When
  *  in an SMP configuration, this involves obtaining a spinlock to ensure
@@ -222,7 +224,7 @@ int _ISR_SMP_Exit(void);
  *  When on a single core system, this only involves disabling local
  *  CPU interrupts.
  *
- *  @return The argument @a _level will contain the previous interrupt
+ *  @retval The argument @a _level will contain the previous interrupt
  *          mask level.
  */
 #if defined(RTEMS_SMP)
@@ -234,14 +236,14 @@ int _ISR_SMP_Exit(void);
 #endif
 
 /**
- *  @brief Exits Interrupt Disable Critical Section
+ *  @brief Exits interrupt disable critical section.
  *
  *  This routine exits an interrupt disable critical section.  When
  *  in an SMP configuration, this involves releasing a spinlock.
  *  When on a single core system, this only involves disabling local
  *  CPU interrupts.
  *
- *  @return The argument @a _level will contain the previous interrupt
+ *  @retval The argument @a _level will contain the previous interrupt
  *          mask level.
  */
 #if defined(RTEMS_SMP)
@@ -253,7 +255,7 @@ int _ISR_SMP_Exit(void);
 #endif
 
 /**
- *  @brief Temporarily Exit Interrupt Disable Critical Section
+ *  @brief Temporarily exit interrupt disable critical section.
  *
  *  This routine is used to temporarily enable interrupts
  *  during a long critical section.  It is used in long sections of
@@ -263,7 +265,7 @@ int _ISR_SMP_Exit(void);
  *  must be selected with care to ensure that the critical section
  *  properly protects itself.
  *
- *  @return The argument @a _level will contain the previous interrupt
+ *  @retval The argument @a _level will contain the previous interrupt
  *          mask level.
  */
 #if defined(RTEMS_SMP)
@@ -275,7 +277,7 @@ int _ISR_SMP_Exit(void);
 #endif
 
 /**
- *  @brief Install Interrupt Handler Vector
+ *  @brief Install interrupt handler vector.
  *
  *  This routine installs new_handler as the interrupt service routine
  *  for the specified vector.  The previous interrupt service routine is
@@ -289,26 +291,26 @@ int _ISR_SMP_Exit(void);
  *  @param[in] _old_handler is a pointer to a variable which will be set
  *             to the old handler
  *
- *  @return *_old_handler will be set to the old ISR handler
+ *  @retval *_old_handler will be set to the old ISR handler
  */
 #define _ISR_Install_vector( _vector, _new_handler, _old_handler ) \
   _CPU_ISR_install_vector( _vector, _new_handler, _old_handler )
 
 /**
- *  @brief Return Current Interrupt Level
+ *  @brief Return current interrupt level.
  *
  *  This routine returns the current interrupt level.
  *
  *  LM32 Specific Information:
  *  XXX document implementation including references if appropriate
  *
- *  @return This method returns the current level.
+ *  @retval This method returns the current level.
  */
 #define _ISR_Get_level() \
         _CPU_ISR_Get_level()
 
 /**
- *  @brief Set Current Interrupt Level
+ *  @brief Set current interrupt level.
  *
  *  This routine sets the current interrupt level to that specified
  *  by @a _new_level.  The new interrupt level is effective when the
@@ -324,7 +326,7 @@ int _ISR_SMP_Exit(void);
   } while (0)
 
 /**
- *  @brief ISR Handler or Dispatcher
+ *  @brief ISR interrupt dispatcher.
  *
  *  This routine is the interrupt dispatcher.  ALL interrupts
  *  are vectored to this routine so that minimal context can be saved
@@ -340,7 +342,7 @@ int _ISR_SMP_Exit(void);
 void _ISR_Handler( void );
 
 /**
- *  @brief ISR Wrapper for Thread Dispatcher
+ *  @brief ISR wrapper for thread dispatcher.
  *
  *  This routine provides a wrapper so that the routine
  *  @ref _Thread_Dispatch can be invoked when a reschedule is necessary
@@ -355,13 +357,13 @@ void _ISR_Handler( void );
 void _ISR_Dispatch( void );
 
 /**
- *  @brief Is an ISR in Progress
+ *  @brief Checks if an ISR in progress.
  *
  *  This function returns true if the processor is currently servicing
  *  and interrupt and false otherwise.   A return value of true indicates
  *  that the caller is an interrupt service routine, NOT a thread.
  *
- *  @return This methods returns true when called from an ISR.
+ *  @retval This methods returns true when called from an ISR.
  */
 #if (CPU_PROVIDES_ISR_IS_IN_PROGRESS == TRUE)
   bool _ISR_Is_in_progress( void );
@@ -379,4 +381,4 @@ void _ISR_Dispatch( void );
 /**@}*/
 
 #endif
-/* end of include file */
+/* end of include file */
\ No newline at end of file