songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Drive-by doc fixes

This commit is contained in:
Mael Rouxel-Labbé 2025-09-19 00:28:24 +02:00
parent cc9f36f0f3
commit 4591d9a899
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
BGL/include/CGAL/boost/graph/Euler_operations.h
View File

@ -1670,7 +1670,7 @@ collapse_edge(typename boost::graph_traits<Graph>::edge_descriptor e,
* \returns vertex `v1`. * \returns vertex `v1`.
* \pre This function requires `g` to be an oriented 2-manifold with or without boundaries. * \pre This function requires `g` to be an oriented 2-manifold with or without boundaries.
* Furthermore, the edge `v0v1` must satisfy the link condition, which guarantees that the surface mesh is also 2-manifold after the edge collapse. * Furthermore, the edge `v0v1` must satisfy the link condition, which guarantees that the surface mesh is also 2-manifold after the edge collapse.
* \pre `get(edge_is_constrained_map, v0v1)==false`. * \pre `get(edge_is_constrained_map, v0v1) == false`.
* \pre `v0` and `v1` are not both incident to a constrained edge. * \pre `v0` and `v1` are not both incident to a constrained edge.
*/ */

4
Kernel_d/doc/Kernel_d/CGAL/Epeck_d.h
View File

@ -75,7 +75,7 @@ public:
Point_d(double x0, double x1, ...); Point_d(double x0, double x1, ...);
/*! introduces a point with coordinate set `[first,end)`. /*! introduces a point with coordinate set `[first,end)`.
\pre If `DimensionTag` is a fixed dimension, it matches `distance(first,end)`. \pre If `DimensionTag` is a fixed dimension, it matches `std::distance(first,end)`.
\tparam ForwardIterator has its value type that is convertible to `double`. \tparam ForwardIterator has its value type that is convertible to `double`.
*/ */
template<typename ForwardIterator> template<typename ForwardIterator>
@ -108,7 +108,7 @@ public:
Vector_d(double x0, double x1, ...); Vector_d(double x0, double x1, ...);
/*! introduces a vector with coordinate set `[first,end)`. /*! introduces a vector with coordinate set `[first,end)`.
\pre If `DimensionTag` is a fixed dimension, it matches `distance(first,end)`. \pre If `DimensionTag` is a fixed dimension, it matches `std::distance(first,end)`.
\tparam ForwardIterator has its value type that is convertible to `double`. \tparam ForwardIterator has its value type that is convertible to `double`.
*/ */
template<typename ForwardIterator> template<typename ForwardIterator>

4
Kernel_d/doc/Kernel_d/CGAL/Epick_d.h
View File

@ -63,7 +63,7 @@ public:
Point_d(double x0, double x1, ...); Point_d(double x0, double x1, ...);
/*! introduces a point with coordinate set `[first,end)`. /*! introduces a point with coordinate set `[first,end)`.
\pre If `DimensionTag` is a fixed dimension, it matches `distance(first,end)`. \pre If `DimensionTag` is a fixed dimension, it matches `std::distance(first,end)`.
\tparam InputIterator has its value type that is convertible to `double`. \tparam InputIterator has its value type that is convertible to `double`.
*/ */
template<typename InputIterator> template<typename InputIterator>
@ -98,7 +98,7 @@ public:
Vector_d(double x0, double x1, ...); Vector_d(double x0, double x1, ...);
/*! introduces a vector with coordinate set `[first,end)`. /*! introduces a vector with coordinate set `[first,end)`.
\pre If `DimensionTag` is a fixed dimension, it matches `distance(first,end)`. \pre If `DimensionTag` is a fixed dimension, it matches `std::distance(first,end)`.
\tparam InputIterator has its value type that is convertible to `double`. \tparam InputIterator has its value type that is convertible to `double`.
*/ */
template<typename InputIterator> template<typename InputIterator>

12
TDS_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h
View File

@ -116,7 +116,7 @@ typedef unspecified_type Vertex_handle;
typedef unspecified_type Cell_handle; typedef unspecified_type Cell_handle;
/*! /*!
Can be `CGAL::Sequential_tag`, `CGAL::Parallel_tag`, or `Parallel_if_available_tag`. If it is Can be `CGAL::Sequential_tag`, `CGAL::Parallel_tag`, or `CGAL::Parallel_if_available_tag`. If it is
`CGAL::Parallel_tag`, the following functions can be called concurrently: `CGAL::Parallel_tag`, the following functions can be called concurrently:
`create_vertex()`, `create_cell()`, `delete_vertex()`, `delete_cell()`. `create_vertex()`, `create_cell()`, `delete_vertex()`, `delete_cell()`.
*/ */
@ -875,7 +875,7 @@ Facet_circulator incident_facets(Edge e) const;
As above for edge `(i,j)` of `c`. As above for edge `(i,j)` of `c`.
Only defined in dimension 3, though are defined also in dimension 2: Only defined in dimension 3, though are defined also in dimension 2:
there are only two facets sahring an edge in dimension 2. there are only two facets sharing an edge in dimension 2.
*/ */
Facet_circulator incident_facets(Cell_handle c, int i, int j) const; Facet_circulator incident_facets(Cell_handle c, int i, int j) const;
@ -883,7 +883,7 @@ Facet_circulator incident_facets(Cell_handle c, int i, int j) const;
Starts at facet `start`. Starts at facet `start`.
Only defined in dimension 3, though are defined also in dimension 2: Only defined in dimension 3, though are defined also in dimension 2:
there are only two facets sahring an edge in dimension 2. there are only two facets sharing an edge in dimension 2.
\pre `start` is incident to `e`. \pre `start` is incident to `e`.
*/ */
@ -893,7 +893,7 @@ Facet_circulator incident_facets(Edge e, Facet start) const;
Starts at facet of index `f` in `start`. Starts at facet of index `f` in `start`.
Only defined in dimension 3, though are defined also in dimension 2: Only defined in dimension 3, though are defined also in dimension 2:
there are only two facets sahring an edge in dimension 2. there are only two facets sharing an edge in dimension 2.
*/ */
Facet_circulator incident_facets(Edge e, Cell_handle start, int f) const; Facet_circulator incident_facets(Edge e, Cell_handle start, int f) const;
@ -901,7 +901,7 @@ Facet_circulator incident_facets(Edge e, Cell_handle start, int f) const;
As above for edge `(i,j)` of `c`. As above for edge `(i,j)` of `c`.
Only defined in dimension 3, though are defined also in dimension 2: Only defined in dimension 3, though are defined also in dimension 2:
there are only two facets sahring an edge in dimension 2. there are only two facets sharing an edge in dimension 2.
*/ */
Facet_circulator incident_facets(Cell_handle c, int i, int j, Facet_circulator incident_facets(Cell_handle c, int i, int j,
Facet start) const; Facet start) const;
@ -910,7 +910,7 @@ Facet start) const;
As above for edge `(i,j)` of `c` and facet `(start,f)`. As above for edge `(i,j)` of `c` and facet `(start,f)`.
Only defined in dimension 3, though are defined also in dimension 2: Only defined in dimension 3, though are defined also in dimension 2:
there are only two facets sahring an edge in dimension 2. there are only two facets sharing an edge in dimension 2.
*/ */
Facet_circulator incident_facets(Cell_handle c, int i, int j, Facet_circulator incident_facets(Cell_handle c, int i, int j,
Cell_handle start, int f) const; Cell_handle start, int f) const;