Update a few comments

This commit is contained in:
JeremyStar™ 2024-06-11 22:28:51 +02:00
parent b1969bff32
commit 9533b3e086
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
2 changed files with 11 additions and 5 deletions

View file

@ -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) {

View file

@ -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
*/