[Bf-blender-cvs] [bd75d9f44ca] temp-geometry-nodes-curve-deform-node: Cleanup: Improve comments

[Hans Goudey]

Commit: bd75d9f44cad4edb3b24b5a54495cc1898d32b5e
Author: Hans Goudey
Date:   Mon Jun 7 23:53:20 2021 -0500
Branches: temp-geometry-nodes-curve-deform-node
https://developer.blender.org/rBbd75d9f44cad4edb3b24b5a54495cc1898d32b5e

Cleanup: Improve comments

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

M	source/blender/blenkernel/BKE_spline.hh
M	source/blender/blenkernel/intern/spline_base.cc

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

diff --git a/source/blender/blenkernel/BKE_spline.hh b/source/blender/blenkernel/BKE_spline.hh
index bae44f19952..efc165a7198 100644
--- a/source/blender/blenkernel/BKE_spline.hh
+++ b/source/blender/blenkernel/BKE_spline.hh
@@ -55,6 +55,8 @@ using SplinePtr = std::unique_ptr<Spline>;
  *     along the length of a curve.
  *  3. #sample_uniform_index_factors returns an array that stores uniform-length samples
  *     along the spline which can be used to interpolate data from method 1.
+ *  4. #sample_length_parameters_to_index_factors does the same, but uses arbitrary parameter
+ *     inputs, instead of sampling uniformly.
  *
  * Commonly used evaluated data is stored in caches on the spline itself so that operations on
  * splines don't need to worry about taking ownership of evaluated data when they don't need to.
@@ -170,7 +172,6 @@ class Spline {
   LookupResult lookup_evaluated_length(const float length) const;
 
   blender::Array<float> sample_uniform_index_factors(const int samples_size) const;
-
   void sample_length_parameters_to_index_factors(blender::MutableSpan<float> parameters) const;
 
   LookupResult lookup_data_from_index_factor(const float index_factor) const;
diff --git a/source/blender/blenkernel/intern/spline_base.cc b/source/blender/blenkernel/intern/spline_base.cc
index 8d3e1a62d25..663d65f2403 100644
--- a/source/blender/blenkernel/intern/spline_base.cc
+++ b/source/blender/blenkernel/intern/spline_base.cc
@@ -314,9 +314,9 @@ Array<float> Spline::sample_uniform_index_factors(const int samples_size) const
 }
 
 /**
- * Transform an array of unsorted length parameters into index factors (integer part the segment
- * index, float part the factor), which can be used for retrieving evaluated values from the curve
- * at specific points.
+ * Transform an array of unsorted length parameters into index factors. The samples are indices
+ * and factors to the next index encoded in floats. The logic for converting from the float values
+ * to interpolation data is in #lookup_data_from_index_factor.
  *
  * \param parameters: Lengths along the spline to be transformed into index factors.
  * Must be between 0 and the total length of the spline.