added documentation to main.c

This commit is contained in:
Sven Vogel 2024-04-12 17:29:39 +02:00
parent 4f30e6308d
commit 667f985d30
1 changed files with 12 additions and 0 deletions

View File

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