chore: add summaries for new power supply interfaces

YoRyan · YoRyan · commit fd559af5cb62 · 2021-07-09T19:14:29.000-07:00
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/ILocomotivePowerSupply.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/ILocomotivePowerSupply.cs
@@ -19,6 +19,9 @@
 
 namespace Orts.Simulation.RollingStocks.SubSystems.PowerSupplies
 {
+    /// <summary>
+    /// Base class for a controllable power supply for an electric or dual-mode locmotive.
+    /// </summary>
     public interface ILocomotivePowerSupply : IPowerSupply
     {
         PowerSupplyType Type { get; }
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/IPowerSupply.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/IPowerSupply.cs
@@ -19,6 +19,9 @@
 
 namespace Orts.Simulation.RollingStocks.SubSystems.PowerSupplies
 {
+    /// <summary>
+    /// Base interface for any kind of line electric power supply via catenary, third rail, etc.
+    /// </summary>
     public interface IPowerSupply : ISubSystem<IPowerSupply>, IParsable
     {
         BatterySwitch BatterySwitch { get; }

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,9 @@`
`19`	`19`
`20`	`20`	`namespace Orts.Simulation.RollingStocks.SubSystems.PowerSupplies`
`21`	`21`	`{`
	`22`	`+ /// <summary>`
	`23`	`+ /// Base class for a controllable power supply for an electric or dual-mode locmotive.`
	`24`	`+ /// </summary>`
`22`	`25`	`public interface ILocomotivePowerSupply : IPowerSupply`
`23`	`26`	`{`
`24`	`27`	`PowerSupplyType Type { get; }`