From 9533b3e086a37e9396c278ba1f6052d476c0b196 Mon Sep 17 00:00:00 2001
From: JeremyStarTM <jeremystartm@staropensource.de>
Date: Tue, 11 Jun 2024 22:28:51 +0200
Subject: [PATCH] Update a few comments

---
 .../sosengine/base/logging/CrashHandler.java        | 13 +++++++++----
 .../sosengine/base/utility/Miscellaneous.java       |  3 ++-
 2 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java b/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java
index 7f39afe..40f7a32 100644
--- a/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java
+++ b/base/src/main/java/de/staropensource/sosengine/base/logging/CrashHandler.java
@@ -166,10 +166,15 @@ public final class CrashHandler {
      * @since 1-alpha0
      */
      /*
-       Note: This entire method causes a compilation warning as we are using "unchecked or unsecure operations".
-             We can safely ignore this as this method
-             1. checks data types as best as it can, and
-             2. only works on a String and not on a File or something which could cause damage.
+      * Note: This entire method causes a compilation warning as we are using "unchecked or unsecure operations".
+      *       We can safely ignore this as this method
+      *       1. checks data types as best as it can,
+      *       2. only works on a String and not on a File or something which could cause damage, and
+      *       3. we can trust our own engine and the application not doing shit in here.
+      *          as an application or subsystem developer you'll likely want useful crash information.
+      *
+      *       But hey, if someone breaks this method (which may be possible idk didn't test it) then congrats!
+      *       If someone opens a pull requests wanting to "fix" this method, I'll happily decline it :)
       */
     @NotNull
     private static String processCrashContent(@NotNull LinkedHashMap<Object, Object> map, int indentationSize) {
diff --git a/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java b/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java
index 3ba1fe7..529b377 100644
--- a/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java
+++ b/base/src/main/java/de/staropensource/sosengine/base/utility/Miscellaneous.java
@@ -56,7 +56,8 @@ public final class Miscellaneous {
     }
 
     /**
-     * Forcefully invokes the garbage collector and blocks execution until finished.
+     * Forcefully invokes the garbage collector and blocks execution until finished.<br/>
+     * If you want to run it in parallel to your program, consider running it in a {@link VirtualThread}.
      *
      * @since 1-alpha0
      */