Changeset 24787d08 in rtems


Ignore:
Timestamp:
Apr 9, 2019, 9:30:21 AM (3 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
bb0ccc1
Parents:
5ad74fd6
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/09/19 09:30:21)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:03)
Message:

doxygen: score: adjust doc in isr.h to doxygen guidelines

Update #3706.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/score/isr.h

    r5ad74fd6 r24787d08  
    11/**
    2  *  @file
     2 * @file
    33 *
    4  *  @brief Data Related to the Management of Processor Interrupt Levels
     4 * @ingroup RTEMSScoreISR
    55 *
    6  *  This include file contains all the constants and structures associated
    7  *  with the management of processor interrupt levels.  This handler
    8  *  supports interrupt critical sections, vectoring of user interrupt
    9  *  handlers, nesting of interrupts, and manipulating interrupt levels.
     6 * @brief Data Related to the Management of Processor Interrupt Levels
     7 *
     8 * This include file contains all the constants and structures associated
     9 * with the management of processor interrupt levels.  This handler
     10 * supports interrupt critical sections, vectoring of user interrupt
     11 * handlers, nesting of interrupts, and manipulating interrupt levels.
    1012 */
    1113
     
    2527
    2628/**
    27  *  @defgroup RTEMSScoreISR ISR Handler
     29 * @defgroup RTEMSScoreISR ISR Handler
    2830 *
    29  *  @ingroup RTEMSScore
     31 * @ingroup RTEMSScore
    3032 *
    31  *  This handler encapsulates functionality which provides the foundation
    32  *  ISR services used in all of the APIs supported by RTEMS.
     33 * @brief ISR Handler
    3334 *
    34  *  The ISR Nest level counter variable is maintained as part of the
    35  *  per cpu data structure.
     35 * This handler encapsulates functionality which provides the foundation
     36 * ISR services used in all of the APIs supported by RTEMS.
     37 *
     38 * The ISR Nest level counter variable is maintained as part of the
     39 * per cpu data structure.
     40 *
     41 * @{
    3642 */
    37 /**@{*/
    3843
    3944#ifdef __cplusplus
     
    104109
    105110/**
    106  *  @brief Initialize the ISR handler.
     111 * @brief Initializes the ISR handler.
    107112 *
    108  *  This routine performs the initialization necessary for the ISR handler.
     113 * This routine performs the initialization necessary for the ISR handler.
    109114 */
    110115void _ISR_Handler_initialization ( void );
     
    131136
    132137/**
    133  *  @brief ISR interrupt dispatcher.
     138 * @brief ISR interrupt dispatcher.
    134139 *
    135  *  This routine is the interrupt dispatcher.  ALL interrupts
    136  *  are vectored to this routine so that minimal context can be saved
    137  *  and setup performed before the application's high-level language
    138  *  interrupt service routine is invoked.   After the application's
    139  *  interrupt service routine returns control to this routine, it
    140  *  will determine if a thread dispatch is necessary.  If so, it will
    141  *  ensure that the necessary thread scheduling operations are
    142  *  performed when the outermost interrupt service routine exits.
     140 * This routine is the interrupt dispatcher.  ALL interrupts
     141 * are vectored to this routine so that minimal context can be saved
     142 * and setup performed before the application's high-level language
     143 * interrupt service routine is invoked.   After the application's
     144 * interrupt service routine returns control to this routine, it
     145 * will determine if a thread dispatch is necessary.  If so, it will
     146 * ensure that the necessary thread scheduling operations are
     147 * performed when the outermost interrupt service routine exits.
    143148 *
    144  *  @note  Typically implemented in assembly language.
     149 * @note  Typically implemented in assembly language.
    145150 */
    146151void _ISR_Handler( void );
    147152
    148153/**
    149  *  @brief Checks if an ISR in progress.
     154 * @brief Checks if an ISR in progress.
    150155 *
    151  *  This function returns true if the processor is currently servicing
    152  *  and interrupt and false otherwise.   A return value of true indicates
    153  *  that the caller is an interrupt service routine, NOT a thread.
     156 * This function returns true if the processor is currently servicing
     157 * and interrupt and false otherwise.   A return value of true indicates
     158 * that the caller is an interrupt service routine, NOT a thread.
    154159 *
    155  *  @retval This methods returns true when called from an ISR.
     160 * @retval true Returns true when called from an ISR.
     161 * @retval false Returns false when not called from an ISR.
    156162 */
    157163bool _ISR_Is_in_progress( void );
     
    161167#endif
    162168
    163 /**@}*/
     169/** @} */
    164170
    165171#endif
Note: See TracChangeset for help on using the changeset viewer.