[Bf-blender-cvs] [03015a9b222] master: Cleanup/docs: Add comment to spline lookup factor method

[Hans Goudey]

Commit: 03015a9b222e29e894fe7ce0da059094a8fee9ce
Author: Hans Goudey
Date:   Sun Dec 12 18:03:30 2021 -0600
Branches: master
https://developer.blender.org/rB03015a9b222e29e894fe7ce0da059094a8fee9ce

Cleanup/docs: Add comment to spline lookup factor method

===================================================================

M	source/blender/blenkernel/BKE_spline.hh

===================================================================

diff --git a/source/blender/blenkernel/BKE_spline.hh b/source/blender/blenkernel/BKE_spline.hh
index 4d3009a4cc6..2073ec065fa 100644
--- a/source/blender/blenkernel/BKE_spline.hh
+++ b/source/blender/blenkernel/BKE_spline.hh
@@ -196,9 +196,16 @@ class Spline {
      */
     float factor;
   };
+  /**
+   * Find the position on the evaluated spline at the given portion of the total length.
+   * The return value is the indices of the two neighboring points at that location and the
+   * factor between them, which can be used to look up any attribute on the evaluated points.
+   * \note This does not support extrapolation.
+   */
   LookupResult lookup_evaluated_factor(const float factor) const;
   /**
-   * \note This does not support extrapolation currently.
+   * The same as #lookup_evaluated_factor, but looks up a length directly instead of
+   * a portion of the total.
    */
   LookupResult lookup_evaluated_length(const float length) const;