add XML comment to public method

YoRyan · YoRyan · commit 0b686cfaa192 · 2021-04-26T19:36:04.000-07:00
diff --git a/Source/Orts.Simulation/Simulation/Transfertables.cs b/Source/Orts.Simulation/Simulation/Transfertables.cs
@@ -57,6 +57,9 @@ public class Transfertable : MovingTable
 
         protected Transfertable(STFReader stf, Simulator simulator) : base(stf, simulator) { }
 
+        /// <summary>
+        /// Create a transfer table from an STF definition block.
+        /// </summary>
         public static Transfertable CreateFrom(STFReader stf, Simulator simulator)
         {
             var worldPosition = new WorldPosition();

Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,9 @@ public class Transfertable : MovingTable`
`57`	`57`
`58`	`58`	`protected Transfertable(STFReader stf, Simulator simulator) : base(stf, simulator) { }`
`59`	`59`
	`60`	`+ /// <summary>`
	`61`	`+ /// Create a transfer table from an STF definition block.`
	`62`	`+ /// </summary>`
`60`	`63`	`public static Transfertable CreateFrom(STFReader stf, Simulator simulator)`
`61`	`64`	`{`
`62`	`65`	`var worldPosition = new WorldPosition();`