Document constructor

2025-02-10 14:08:01 +00:00 · 2025-02-10 14:08:01 +00:00 · aeecb85263
parent 4395927c7d
commit aeecb85263
1 changed files with 4 additions and 0 deletions
--- a/Frechet_distance/include/CGAL/Frechet_distance/Neighbor_search.h
+++ b/Frechet_distance/include/CGAL/Frechet_distance/Neighbor_search.h
@ -43,6 +43,10 @@ class Neighbor_search
    using Polylines = std::vector<Polyline>;

 public:
+/*!
+ * constructs a neighbor search data structure for `polylines`
+ * \tparam PolylineRange must be a model of `RandomAccessRange` with value type `PointRange`
+*/
    template <typename PolylineRange>
    Neighbor_search(const PolylineRange& polylines)
    : curves(polylines.begin(), polylines.end())