Add null notice to KDoc of Environment

2024-12-29 18:48:26 +01:00 · 2024-12-29 18:48:26 +01:00 · 01472206d3
commit 01472206d3
parent 2ae5c3665e
1 changed files with 5 additions and 0 deletions
--- a/base/src/main/kotlin/de/staropensource/engine/base/utility/Environment.kt
+++ b/base/src/main/kotlin/de/staropensource/engine/base/utility/Environment.kt
@ -31,6 +31,11 @@ import oshi.hardware.HardwareAbstractionLayer
 * Provides information about the
 * environment the application runs in.
 *
+ * All methods contained in this class
+ * have the ability to return `null`.
+ * They will however only do so if the
+ * engine is not initialized.
+ *
 * @constructor Initializes this class
 * @since v1-alpha10
 */