Skip to content

Commit a37e1d6

Browse files
committed
Add XML doc for the new ReadCouplersFromSave() method.
1 parent 37a9bc3 commit a37e1d6

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1527,6 +1527,14 @@ public override void Restore(BinaryReader inf)
15271527
AuxPowerOn = true;
15281528
}
15291529

1530+
/// <summary>
1531+
/// Read the coupler state(s) from a save stream.
1532+
/// </summary>
1533+
/// <remarks>
1534+
/// Has no side effects besides advancing the save stream, thus avoiding any shared-state pitfalls.
1535+
/// </remarks>
1536+
/// <param name="inf">The save stream.</param>
1537+
/// <returns>A list of newly restored <see cref="MSTSCoupling"/> instances.</returns>
15301538
private static IEnumerable<MSTSCoupling> ReadCouplersFromSave(BinaryReader inf)
15311539
{
15321540
var n = inf.ReadInt32();

0 commit comments

Comments
 (0)