Fatal: Update comments.

This commit is contained in:
Michael Scire 2018-06-26 01:01:02 -06:00
parent 5754be9ff9
commit 9dd6eba3ae

View File

@ -7,6 +7,7 @@
#pragma once #pragma once
#include "../types.h" #include "../types.h"
/// Type of thrown fatal error.
typedef enum { typedef enum {
FatalType_ErrorReportAndErrorScreen = 0, FatalType_ErrorReportAndErrorScreen = 0,
FatalType_ErrorReport = 1, FatalType_ErrorReport = 1,
@ -24,6 +25,6 @@ void NORETURN fatalSimple(Result err);
* @brief Triggers a system fatal error with a custom FatalType. * @brief Triggers a system fatal error with a custom FatalType.
* @param err[in] Result code to throw. * @param err[in] Result code to throw.
* @param err[in] Type of fatal error to throw. * @param err[in] Type of fatal error to throw.
* @note This function does not return. * @note This function may not return, depending on \ref FatalType.
*/ */
void fatalWithType(Result err, FatalType type); void fatalWithType(Result err, FatalType type);