diff options
author | Danny Holman <dholman@gymli.org> | 2024-10-25 23:02:31 -0500 |
---|---|---|
committer | Danny Holman <dholman@gymli.org> | 2024-10-25 23:02:31 -0500 |
commit | 6e8177dae93f592b1d39cd6d6e77c9e6f254360f (patch) | |
tree | 2735f467cec1ae73b9382ac057f817fae1f94dac /include/rune/core/abort.h | |
parent | 71befd8eaf7244badb0188b751066afacb8d8ee3 (diff) |
core: add documentation comments to API functions
Add documentation comments to the functions and structures exposed
through the Rune API.
Signed-off-by: Danny Holman <dholman@gymli.org>
Diffstat (limited to 'include/rune/core/abort.h')
-rw-r--r-- | include/rune/core/abort.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/include/rune/core/abort.h b/include/rune/core/abort.h index 60f368e..5356c5d 100644 --- a/include/rune/core/abort.h +++ b/include/rune/core/abort.h @@ -24,6 +24,10 @@ #include <rune/util/types.h> +/** + * \brief Called during a fatal error, force-quits the engine, + * calls a stack trace on POSIX-compliant platforms + */ RAPI void rune_abort(void); #endif |