refactor: add environment docs

Author: dayyeeet

serverhost-runtime/src/main/kotlin/app/simplecloud/droplet/serverhost/runtime/runner/ServerEnvironment.kt

@@ -11,13 +11,44 @@ abstract class ServerEnvironment(
     protected open val runtimeRepository: GroupRuntimeDirectory,
     private val environmentRepository: EnvironmentConfigRepository
 ) {
+    /**
+     * Starts a [Server] and returns true if the server is successfully started
+     */
     abstract suspend fun startServer(server: Server): Boolean
+
+    /**
+     * Stops a [Server] and returns true if the server is successfully stopped
+     */
     abstract suspend fun stopServer(server: Server): Boolean
+
+    /**
+     * Get a [Server] by unique id (returns null if the server is not running on this environment)
+     */
     abstract fun getServer(uniqueId: String): Server?
+
+    /**
+     * Reattaches a [Server] and returns true if the server is successfully reattached
+     */
     abstract fun reattachServer(server: Server): Boolean
+
+    /**
+     * Executes a command on a [Server] and returns true if execution is successful
+     */
     abstract fun executeCommand(server: Server, command: String): Boolean
+
+    /**
+     * Returns a never ending stream for server logs
+     */
     abstract fun streamLogs(server: Server): Flow<ServerHostStreamServerLogsResponse>
+
+    /**
+     * Precondition if the current environment is valid for a given [EnvironmentConfig]
+     */
     abstract fun appliesFor(env: EnvironmentConfig): Boolean
+
+    /**
+     * Starts the server update checker. This will stop offline servers and update servers by the ping response of the server.
+     */
     abstract fun startServerStateChecker(): Job
 
     fun getEnvironment(server: Server): EnvironmentConfig? {

serverhost-runtime/src/main/kotlin/app/simplecloud/droplet/serverhost/runtime/runner/ServerEnvironments.kt

@@ -31,10 +31,16 @@ class ServerEnvironments(
         default
     )
 
+    /**
+     * Gets the environment a server is running on or null if the server is not running in any environment
+     */
     fun of(server: Server): ServerEnvironment? {
         return of(server.uniqueId)
     }
 
+    /**
+     * Gets the environment a server is running on or null if the server is not running in any environment
+     */
     fun of(uniqueId: String): ServerEnvironment? {
         return envs.firstOrNull {
             it.getServer(uniqueId)?.let { server ->
@@ -48,6 +54,9 @@ class ServerEnvironments(
         return envs
     }
 
+    /**
+     * Returns the initial environment used for the server
+     */
     fun firstFor(server: Server): ServerEnvironment {
         return envs.firstOrNull { it.getEnvironment(server)?.let { env -> it.appliesFor(env) } ?: false } ?: default
     }