From 3f1cd1c2404379985b61786b76f9788bb6b9531f Mon Sep 17 00:00:00 2001
From: Nick Maltbie <nick.dmalt@gmail.com>
Date: Tue, 1 Sep 2020 12:51:55 -0400
Subject: [PATCH] Updated documentation for development and production builds

---
 Assets/Editor/DevelopmentBuilder.cs | 33 ++++++++++++++++++++++++
 Assets/Editor/ProdBuilder.cs        | 39 +++++++++++++++++++++++++++++
 2 files changed, 72 insertions(+)

diff --git a/Assets/Editor/DevelopmentBuilder.cs b/Assets/Editor/DevelopmentBuilder.cs
index aa5f235b..50fbc2d6 100644
--- a/Assets/Editor/DevelopmentBuilder.cs
+++ b/Assets/Editor/DevelopmentBuilder.cs
@@ -2,8 +2,16 @@
 
 namespace EditorNamespace
 {
+
+    /// <summary>
+    /// Development build instructions
+    /// </summary>
     public class DevelopmentBuilder
     {
+        /// <summary>
+        /// Return Building Options for development client
+        /// </summary>
+        /// <returns>Build options for dev client</returns>
         private static BuildOptions BuildOptionsClient()
         {
             EditorUserBuildSettings.development = true;
@@ -15,6 +23,10 @@ private static BuildOptions BuildOptionsClient()
                 BuildOptions.AllowDebugging;
         }
 
+        /// <summary>
+        /// Return Building Options for development client
+        /// </summary>
+        /// <returns>Build options for dev client</returns>
         private static BuildOptions BuildOptionsServer()
         {
             EditorUserBuildSettings.development = true;
@@ -27,8 +39,14 @@ private static BuildOptions BuildOptionsServer()
                 BuildOptions.EnableHeadlessMode;
         }
 
+        /// <summary>
+        /// Scenes used in development
+        /// </summary>
         private static readonly string[] DevelopmentScenes = {"Assets/Scenes/SampleScene.unity"};
 
+        /// <summary>
+        /// Build a windows 32 bit client
+        /// </summary>
         public static void Client_Windows()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
@@ -39,6 +57,9 @@ public static void Client_Windows()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build a windows 32 bit server
+        /// </summary>
         public static void Server_Windows()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
@@ -49,6 +70,9 @@ public static void Server_Windows()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build a windows 64 bit client
+        /// </summary>
         public static void Client_Windows64()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
@@ -59,6 +83,9 @@ public static void Client_Windows64()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build a windows 64 bit server
+        /// </summary>
         public static void Server_Windows64()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
@@ -69,6 +96,9 @@ public static void Server_Windows64()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build a Linux 64 bit client
+        /// </summary>
         public static void Client_Linux64()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
@@ -79,6 +109,9 @@ public static void Client_Linux64()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build a Linux 64 bit server
+        /// </summary>
         public static void Server_Linux64()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
diff --git a/Assets/Editor/ProdBuilder.cs b/Assets/Editor/ProdBuilder.cs
index 7053622e..1da36d28 100644
--- a/Assets/Editor/ProdBuilder.cs
+++ b/Assets/Editor/ProdBuilder.cs
@@ -3,20 +3,38 @@
 
 namespace EditorNamespace
 {
+
+    /// <summary>
+    /// Production build instructions
+    /// </summary>
     public class ProdBuilder
     {
+        /// <summary>
+        /// Return Building Options for production client
+        /// </summary>
+        /// <returns>Build options for prod client</returns>
         private static BuildOptions BuildOptionsClient()
         {
             return BuildOptions.None;
         }
 
+        /// <summary>
+        /// Return Building Options for production server
+        /// </summary>
+        /// <returns>Build options for prod server</returns>
         private static BuildOptions BuildOptionsServer()
         {
             return BuildOptions.EnableHeadlessMode;
         }
 
+        /// <summary>
+        /// Scenes used in development
+        /// </summary>
         private static readonly string[] ProdScenes = {"Assets/Scenes/SampleScene.unity"};
 
+        /// <summary>
+        /// Build a Windows 32 bit client
+        /// </summary>
         public static void Client_Windows()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
@@ -27,6 +45,9 @@ public static void Client_Windows()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build a Windows 32 bit server
+        /// </summary>
         public static void Server_Windows()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
@@ -37,6 +58,9 @@ public static void Server_Windows()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build a Windows 64 bit client
+        /// </summary>
         public static void Client_Windows64()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
@@ -47,6 +71,9 @@ public static void Client_Windows64()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build a Windows 64 bit server
+        /// </summary>
         public static void Server_Windows64()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
@@ -57,6 +84,9 @@ public static void Server_Windows64()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build a Linux 64 bit client
+        /// </summary>
         public static void Client_Linux64()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
@@ -67,6 +97,9 @@ public static void Client_Linux64()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build a Linux 64 bit server
+        /// </summary>
         public static void Server_Linux64()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();
@@ -77,6 +110,9 @@ public static void Server_Linux64()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build an OSX client
+        /// </summary>
         public static void Client_OSX()
         {
             BuildOptions options = BuildOptionsClient();
@@ -88,6 +124,9 @@ public static void Client_OSX()
             BuildPipeline.BuildPlayer(playerOptions);
         }
 
+        /// <summary>
+        /// Build an OSX server
+        /// </summary>
         public static void Server_OSX()
         {
             BuildPlayerOptions playerOptions = new BuildPlayerOptions();