[Bf-blender-cvs] [a219507d57f] master: Cleanup: Add documentation to curve legacy conversion functions

[Hans Goudey]

Commit: a219507d57f2a9c1e26fbef1675d43536ffde27c
Author: Hans Goudey
Date:   Mon Jan 16 12:06:29 2023 -0600
Branches: master
https://developer.blender.org/rBa219507d57f2a9c1e26fbef1675d43536ffde27c

Cleanup: Add documentation to curve legacy conversion functions

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

M	source/blender/blenkernel/BKE_curve_legacy_convert.hh

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

diff --git a/source/blender/blenkernel/BKE_curve_legacy_convert.hh b/source/blender/blenkernel/BKE_curve_legacy_convert.hh
index 88f93282f25..e7996faa0c5 100644
--- a/source/blender/blenkernel/BKE_curve_legacy_convert.hh
+++ b/source/blender/blenkernel/BKE_curve_legacy_convert.hh
@@ -13,7 +13,14 @@ struct Curves;
 
 namespace blender::bke {
 
+/**
+ * Convert the old curve type to the new data type. Caller owns the returned pointer.
+ */
 Curves *curve_legacy_to_curves(const Curve &curve_legacy);
+/**
+ * Convert the old curve type to the new data type using a specific list of #Nurb for the actual
+ * geometry data. Caller owns the returned pointer.
+ */
 Curves *curve_legacy_to_curves(const Curve &curve_legacy, const ListBase &nurbs_list);
 
 }  // namespace blender::bke