From 4f79c3f82b5daebc1eb8afbf5ad6f4ae7d2fcd9d Mon Sep 17 00:00:00 2001
From: thzero <thzero@users.noreply.github.com>
Date: Sun, 7 May 2023 08:12:55 -0500
Subject: [PATCH] cleanup of comments and naming

---
 core/build.gradle  | 11 ++++++-----
 swing/build.gradle | 37 ++++++++++++++++++++++---------------
 2 files changed, 28 insertions(+), 20 deletions(-)

diff --git a/core/build.gradle b/core/build.gradle
index a94c23244..194ebf9eb 100644
--- a/core/build.gradle
+++ b/core/build.gradle
@@ -54,11 +54,6 @@ dependencies {
 }
 
 def serializedEnginesPath = './src/main/resources/datafiles/thrustcurves/thrustcurves.ser'
-// Deletes the serialize engine file if it exists.
-tasks.register('serializeEnginesDelete', Delete) {
-    group = 'openrocket'
-    delete fileTree(serializedEnginesPath)
-}
 // Executes the serialization of engines from ThrustCurve.
 tasks.register('serializeEngines') {
     group = 'openrocket'
@@ -70,6 +65,12 @@ tasks.register('serializeEngines') {
         println "Serialized engines in ${project.file(serializedEnginesPath)} already exist."
     }
 }
+// Deletes the serialize engine file if it exists.
+tasks.register('serializeEnginesDelete', Delete) {
+    group = 'openrocket'
+    delete fileTree(serializedEnginesPath)
+}
+// Excutes the Java serialization program to fetch ThrustCurve rocket data and serialize it.
 tasks.register('serializeEnginesExecute', JavaExec) {
     group = 'openrocket'
     workingDir  new File(projectDir, 'build/tmp')
diff --git a/swing/build.gradle b/swing/build.gradle
index de222ff95..66eee7923 100644
--- a/swing/build.gradle
+++ b/swing/build.gradle
@@ -64,6 +64,7 @@ dependencies {
 }
 
 def externalComponentsPath = './src/main/resources/datafiles/components'
+// Copies the external components to the Swing resource folder.
 tasks.register('externalComponentsCopy', Copy) {
     group = 'openrocket'
     dependsOn 'externalComponentsValidate'
@@ -79,21 +80,13 @@ tasks.register('externalComponentsCopy', Copy) {
         println "Copying $details.sourcePath to $details.path ..."
     }
 }
+// Deletes the external components resource folder.
 tasks.register('externalComponentsDelete', Delete) {
     group = 'openrocket'
     delete fileTree(externalComponentsPath)
 }
-tasks.register('externalComponentsInit') {
-    group = 'openrocket'
-    doLast {
-        exec {
-            workingDir "../"
-            executable 'git'
-            args 'submodule', 'init'
-        }
-        println "Executed externalComponentsInit!"
-    }
-}
+// Validates the external components resource folder.  If it is a Git project, then
+// calls the submodule updates to fetch the latest submodules.
 tasks.register('externalComponentsValidate') {
     group = 'openrocket'
     def externalResourceComponents = './resources-src/datafiles/components-dbcook/orc';
@@ -114,7 +107,7 @@ tasks.register('externalComponentsValidate') {
                     "% git submodule update --remote\n" +
                     "\n";
             println message
-            dependsOn externalComponentsUpdate
+            dependsOn subModuleUpdate
         } else {
             message +=
                     "If you retrieved this code by downloading and uncompressing a zip file,\n" +
@@ -128,16 +121,30 @@ tasks.register('externalComponentsValidate') {
         }
     }
 }
-tasks.register('externalComponentsUpdate') {
+
+// Initializes the submodules in Git.
+tasks.register('submoduleInit') {
     group = 'openrocket'
-    dependsOn 'externalComponentsInit'
+    doLast {
+        exec {
+            workingDir "../"
+            executable 'git'
+            args 'submodule', 'init'
+        }
+        println "Executed submoduleInit!"
+    }
+}
+// Updates the initialized submodules in Git.
+tasks.register('subModuleUpdate') {
+    group = 'openrocket'
+    dependsOn 'submoduleInit'
     doLast {
         exec {
             workingDir "../"
             executable 'git'
             args 'submodule', 'update', '--remote'
         }
-        println "Executed externalComponentsUpdate!"
+        println "Executed subModuleUpdate!"
     }
 }