From 6e8177dae93f592b1d39cd6d6e77c9e6f254360f Mon Sep 17 00:00:00 2001
From: Danny Holman <dholman@gymli.org>
Date: Fri, 25 Oct 2024 23:02:31 -0500
Subject: 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>
---
 include/rune/core/abort.h | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'include/rune/core/abort.h')

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
-- 
cgit v1.2.3