docs: document smoothing processing core

2026-08-04 14:29:51 +08:00
parent 4a7dd875a4
commit 8f6e97e88f
17 changed files with 153 additions and 11 deletions
@@ -12,9 +12,12 @@ public sealed class PathGeometryAnalyzer
    private const double MinimumDistanceMeters = 1e-10d;
    private const double BoundaryToleranceMeters = 1e-8d;

-    /// <summary>
-    /// 对候选方向段进行确定性几何分析。换向点两侧永不参与同一次差分。
-    /// </summary>
+    /// <summary>对候选方向段执行确定性几何分析；换向点两侧永不参与同一次航向或曲率差分。</summary>
+    /// <param name="candidateSegments">按段索引排列的候选前进/倒车段；每段点位置为 m、航向为 rad。</param>
+    /// <param name="spacingMeters">最终几何采样间距，单位 m，必须为有限正数。</param>
+    /// <param name="analysis">成功时为完整路径、方向段、弧长、曲率、曲率导数和净空统计；失败时为 <see langword="null"/>。</param>
+    /// <param name="reason">失败时描述输入、边界、退化几何或曲率估计问题；成功时为空字符串。</param>
+    /// <returns>所有方向段和换向拓扑可重采样、可分析且总弧长保持严格递增时为 <see langword="true"/>；否则为 <see langword="false"/>。</returns>
    public bool TryAnalyze(
        IReadOnlyList<PreparedDirectionSegment> candidateSegments,
        double spacingMeters,