Classes: changes according to Menelaos' review (first pass)

This commit is contained in:
Clement Jamin 2014-03-19 16:53:52 +01:00
parent ef6de73a41
commit 6d7e22e0d2
5 changed files with 11 additions and 9 deletions

View File

@ -67,7 +67,7 @@ Full_cell_handle remove(Vertex_handle v);
/*!
Remove the points or the vertices (through their
`Vertex_handle`) in the range `[start, end)`.
`*start` must be of type `Vertex_handle`.
`ForwardIterator::value_type` must be `Vertex_handle`.
*/
template< typename ForwardIterator > void remove(ForwardIterator

View File

@ -6,7 +6,7 @@ namespace CGAL {
The class `Triangulation` is used to store and query the full cells and vertices of
a triangulationin dimension \f$ d\f$. A special vertex, named
em infinite vertex, is used to triangulate the outside of the convex
<I>infinite vertex</I>, is used to triangulate the outside of the convex
hull of the points in so called <I>infinite cells</I>.
Parameters
@ -56,8 +56,9 @@ typedef TriangulationTraits::Point_d Point;
/*!
This indicates whether the dimension of the underlying space is static
(`Maximal_dimension`=`CGAL::``Dimension_tag<int dim>`) or
dynamic (`Maximal_dimension`=`CGAL::``Dynamic_dimension_tag`).
(i.e.\ if the type of `Maximal_dimension` is `CGAL::Dimension_tag<int dim>`)
or dynamic (i.e.\ if the type of `Maximal_dimension` is
`CGAL::Dynamic_dimension_tag`).
In the latter case, the `dim` parameter passed to the class's constructor
is used.
*/
@ -378,7 +379,7 @@ triangulation, then <I>locate</I> returns a default constructed
If the point `query` lies in the interior of a bounded (finite) full cell of `tr`,
the latter full cell is returned.
If `query` lies on the boundary of some finite full cells, one of them
If `query` lies on the boundary of some finite full cells, one of the cells
is returned.
Let \f$ d=\f$`tr`.`current_dimension()`. If the point `query` lies
@ -464,7 +465,7 @@ Vertex_handle collapse_face(const Point & p, const Face & f);
/*!
Inserts the points found in range `[s,e)` in the triangulation. Returns
the number of vertices actually inserted. (If several vertices share the
same position in space, only the first insertion is counted.)
same position in space, only the vertex that was actually inserted is counted.)
*/
template< typename ForwardIterator >
size_type insert(ForwardIterator s, ForwardIterator e);

View File

@ -36,7 +36,8 @@ When the second parameter is specified, its possible ``values''
are:<UL>
<LI>`CGAL::Default`, which is the default value. In that case, the
policy `CGAL::TDS_full_cell_default_storage_policy` is used.
policy `CGAL::TDS_full_cell_default_storage_policy` is used (i.e.\ the mirror
indices are not stored).
<LI>`CGAL::TDS_full_cell_default_storage_policy`. In that case, the mirror
indices are not stored.

View File

@ -30,7 +30,7 @@ It also accepts the tag `CGAL::Default` as third parameter. In both
cases, `TriangulationDSFullCell` defaults to `CGAL::Triangulation_ds_full_cell<>`.
\cgalModels ::TriangulationFullCell Additionally, the class
`Triangulation_full_cell` also provides the following types,
`Triangulation_full_cell` provides the following types,
constructors and methods:
\sa `Triangulation_vertex<TriangulationTraits, Data, TriangulationDSVertex>`

View File

@ -31,7 +31,7 @@ also accepts the tag `CGAL::Default` as third parameter. In both cases,
`TriangulationDSVertex` defaults to `CGAL::Triangulation_ds_vertex<>`.
\cgalModels ::TriangulationVertex Additionally, the class
`Triangulation_vertex` also provides the following types, constructors
`Triangulation_vertex` provides the following types, constructors
and methods:
\sa `Triangulation_full_cell<TriangulationTraits, Data, TriangulationDSFullCell>`