RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

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

Browse Source 
Update #3706.
This commit is contained in:
Andreas Dachsberger
2019-04-09 11:24:45 +02:00
committed by Sebastian Huber
parent 0cdcb27c42
commit 5ad74fd6d2
1 changed files with 18 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
cpukit/include/rtems/score/interr.h
View File

@@ -1,10 +1,12 @@
/** /**
* @file * @file
* *
* @brief Constants and Prototypes Related to the Internal Error Handler * @ingroup RTEMSScoreIntErr
* *
* This include file contains constants and prototypes related * @brief Constants and Prototypes Related to the Internal Error Handler
* to the Internal Error Handler. *
* This include file contains constants and prototypes related
* to the Internal Error Handler.
*/ */
/* /*
@@ -22,14 +24,17 @@
#include <rtems/score/cpu.h> #include <rtems/score/cpu.h>
/** /**
* @defgroup RTEMSScoreIntErr Internal Error Handler * @defgroup RTEMSScoreIntErr Internal Error Handler
* *
* @ingroup RTEMSScore * @ingroup RTEMSScore
* *
* This handler encapsulates functionality which provides the foundation * @brief Internal Error Handler
* Semaphore services used in all of the APIs supported by RTEMS. *
* This handler encapsulates functionality which provides the foundation
* Semaphore services used in all of the APIs supported by RTEMS.
*
* @{
*/ */
/**@{*/
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@@ -241,9 +246,9 @@ extern Internal_errors_Information _Internal_errors_What_happened;
* *
* The final step is to call the CPU specific _CPU_Fatal_halt(). * The final step is to call the CPU specific _CPU_Fatal_halt().
* *
* @param[in] the_source The fatal source indicating the subsystem the fatal * @param the_source The fatal source indicating the subsystem the fatal
* condition originated in. * condition originated in.
* @param[in] the_error The fatal error code. This value must be interpreted * @param the_error The fatal error code. This value must be interpreted
* with respect to the source. * with respect to the source.
* *
* @see rtems_fatal() and _Internal_error(). * @see rtems_fatal() and _Internal_error().
@@ -257,7 +262,7 @@ void _Terminate(
* @brief Terminates the system with an INTERNAL_ERROR_CORE fatal source and * @brief Terminates the system with an INTERNAL_ERROR_CORE fatal source and
* the specified core error code. * the specified core error code.
* *
* @param[in] core_error The core error code. * @param core_error The core error code.
* *
* @see _Terminate(). * @see _Terminate().
*/ */
@@ -267,7 +272,7 @@ void _Internal_error( Internal_errors_Core_list core_error ) RTEMS_NO_RETURN;
} }
#endif #endif
/**@}*/ /** @} */
#endif #endif
/* end of include file */ /* end of include file */