docs: document smoothing value contracts

2026-08-04 14:17:56 +08:00
parent 69fb09e617
commit fda84ce148
7 changed files with 104 additions and 6 deletions
@@ -5,6 +5,13 @@ namespace MultiWheelC.TrajectoryPlanning.PathSmoothing;
 /// <summary>平滑路径中方向一致的连续点范围；起止索引均包含在内。</summary>
 public sealed class SmoothedPathSegment
 {
+    /// <summary>创建覆盖平滑路径连续索引范围的方向段。</summary>
+    /// <param name="segmentIndex">从零开始的方向段编号。</param>
+    /// <param name="direction">该段实际行驶方向。</param>
+    /// <param name="startIndex">该段首点在完整平滑路径中的包含式索引。</param>
+    /// <param name="endIndex">该段末点在完整平滑路径中的包含式索引。</param>
+    /// <param name="startsAtGearSwitch">是否从换向后保留的新方向点开始。</param>
+    /// <param name="endsAtGearSwitch">是否在紧邻下一方向段的换向对之前结束。</param>
    public SmoothedPathSegment(
        int segmentIndex,
        TravelDirection direction,