diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h index 8fc95df34d5..3e84753d9f6 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h @@ -13,7 +13,7 @@ struct No_intersection_tag{}; /*! \ingroup PkgTriangulation2TriangulationClasses -Intersection tag for constrained triangulations, if an exact predicates and exact constructions are provided. +Intersection tag for constrained triangulations, if exact predicates and exact constructions are provided. */ struct Exact_intersections_tag{}; @@ -46,7 +46,7 @@ There are three versions of constrained triangulations
  • In the basic version, the constrained triangulation does not handle intersecting constraints, and the set of input constraints is required to be a set of polylines that do not intersect -except possibly at their points. Any number of constrained edges +except possibly at their endpoints. Any number of constrained edges are allowed to share the same endpoint. Vertical constrained edges are allowed as well as constrained edges with null length. @@ -54,7 +54,7 @@ constrained edges with null length. In those versions, input constraints are allowed to be intersecting, overlapping or partially overlapping polylines. -The triangulation introduce additional vertices at each point which +The triangulation introduces additional vertices at each point which is a proper intersection point of two constraints. A single constraint intersecting other constraints will then appear as the union of several @@ -85,7 +85,7 @@ of the concept `TriangulationTraits_2`. When intersection of input constraints are supported, the geometric traits class is required to provide additional function object types -to compute the intersection of two segments of polylines. +to compute the intersection of two segments or polylines. It has then to be a model of the concept `ConstrainedTriangulationTraits_2`. @@ -111,16 +111,16 @@ faces of the triangulation. Thus the nested `Face` type of a constrained triangulation offers additional functionalities to deal with this information. These additional functionalities -induce additional requirements on the base face class +induce additional requirements on the face base class plugged into the triangulation data structure of a constrained Delaunay triangulation. -The base face of a constrained Delaunay triangulation +The face base of a constrained Delaunay triangulation has to be a model of the concept `ConstrainedTriangulationFaceBase_2`. \cgal provides default instantiations for the template parameters `Tds` and `Itag`, and for the `ConstrainedTriangulationFaceBase_2`. -If `Gt` is the geometric traits +If `Gt` is the geometric traits class parameter, the default for `ConstrainedTriangulationFaceBase_2` is the class @@ -218,7 +218,7 @@ OutputItEdges out) const; /*! Inserts point `p` and restores the status (constrained or not) of all -the touched edges. If present `f` is used as an hint +the touched edges. If present, `f` is used as an hint for the location of `p`. */ Vertex_handle insert(Point p, Face_handle f = Face_handle() ); diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h index 61821f97256..900ed69c9f6 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h @@ -26,7 +26,7 @@ triangulation. The constraint hierarchy keeps track of the input constraints and of their refinement in the triangulation. This data structure -maintains for each input constraints +maintains for each input constraint the sequence of intersection vertices added on this constraint. The constraint hierarchy also allows the user to retrieve the set of constrained edges of the triangulation, and for each @@ -59,7 +59,7 @@ typedef Itag Intersection_tag; /*! The identifier of a polyline constraint. For reasons of backward compatibility of -function that returned `std::pair` instead of `Constraint_id` +functions that returned `std::pair` instead of `Constraint_id`, the id class has a conversion operator for the pair. */ typedef unspecified_type Constraint_id; @@ -224,7 +224,7 @@ void insert_constraint(Vertex_handle va, Vertex_handle vb); /*! Inserts a polyline defined by the points in the range `[first,last)`. Returns the constraint id. -The polyline is considered as a polygon if the first and last point are equal or if `close = true`. This allows for example to pass the vertex range of a `Polygon_2`. +The polyline is considered as a polygon if the first and last points are equal or if `close = true`. This allows for example to pass the vertex range of a `Polygon_2`. \tparam PointIterator must be an `InputIterator` with the value type `Point`. */ template < class PointIterator> @@ -246,7 +246,7 @@ template std::size_t insert_constraints(ConstraintIterator first, ConstraintIterator last); /*! -Same as above except that each constraints is given as a pair of indices of the points +Same as above except that each constraint is given as a pair of indices of the points in the range [points_first, points_last). The indices must go from 0 to `std::distance(points_first, points_last)` \tparam PointIterator is an `InputIterator` with the value type `Point`. \tparam IndicesIterator is an `InputIterator` with `std::pair` where `Int` is an integral type implicitly convertible to `std::size_t` @@ -345,7 +345,7 @@ The polyline simplification algorithm described in Chapter operates on polyline constraints. The algorithm removes vertices of a constraint and at the same time from the triangulation. The points of removed vertices are nevertheless kept -in the the polyline constraint. +in the polyline constraint. This allows the simplification algorithm to compute the error introduced by the simplification process by comparing the current sequence (vertices) to the original sequence (points). @@ -361,7 +361,7 @@ The simplification algorithm uses the following types and functions. An iterator on the points of the chain of sub-constraints representing a constraint. The value type of this iterator is `Point`. A \link Constrained_triangulation_plus_2::Vertices_in_constraint_iterator `Vertices_in_constraint_iterator`\endlink can be converted into -a `Points_in_constraint_iterator`, but not the other way round. +a `Points_in_constraint_iterator`, but not the other way around. \cgalAdvancedEnd */ typedef unspecified_type Points_in_constraint_iterator;