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

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

View File

@@ -1,6 +1,8 @@
/** /**
* @file * @file
* *
* @ingroup RTEMSScoreIntErr
*
* @brief Constants and Prototypes Related to the Internal Error Handler * @brief Constants and Prototypes Related to the Internal Error Handler
* *
* This include file contains constants and prototypes related * This include file contains constants and prototypes related
@@ -26,10 +28,13 @@
* *
* @ingroup RTEMSScore * @ingroup RTEMSScore
* *
* @brief Internal Error Handler
*
* This handler encapsulates functionality which provides the foundation * This handler encapsulates functionality which provides the foundation
* Semaphore services used in all of the APIs supported by RTEMS. * 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().
*/ */