Few Comments and function headers.

Author: dustin

Assets/NetManager.cs

@@ -37,7 +37,8 @@ public bool IsPeerTypeConnected(PeerType peertype, int[] excludeconns)
         {
             foreach (var cid in peerinfo.Keys.Except(excludeconns))
             {
-                var pi = peerinfo[cid]; var strkey = MsgType.MsgTypeToString(MsgType.PeerType);
+                var pi = peerinfo[cid];
+                var strkey = MsgType.MsgTypeToString(MsgType.PeerType);
                 if (pi != null && pi.ContainsKey(strkey) && (PeerType)pi[strkey] == peertype)
                 {
                     return true;
@@ -86,7 +87,7 @@ public override void OnStartServer()
         /// <summary>
         /// Peertype message is the first message received whenever a new client is connected.
         /// </summary>
-        /// <param name="netMsg"></param>
+        /// <param name="netMsg">The NetworkMessage Recieved</param>
         void PeerTypeHandler(NetworkMessage netMsg)
         {
             var pt = (PeerType)netMsg.ReadMessage<IntegerMessage>().value;
@@ -152,22 +153,36 @@ void AspectRatioHandler(NetworkMessage netMsg)
             uicontroller.OnAspectRatioMessage(r);
         }
 
+        /// <summary>
+        /// Called on the server when a client disconnects. Removes the connections.
+        /// </summary>
+        /// <param name="conn">The connection to remove from the server</param>
         public override void OnServerDisconnect(NetworkConnection conn)
         {
             base.OnServerDisconnect(conn);
             peerinfo.Remove(conn.connectionId);
         }
 
+        /// <summary>
+        /// Called on the server when a scene is completed loaded, when the scene load was 
+        /// initiated by the server with ServerChangeScene(). Signals UIController to 
+        /// update Scene.
+        /// </summary>
+        /// <param name="sceneName">Specific Scene to update</param>
         public override void OnServerSceneChanged(string sceneName)
         {
             base.OnServerSceneChanged(sceneName);
             uicontroller.OnServerSceneChanged(sceneName);
         }
 
+        /// <summary>
+        /// Called on the server when a client is ready.
+        /// </summary>
+        /// <param name="conn">The client connection that is ready.</param>
         public override void OnServerReady(NetworkConnection conn)
         {
-            base.OnServerReady(conn);
-            uicontroller.exmanager.el?.envmanager.ForcePushParams();
+            base.OnServerReady(conn);                                   // continue the network setup process
+            uicontroller.exmanager.el?.envmanager.ForcePushParams();     
         }
     }
 }

Assets/UIController/UIController.cs

@@ -47,25 +47,28 @@ public class UIController : MonoBehaviour
         public Dropdown exs;
         public Button savedata, newex, saveex, deleteex;
         public Text startstoptext, pauseresumetext, version;
+
+        // The managers for the panels on the Scene
         public NetManager netmanager;
         public ExperimentManager exmanager;
         public AnalysisManager alsmanager;
-        public ControlManager ctrlmanager;
-        public ControlPanel controlpanel;
+        public ControlManager ctrlmanager;                                  
+
+        // The Panels Physically created on the scene
+        public ControlPanel controlpanel;                                    
         public ExperimentPanel expanel;
         public EnvironmentPanel envpanel;
         public ViewPanel viewpanel;
         public ConsolePanel consolepanel;
         public ConditionPanel condpanel;
         public ConditionTestPanel ctpanel;
 
-        /* Awake() -----------------------------------------------------------------------------
-        Description: Awake is called when the script instance is being loaded. Awake is called only
-        a single time. See the following URL for more information: 
-        https://docs.unity3d.com/ScriptReference/MonoBehaviour.Awake.html
-
-        Loads a configmanger object from the configmanager path, then loads the config object.
-        ----------------------------------------------------------------------------------------*/
+        /// <summary>
+        /// Awake is called when the script instance is being loaded. Awake is called only
+        /// a single time.See the following URL for more information: 
+        /// https://docs.unity3d.com/ScriptReference/MonoBehaviour.Awake.html
+        /// Loads a configmanger object from the configmanager path variable, then loads the config object.
+        /// </summary>
         void Awake()
         {
             // Check for CommandConfigManager.yaml existance
@@ -85,23 +88,25 @@ void Awake()
             }
         }
 
