Merge pull request #7895 from soesau/Shape_regularization-doc_fix-GF

Shape Regularization: Documented missing dependency to OSQP when default solver is used
CGAL · Dec 11, 2023 · 1c5a914 · 1c5a914
2 parents 1150d5a + abbbb53
commit 1c5a914
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/Shape_regularization/include/CGAL/Shape_regularization/regularize_segments.h b/Shape_regularization/include/CGAL/Shape_regularization/regularize_segments.h
@@ -70,6 +70,9 @@ namespace Segments {
     that should be addressed. The function is based on the class `QP_regularization`.
     Please refer to that class and these concepts for more information.
 
+    This class requires a `QPSolver` model which defaults to the \ref thirdpartyOSQP "OSQP"
+    library, which must be available on the system.
+
     \tparam InputRange
     a model of `ConstRange` whose iterator type is `RandomAccessIterator`