feat(build-tools): added java docs

Author: TheRedMagic

plugin/src/main/kotlin/com/undefinedcreations/echo/dependency/BuildToolsManager.kt

@@ -19,8 +19,14 @@ object BuildToolsManager {
     private val buildToolsVersionFile = File(echoFolder, "buildToolsVersion.json")
     private val buildToolsJAR = File(echoFolder, "BuildTools.jar")
 
+    /**
+     * Create the cache folder
+     */
     fun createUndefinedFolder() { echoFolder.mkdirs() }
 
+    /**
+     * This method will check the local build tools version and update if needed
+     */
     fun checkBuildToolsAndInstall() {
         val lastVersion = getLastBuildToolsVersionInfo()
         if (getLocalBuildToolsVersion() < lastVersion.version) {
@@ -31,7 +37,15 @@ object BuildToolsManager {
         }
     }
 
-
+    /**
+     * This method will run build tools at a set minecraft version
+     *
+     * @param version the minecraft version that needs to be build
+     * @param remapped if it should build the mojang mappings
+     * @param generateSource if it should build the sources
+     * @param generateDocs if it should build the docs with the jar. This is only the craftbukkit docs
+     * @param printDebug if it should print out the jar debug info
+     */
     @Suppress("NAME_SHADOWING")
     fun buildBuildTools(
         version: String,

plugin/src/main/kotlin/com/undefinedcreations/echo/dependency/JavaVersions.kt

@@ -6,6 +6,10 @@ import org.gradle.api.artifacts.dsl.DependencyHandler
 abstract class RemapDependenciesExtension(
     private val dependencies: DependencyHandler
 ) {
+    /**
+     * This method will build tools of the select minecraft version with the correct options.
+     * Next it will add the build tools that was build as a dependency.
+     */
     operator fun invoke(
         minecraftVersion: String,
         mojangMapping: Boolean = true,

plugin/src/main/kotlin/com/undefinedcreations/echo/dependency/RemapDependenciesExtension.kt

@@ -1,4 +1,7 @@
 package com.undefinedcreations.echo.exceptions
 
+/**
+ * This exception will be throw then the system doesn't have the correct version of java installed.
+ */
 class UnsupportedJavaVersion(version: Int): Exception("Can't find the correct version for build tools ($version)") {
 }