From 667f985d3069479ecd4303749d245ee317d4f295 Mon Sep 17 00:00:00 2001
From: servostar <sven.vogel123@web.de>
Date: Fri, 12 Apr 2024 17:29:39 +0200
Subject: [PATCH] added documentation to main.c

---
 src/main.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/main.c b/src/main.c
index aeca14c..bff54ab 100644
--- a/src/main.c
+++ b/src/main.c
@@ -4,13 +4,23 @@
 
 #define LOG_LEVEL LOG_LEVEL_DEBUG
 
+/**
+ * @brief Log a debug message to inform about beginning exit procedures
+ * 
+ */
 void notify_exit(void)
 {
     DEBUG("Exiting gemstone...");
 }
 
+/**
+ * @brief Run compiler setup here
+ * 
+ */
 void setup(void)
 {
+    // setup preample
+
     log_init();
     DEBUG("starting gemstone...");
 
@@ -18,6 +28,8 @@ void setup(void)
     atexit(&notify_exit);
     #endif
 
+    // actual setup
+
     DEBUG("finished starting up gemstone...");
 }