diff --git a/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h b/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h index 04cfec860fa..01b2f762d1d 100644 --- a/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h +++ b/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h @@ -70,13 +70,13 @@ typedef Hidden_type Triangulation::Vertex_handle ; /// @{ /*! -creates an empty `Point_set_2` . +creates an empty `Point_set_2`. */ Point_set_2(); /*! creates a `Point_set_2` `PS` of the points in the range -[` first`,` last`). +[`first`,`last`). */ template Point_set_2(InputIterator first, InputIterator last); @@ -87,27 +87,27 @@ Point_set_2(InputIterator first, InputIterator last); /// @{ /*! -if `PS` contains a vertex ` v` with \f$ |pos(v)| = p\f$ -the result is a handle to ` v` otherwise the result is `NULL`. +if `PS` contains a vertex `v` with `v.point() == p` +the result is a handle to `v` otherwise the result is `NULL`. */ Vertex\_handle lookup(Point p); /*! -computes a handle to a vertex ` v` of `PS` that is closest to ` p`. +computes a handle to a vertex `v` of `PS` that is closest to `p`. If `PS` is empty, `NULL` is returned. */ Vertex\_handle nearest_neighbor(Point p); /*! -computes a handle to a vertex ` w` of `PS` that is closest to ` v`. -If ` v` is the only vertex in `PS` , `NULL` is returned. +computes a handle to a vertex `w` of `PS` that is closest to `v`. +If `v` is the only vertex in `PS` , `NULL` is returned. */ Vertex\_handle nearest_neighbor(Vertex_handle v); /*! -computes the ` k` nearest neighbors of ` p` in `PS`, and places the +computes the `k` nearest neighbors of `p` in `PS`, and places the handles to the corresponding vertices as a sequence of objects of type Vertex_handle in a container of value type of `res` which points to the first object in the sequence. The function @@ -118,7 +118,7 @@ template OutputIterator nearest_neighbors(Point p, size_type k, OutputIterator res); /*! -computes the ` k` nearest neighbors of ` v`, and places them as a sequence of objects of type +computes the `k` nearest neighbors of `v`, and places them as a sequence of objects of type Vertex_handle in a container of value type of `res` which points to the first object in the sequence. The function returns an output iterator pointing to the position beyond the end @@ -128,7 +128,7 @@ template OutputIterator nearest_neighbors(Vertex_handle v, size_type k,OutputIterator res); /*! -computes handles to all vertices contained in the closure of disk ` C`. +computes handles to all vertices contained in the closure of disk `C`. The computed vertex handles will be placed as a sequence of objects in a container of value type of `res` which points to the first object in the sequence. The function @@ -140,9 +140,9 @@ template OutputIterator range_search(const Circle& C, OutputIterator res); /*! -computes handles to all vertices contained in the closure of the triangle ` (a,b,c)`. +computes handles to all vertices contained in the closure of the triangle `(a,b,c)`. -\pre ` a`, ` b`, and ` c` must not be collinear. +\pre `a`, `b`, and `c` must not be collinear. The computed vertex handles will be placed as a sequence of objects in a container of value type of `res` which points to the first object in the sequence. The function @@ -154,9 +154,9 @@ template OutputIterator range_search(const Point& a, const Point& b, const Point& c,OutputIterator res); /*! -computes handles to all vertices contained in the closure of the iso-rectangle ` (a1,b1,c1,d1)`. +computes handles to all vertices contained in the closure of the iso-rectangle `(a1,b1,c1,d1)`. -\pre ` a1` is the upper left point, ` b1` the lower left, ` c1` the lower right and ` d1` the upper right point of the iso rectangle. +\pre `a1` is the upper left point, `b1` the lower left, `c1` the lower right and `d1` the upper right point of the iso rectangle. The computed vertex handles will be placed as a sequence of objects in a container of value type of `res` which points to the first object in the sequence. The function diff --git a/Point_set_2/doc/Point_set_2/CGAL/nearest_neighbor_delaunay_2.h b/Point_set_2/doc/Point_set_2/CGAL/nearest_neighbor_delaunay_2.h index f15a94e284e..93cafbe37b2 100644 --- a/Point_set_2/doc/Point_set_2/CGAL/nearest_neighbor_delaunay_2.h +++ b/Point_set_2/doc/Point_set_2/CGAL/nearest_neighbor_delaunay_2.h @@ -3,8 +3,8 @@ namespace CGAL { /*! \ingroup PkgPointSet2 -computes a handle to a vertex ` w` of `delau` that is closest to ` v`. -If ` v` is the only vertex in `delau`, `NULL` is returned. +computes a handle to a vertex `w` of `delau` that is closest to `v`. +If `v` is the only vertex in `delau`, `NULL` is returned. Requirements -------------- diff --git a/Point_set_2/doc/Point_set_2/CGAL/range_search_delaunay_2.h b/Point_set_2/doc/Point_set_2/CGAL/range_search_delaunay_2.h index 61f2fc35bda..9abdae1e8bd 100644 --- a/Point_set_2/doc/Point_set_2/CGAL/range_search_delaunay_2.h +++ b/Point_set_2/doc/Point_set_2/CGAL/range_search_delaunay_2.h @@ -15,13 +15,13 @@ namespace CGAL { * * They get a user-defined object that has to control the range * search operation. This way one can for instance stop the search, - * when ` n` points were found. + * when `n` points were found. */ /*! \ingroup PkgPointSet2RangeSearch -computes handles to all vertices contained in the closure of disk ` C`. +computes handles to all vertices contained in the closure of disk `C`. The computed vertex handles will be placed as a sequence of objects in a container of value type of `res` which points to the first object in the sequence. The function @@ -55,9 +55,9 @@ OutputIterator range_search(Dt& delau, const Circle& C, OutputIterator res); /*! \ingroup PkgPointSet2RangeSearch -computes handles to all vertices contained in the closure of the triangle ` (a,b,c)`. +computes handles to all vertices contained in the closure of the triangle `(a,b,c)`. -\pre ` a`, ` b`, and ` c` must not be collinear. +\pre `a`, `b`, and `c` must not be collinear. The computed vertex handles will be placed as a sequence of objects in a container of value type of `res` which points to the first object in the sequence. The function @@ -92,9 +92,9 @@ const Dt::Point& c,OutputIterator res); /*! \ingroup PkgPointSet2RangeSearch -computes handles to all vertices contained in the closure of the iso-rectangle ` (a,b,c,d)`. +computes handles to all vertices contained in the closure of the iso-rectangle `(a,b,c,d)`. -\pre ` a` is the upper left point, ` b` the lower left, ` c` the lower right and ` d` the upper right point of the iso rectangle. +\pre `a` is the upper left point, `b` the lower left, `c` the lower right and `d` the upper right point of the iso rectangle. The computed vertex handles will be placed as a sequence of objects in a container of value type of `res` which points to the first object in the sequence. The function @@ -127,7 +127,7 @@ OutputIterator range_search(Dt& delau, const Dt::Point& a, const Dt::Point& b, c /*! \ingroup PkgPointSet2RangeSearch -computes handles to all vertices contained in the closure of disk ` C`. +computes handles to all vertices contained in the closure of disk `C`. The computed vertex handles will be placed as a sequence of objects in a container of value type of `res` which points to the first object in the sequence. The function @@ -161,9 +161,9 @@ Pred& pred, bool return_if_succeded); /*! \ingroup PkgPointSet2RangeSearch -computes handles to all vertices contained in the closure of the triangle ` (a,b,c)`. +computes handles to all vertices contained in the closure of the triangle `(a,b,c)`. -\pre ` a`, ` b`, and ` c` must not be collinear. +\pre `a`, `b`, and `c` must not be collinear. The computed vertex handles will be placed as a sequence of objects in a container of value type of `res` which points to the first object in the sequence. The function @@ -188,7 +188,7 @@ const Dt::Point& c,OutputIterator res, Pred& pred, bool return_if_succeded); /*! \ingroup PkgPointSet2RangeSearch -computes handles to all vertices contained in the closure of the iso-rectangle ` (a,b,c,d)`. +computes handles to all vertices contained in the closure of the iso-rectangle `(a,b,c,d)`. \pre `a` is the upper left point, `b` the lower left, `c` the lower right and `d` the upper right point of the iso rectangle. The computed vertex handles will be placed as a sequence of objects in a container of value type