Added documentation and todo's

Author: Stefterv

java/gradle/example/.idea/gradle.xml

@@ -7,6 +7,9 @@ import org.gradle.api.tasks.TaskAction
 import java.io.File
 import java.io.ObjectInputStream
 
+/*
+* The DependenciesTask resolves the dependencies for the sketch based on the libraries used
+ */
 abstract class DependenciesTask: DefaultTask() {
     @InputFile
     val librariesMetaData: RegularFileProperty = project.objects.fileProperty()
@@ -59,6 +62,7 @@ abstract class DependenciesTask: DefaultTask() {
         project.dependencies.add("runtimeOnly", "org.jogamp.jogl:jogl-all:2.5.0:natives-macosx-universal")
         project.dependencies.add("runtimeOnly", "org.jogamp.gluegen:gluegen-rt:2.5.0:natives-macosx-universal")
 
+        // TODO: Solve windows specific issue
         // Windows specific native dependencies
         project.dependencies.add("runtimeOnly", "org.jogamp.jogl:jogl-all:2.5.0:natives-windows-amd64")
         project.dependencies.add("runtimeOnly", "org.jogamp.gluegen:gluegen-rt:2.5.0:natives-windows-amd64")

java/gradle/example/.idea/misc.xml

@@ -10,6 +10,10 @@ import java.io.File
 import java.io.ObjectOutputStream
 import java.util.jar.JarFile
 
+/*
+The libraries task scans the sketchbook libraries folder for all the libraries
+This task stores the resulting information in a file that can be used later to resolve dependencies
+ */
 abstract class LibrariesTask : DefaultTask() {
 
     // TODO: Allow this directory to not exist

java/gradle/src/main/kotlin/DependenciesTask.kt

@@ -13,9 +13,10 @@ import javax.inject.Inject
 
 
 // TODO: Generate sourcemaps
+/*
+* The PDETask is the main task that processes the .pde files and generates the Java source code
+ */
 abstract class PDETask : SourceTask() {
-
-
     @get:InputFiles
     @get:PathSensitive(PathSensitivity.RELATIVE)
     @get:IgnoreEmptyDirectories

java/gradle/src/main/kotlin/LibrariesTask.kt

@@ -27,6 +27,7 @@ class ProcessingPlugin @Inject constructor(private val objectFactory: ObjectFact
         val workingDir = project.findProperty("processing.workingDir") as String?
         val debugPort = project.findProperty("processing.debugPort") as String?
 
+        // TODO: Setup sketchbook when using as a standalone plugin
         val sketchbook = project.findProperty("processing.sketchbook") as String?
 
         // Apply the Java plugin to the Project