From 616caca2b7a936b1f7ed4d94ec0ad5a10f4a78df Mon Sep 17 00:00:00 2001
From: Greenback <jimcartlidge@yahoo.co.uk>
Date: Sat, 21 Nov 2020 13:27:27 +0000
Subject: [PATCH] Added more comments.

---
 Emby.Server.Implementations/ApplicationHost.cs        |  7 ++++++-
 .../LiveTv/TunerHosts/HdHomerun/HdHomerunUdpStream.cs |  3 ++-
 Jellyfin.Api/Helpers/ClassMigrationHelper.cs          | 11 ++++++-----
 3 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/Emby.Server.Implementations/ApplicationHost.cs b/Emby.Server.Implementations/ApplicationHost.cs
index 418f634be..aff67f163 100644
--- a/Emby.Server.Implementations/ApplicationHost.cs
+++ b/Emby.Server.Implementations/ApplicationHost.cs
@@ -271,9 +271,10 @@ namespace Emby.Server.Implementations
             _fileSystemManager = fileSystem;
 
             ConfigurationManager = new ServerConfigurationManager(ApplicationPaths, LoggerFactory, _xmlSerializer, _fileSystemManager);
+            // Have to migrate settings here as migration subsystem not yet initialised.
             MigrateNetworkConfiguration();
 
-            // Have to pre-register the NetworkConfigurationFactory.
+            // Have to pre-register the NetworkConfigurationFactory, as the configuration sub-system is not yet initialised.
             ConfigurationManager.RegisterConfiguration<NetworkConfigurationFactory>();
             NetManager = new NetworkManager((IServerConfigurationManager)ConfigurationManager, LoggerFactory.CreateLogger<NetworkManager>());
 
@@ -301,6 +302,10 @@ namespace Emby.Server.Implementations
             ApplicationUserAgent = Name.Replace(' ', '-') + "/" + ApplicationVersionString;
         }
 
+        /// <summary>
+        /// Temporary function to migration network settings out of system.xml and into network.xml.
+        /// TODO: remove at the point when a fixed migration path has been decided upon.
+        /// </summary>
         private void MigrateNetworkConfiguration()
         {
             string path = Path.Combine(ConfigurationManager.CommonApplicationPaths.ConfigurationDirectoryPath, "network.xml");
diff --git a/Emby.Server.Implementations/LiveTv/TunerHosts/HdHomerun/HdHomerunUdpStream.cs b/Emby.Server.Implementations/LiveTv/TunerHosts/HdHomerun/HdHomerunUdpStream.cs
index b092ffd6e..2eda1ab8b 100644
--- a/Emby.Server.Implementations/LiveTv/TunerHosts/HdHomerun/HdHomerunUdpStream.cs
+++ b/Emby.Server.Implementations/LiveTv/TunerHosts/HdHomerun/HdHomerunUdpStream.cs
@@ -54,6 +54,7 @@ namespace Emby.Server.Implementations.LiveTv.TunerHosts.HdHomerun
 
         /// <summary>
         /// Returns an unused UDP port number in the range specified.
+        /// Temporarily placed here until future network PR merged.
         /// </summary>
         /// <param name="range">Upper and Lower boundary of ports to select.</param>
         /// <returns>System.Int32.</returns>
@@ -78,7 +79,7 @@ namespace Emby.Server.Implementations.LiveTv.TunerHosts.HdHomerun
             var mediaSource = OriginalMediaSource;
 
             var uri = new Uri(mediaSource.Path);
-            // Temporary Code to reduce PR size.
+            // Temporary code to reduce PR size. This will be updated by a future network pr.
             var localPort = GetUdpPortFromRange((49152, 65535));
 
             Directory.CreateDirectory(Path.GetDirectoryName(TempFilePath));
diff --git a/Jellyfin.Api/Helpers/ClassMigrationHelper.cs b/Jellyfin.Api/Helpers/ClassMigrationHelper.cs
index 123fd012d..7184d49d5 100644
--- a/Jellyfin.Api/Helpers/ClassMigrationHelper.cs
+++ b/Jellyfin.Api/Helpers/ClassMigrationHelper.cs
@@ -4,7 +4,8 @@ using System.Reflection;
 namespace Jellyfin.Api.Migrations
 {
     /// <summary>
-    /// A static class for reflection type functions. Temporary until web changed.
+    /// A static class for copying matching properties from one object to another.
+    /// TODO: remove at the point when a fixed migration path has been decided upon.
     /// </summary>
     public static class ClassMigrationHelper
     {
@@ -15,17 +16,17 @@ namespace Jellyfin.Api.Migrations
         /// <param name="destination">The destination.</param>
         public static void CopyProperties(this object source, object destination)
         {
-            // If any this null throw an exception
+            // If any this null throw an exception.
             if (source == null || destination == null)
             {
                 throw new Exception("Source or/and Destination Objects are null");
             }
 
-            // Getting the Types of the objects
+            // Getting the Types of the objects.
             Type typeDest = destination.GetType();
             Type typeSrc = source.GetType();
 
-            // Iterate the Properties of the source instance and populate them from their desination counterparts.
+            // Iterate the Properties of the source instance and populate them from their destination counterparts.
             PropertyInfo[] srcProps = typeSrc.GetProperties();
             foreach (PropertyInfo srcProp in srcProps)
             {
@@ -62,7 +63,7 @@ namespace Jellyfin.Api.Migrations
                     continue;
                 }
 
-                // Passed all tests, lets set the value
+                // Passed all tests, lets set the value.
                 targetProperty.SetValue(destination, srcProp.GetValue(source, null), null);
             }
         }