From 0d1fcc45a94198a8663e8edf7986a49908a8bcf7 Mon Sep 17 00:00:00 2001
From: Stef Tervelde <stef@steftervelde.nl>
Date: Tue, 1 Jul 2025 14:40:30 +0200
Subject: [PATCH] Added documentation and todo's

---
 java/gradle/example/.idea/gradle.xml            | 1 -
 java/gradle/example/.idea/misc.xml              | 1 +
 java/gradle/src/main/kotlin/DependenciesTask.kt | 4 ++++
 java/gradle/src/main/kotlin/LibrariesTask.kt    | 4 ++++
 java/gradle/src/main/kotlin/PDETask.kt          | 5 +++--
 java/gradle/src/main/kotlin/ProcessingPlugin.kt | 1 +
 6 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/java/gradle/example/.idea/gradle.xml b/java/gradle/example/.idea/gradle.xml
index 11bd2cc4c..ae55d4d4a 100644
--- a/java/gradle/example/.idea/gradle.xml
+++ b/java/gradle/example/.idea/gradle.xml
@@ -29,7 +29,6 @@
           </compositeBuild>
         </compositeConfiguration>
         <option name="externalProjectPath" value="$PROJECT_DIR$" />
-        <option name="gradleJvm" value="#JAVA_HOME" />
         <option name="modules">
           <set>
             <option value="$PROJECT_DIR$/../../.." />
diff --git a/java/gradle/example/.idea/misc.xml b/java/gradle/example/.idea/misc.xml
index 6ed36dd36..822aa1a0c 100644
--- a/java/gradle/example/.idea/misc.xml
+++ b/java/gradle/example/.idea/misc.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="ExternalStorageConfigurationManager" enabled="true" />
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_24" project-jdk-name="temurin-17" project-jdk-type="JavaSDK" />
 </project>
\ No newline at end of file
diff --git a/java/gradle/src/main/kotlin/DependenciesTask.kt b/java/gradle/src/main/kotlin/DependenciesTask.kt
index 320f1ebb0..e847cc310 100644
--- a/java/gradle/src/main/kotlin/DependenciesTask.kt
+++ b/java/gradle/src/main/kotlin/DependenciesTask.kt
@@ -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")
diff --git a/java/gradle/src/main/kotlin/LibrariesTask.kt b/java/gradle/src/main/kotlin/LibrariesTask.kt
index 1ac0dd51e..a6e932500 100644
--- a/java/gradle/src/main/kotlin/LibrariesTask.kt
+++ b/java/gradle/src/main/kotlin/LibrariesTask.kt
@@ -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
diff --git a/java/gradle/src/main/kotlin/PDETask.kt b/java/gradle/src/main/kotlin/PDETask.kt
index 22e9360ac..57fa31f3e 100644
--- a/java/gradle/src/main/kotlin/PDETask.kt
+++ b/java/gradle/src/main/kotlin/PDETask.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
diff --git a/java/gradle/src/main/kotlin/ProcessingPlugin.kt b/java/gradle/src/main/kotlin/ProcessingPlugin.kt
index 472365209..b02d7f094 100644
--- a/java/gradle/src/main/kotlin/ProcessingPlugin.kt
+++ b/java/gradle/src/main/kotlin/ProcessingPlugin.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