-        /* LoadConfig() -----------------------------------------------------------------------------
-        Description: Loads in and returns a CommandConfig object from configfilepath. Creates A new
-        config object if it can't be loaded
-
-        Parameters:
-            configfilepath - The config file path to the CommandConfig object
-            otherwisedefault - create a new CommandConfig object to use instead.
-        ----------------------------------------------------------------------------------------*/
+        /// <summary>
+        /// Loads in and returns a CommandConfig object from configfilepath. Creates A new
+        /// config object if it can't be loaded
+        /// </summary>
+        /// <param name="configfilepath">The config file path to the CommandConfig object</param>
+        /// <param name="otherwisedefault">create a new CommandConfig object to use instead.</param>
+        /// <returns>The loaded/deault CommandConfig object</returns>
         public CommandConfig LoadConfig(string configfilepath, bool otherwisedefault = true)
         {
             CommandConfig cfg = null;
 
             // Check if the file exists at the specified path, if so, load it.
             if (File.Exists(configfilepath))
             {
+                // Deserialize the text using extension method.
                 cfg = configfilepath.ReadYamlFile<CommandConfig>();
             }
+            
+            // Use default config settings
             if (cfg == null)
             {
                 configmanager.LastConfigFilePath = null;
@@ -154,6 +159,12 @@ public static Dictionary<string, Dictionary<string, List<string>>> ValidateEnvCr
             return rule;
         }
 
+        /// <summary>
+        /// Sets the version number and starts the application.
+        /// Start is called on the frame when a script is enabled just before any of the
+        /// Update methods are called the first time.See the URL below for more information:
+        /// https://docs.unity3d.com/ScriptReference/MonoBehaviour.Start.html
+        /// </summary>
         void Start()
         {
             version.text = $"Version {Application.version}\nUnity {Application.unityVersion}";
@@ -162,6 +173,7 @@ void Start()
 
         public void PushConfig()
         {
+            // Grab settings from Experiement Yaml files, and update the scene
             exmanager.GetExFiles();
             UpdateExDropdown();
             savedata.interactable = !config.AutoSaveData;
@@ -294,6 +306,11 @@ public void OnAspectRatioMessage(float ratio)
             exmanager.el.envmanager.SetParam("ScreenAspect", ratio, true);
         }
 
+        /// <summary>
+        /// Called on the server when a scene is completed loaded, when the scene load was 
+        /// initiated by the server with ServerChangeScene().
+        /// </summary>
+        /// <param name="sceneName">The scene that changed</param>
         public void OnServerSceneChanged(string sceneName)
         {
             exmanager.PrepareEnv(sceneName);
@@ -514,7 +531,13 @@ public void ToggleExInherit(string name, bool isinherit)
                 }
             }
         }
-
+        
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="fullname"></param>
+        /// <param name="paramname"></param>
+        /// <param name="isinherit"></param>
         public void ToggleEnvInherit(string fullname, string paramname, bool isinherit)
         {
             var ip = exmanager.el.ex.EnvInheritParam;
@@ -544,16 +567,26 @@ public void ToggleEnvInherit(string fullname, string paramname, bool isinherit)
             }
         }
 
+        /// <summary>
+        /// Function called for when the 'Save' button in the Control panel is pressed.
+        /// </summary>
         public void SaveEx()
         {
             exmanager.SaveEx(exs.captionText.text);
         }
 
+        /// <summary>
+        /// Script for when the 'X' button in the Control panel is clicked to delete an experiment
+        /// </summary>
         public void DeleteEx()
         {
+            // Delete the file
             var i = exmanager.DeleteEx(exs.captionText.text);
+
+            // If sucessfully deleted
             if (i >= 0)
             {
+                // Remove option from dropdown and update dropdown
                 exs.options.RemoveAt(i);
                 var exn = exs.options.Count;
                 if (exn > 0)
@@ -571,46 +604,67 @@ public void DeleteEx()
             }
         }
 
+        /// <summary>
+        /// This function is called when 'Host' button in Control Panel is pressed. Signals
+        /// to the network manager to start hosting.
+        /// </summary>
+        /// <param name="ison">True when the toggle is now down, else false</param>
         public void ToggleHost(bool ison)
         {
+            // Toggle is now down / on
             if (ison)
             {
+                // Start hosting. Host is both a server and client in one.
                 netmanager.StartHost();
                 ChangeScene();
             }
+            // Toggle is now unpressed / off
             else
             {
+                // When there was an experiment running, stop the experiment
                 if (start.isOn)
                 {
                     ToggleStartStopExperiment(false);
                     start.isOn = false;
                 }
+                // Quit hosting
                 netmanager.StopHost();
             }
+            // Turn server button active, and start button inactive
             server.interactable = !ison;
             start.interactable = ison;
         }
 
+        /// <summary>
+        /// This function is called when 'Server' button in Control Panel is pressed. Signals
+        /// to the network manager to start up a server.
+        /// </summary>
+        /// <param name="ison">True when the toggle is now down, else false</param>
         public void ToggleServer(bool ison)
         {
+            // Toggle is now down / on
             if (ison)
             {
                 netmanager.StartServer();
                 ChangeScene();
             }
+            // Toggle is now up / off
             else
             {
+                // Stop an experiment if there is one, and stop the server
                 if (start.isOn)
                 {
                     ToggleStartStopExperiment(false);
                     start.isOn = false;
                 }
                 netmanager.StopServer();
             }
+            // host button is interactable, start button isn't
             host.interactable = !ison;
             start.interactable = ison;
         }
 
+
         public void ChangeScene()
         {
             if (exmanager.el != null)
@@ -623,6 +677,7 @@ public void ChangeScene()
                 }
                 if (NetworkServer.active)
                 {
+                    // causes the server to switch scenes to the specified scene
                     netmanager.ServerChangeScene(scene);
                 }
             }