Add comments and cleanup code

Author: JohannesDeml

Assets/Scripts/ConstantRotation.cs

@@ -27,7 +27,7 @@ public enum UpdateType
 		}
 
 		[Tooltip("Rotating absolute in world space or relative to the axes of the object\n" +
-		         "For root objects use self, same effect but more performant.")]
+				 "For root objects use self, same effect but more performant.")]
 		[SerializeField]
 		private Space space = Space.World;
 

Assets/Scripts/Editor/BuildScript.cs

@@ -11,8 +11,10 @@
 namespace UnityBuilderAction
 {
 	/// <summary>
-	/// Used for building the project through CI
-	/// Modified version from https://github.com/game-ci/documentation/blob/main/example/BuildScript.cs
+	/// Used for building the project through continuous integration (CI) or semi-automated through menu items
+	/// Supports logging in the editor and highly configurable WebGL
+	/// Modified version of <see href="https://github.com/game-ci/documentation/blob/main/example/BuildScript.cs">
+	/// Tailored to the needs for <see href="https://github.com/JohannesDeml/UnityWebGL-LoadingTest">
 	/// </summary>
 	public static class BuildScript
 	{
@@ -275,15 +277,15 @@ private static void ReportSummary(BuildSummary summary)
 				$"Size: {summary.totalSize.ToString()} bytes{Eol}" +
 				$"{Eol}";
 
-            if (summary.totalErrors == 0)
-            {
-                Log(summaryText);
-            }
-            else
-            {
-                LogError(summaryText);
-            }
-        }
+			if (summary.totalErrors == 0)
+			{
+				Log(summaryText);
+			}
+			else
+			{
+				LogError(summaryText);
+			}
+		}
 
 		private static void ExitWithResult(BuildResult result)
 		{

Assets/Scripts/Editor/BuildScriptMenu.cs

@@ -16,8 +16,8 @@
 namespace UnityBuilderAction
 {
 	/// <summary>
-	/// Unity menu items for building the project for WebGL with the build script
-	/// Helpful for testing the CI behavior
+	/// Menu items for <see cref="BuildScript"> to build the project in the editor
+	/// Helpful for testing the CI behavior and semi-automated builds
 	/// </summary>
 	public class BuildScriptMenu
 	{

Assets/Scripts/Editor/RemoveMobileSupportWarningWebBuild.cs

@@ -17,8 +17,9 @@
 namespace Supyrb
 {
 	/// <summary>
-	/// removes a warning popup for mobile builds, that this platform might not be supported:
+	/// Removes a warning popup for mobile builds, that this platform might not be supported:
 	/// "Please note that Unity WebGL is not currently supported on mobiles. Press OK if you wish to continue anyway."
+	/// This warning only shows up for unity versions prior to 2020.1
 	/// </summary>
 	public class RemoveMobileSupportWarningWebBuild
 	{

Assets/Scripts/Editor/UnityPackageScripts.cs

@@ -17,6 +17,11 @@
 
 namespace UnityBuilderAction
 {
+	/// <summary>
+	/// Editor script to automatically update all packages in the project to the newest version
+	/// Can be used in continuous integration (CI) or through menu items in the editor
+	/// Uses non-blocking tasks, so you can continue working until the packages recompile
+	/// </summary>
 	public static class UnityPackageScripts
 	{
 		private static int ProgressId;
@@ -27,9 +32,9 @@ public static class UnityPackageScripts
 		private static AddRequest AddRequest;
 		private static Queue<string> PackagesToAdd;
 		#endif
-		
+
 		private static bool IncludePrereleases;
-		
+
 		[MenuItem("Tools/Packages/Update to verified version")]
 		public static void UpgradeAllPackagesToVerifiedVersion()
 		{
@@ -43,11 +48,11 @@ public static void UpgradeAllPackagesToLatestCompatibleVersion()
 			IncludePrereleases = true;
 			StartPackageListUpdate();
 		}
-		
+
 		private static void StartPackageListUpdate()
 		{
 #if UNITY_2020_1_OR_NEWER
-			ProgressId = Progress.Start("Update Packages", 
+			ProgressId = Progress.Start("Update Packages",
 			$"Update all packages to latest version (Include Pre-Releases: {IncludePrereleases})");
 #endif
 			ListRequest = Client.List();
@@ -63,7 +68,7 @@ private static void OnWaitForPackageList()
 #endif
 				return;
 			}
-			
+
 			EditorApplication.update -= OnWaitForPackageList;
 
 			switch (ListRequest.Status)
@@ -99,10 +104,10 @@ private static void UpdatePackages()
 				{
 					continue;
 				}
-				
-				
-				string latestVersion = IncludePrereleases ? 
-					package.versions.latestCompatible : 
+
+
+				string latestVersion = IncludePrereleases ?
+					package.versions.latestCompatible :
 #if UNITY_2019_3_OR_NEWER
 					package.versions.verified;
 #else
@@ -112,7 +117,7 @@ private static void UpdatePackages()
 				{
 					continue;
 				}
-				
+
 				Debug.Log($"Update {package.name} from {package.version} to {latestVersion}");
 				toAdd.Add($"{package.name}@{latestVersion}");
 			}
@@ -127,7 +132,7 @@ private static void UpdatePackages()
 #if UNITY_2020_1_OR_NEWER
 			Progress.Report(ProgressId, 0.5f, $"Updating {toAdd.Count} packages: {string.Join(", ", toAdd)}");
 #endif
-			
+
 #if UNITY_2021_2_OR_NEWER
 			AddAndRemoveRequest = Client.AddAndRemove(toAdd.ToArray(), toRemove.ToArray());
 			EditorApplication.update += OnWaitForPackageUpdates;
@@ -148,7 +153,7 @@ private static void OnWaitForPackageUpdates()
 			{
 				return;
 			}
-			
+
 			EditorApplication.update -= OnWaitForPackageUpdates;
 
 			switch (AddAndRemoveRequest.Status)
@@ -172,7 +177,7 @@ private static void OnWaitForPackageUpdates()
 			}
 		}
 #else
-		
+
 		private static void OnWaitForSinglePackageUpdate()
 		{
 #if UNITY_2020_1_OR_NEWER
@@ -215,7 +220,7 @@ private static void OnWaitForSinglePackageUpdate()
 			}
 		}
 #endif
-		
+
 		private static void EndUpdate(int returnValue)
 		{
 #if UNITY_2020_1_OR_NEWER
@@ -231,7 +236,7 @@ private static void EndUpdate(int returnValue)
 				{
 					throw new Exception($"BuildScript ended with non-zero exitCode: {returnValue}");
 				}
-				
+
 				Debug.Log($"Successfully updated packages");
 			}
 		}

Assets/WebGLTemplates/Develop/LICENSE

@@ -0,0 +1,2 @@
+Licensed under MIT, Copyright Johannes Deml 2021-2023
+Template from https://github.com/JohannesDeml/UnityWebGL-LoadingTest

Assets/WebGLTemplates/Develop/README.md.meta renamed to Assets/WebGLTemplates/Develop/LICENSE.meta

@@ -0,0 +1,2 @@
+Licensed under MIT, Copyright Johannes Deml 2021-2023
+Template from https://github.com/JohannesDeml/UnityWebGL-LoadingTest