mirror of https://github.com/CGAL/cgal
Merge pull request #8014 from albert-github/feature/bug_doc_advanced_paragraph
Warnings in documentation when running xmllint
This commit is contained in:
commit
4ea0ae2e2c
|
|
@ -511,6 +511,7 @@ public:
|
||||||
Converts the current triangulation into the same periodic
|
Converts the current triangulation into the same periodic
|
||||||
triangulation in the 1-sheeted covering space.
|
triangulation in the 1-sheeted covering space.
|
||||||
\pre `is_triangulation_in_1_sheet()`
|
\pre `is_triangulation_in_1_sheet()`
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
void convert_to_1_sheeted_covering();
|
void convert_to_1_sheeted_covering();
|
||||||
|
|
@ -982,6 +983,7 @@ public:
|
||||||
`f`. Face `f` is modified,
|
`f`. Face `f` is modified,
|
||||||
two new faces are created. If the triangulation contains periodic copies, a point is inserted in all periodic copies.
|
two new faces are created. If the triangulation contains periodic copies, a point is inserted in all periodic copies.
|
||||||
\pre The point in vertex `v` lies inside face `f`.
|
\pre The point in vertex `v` lies inside face `f`.
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
Vertex_handle insert_in_face(const Point& p, Face_handle f);
|
Vertex_handle insert_in_face(const Point& p, Face_handle f);
|
||||||
|
|
@ -990,7 +992,9 @@ public:
|
||||||
\cgalAdvancedFunction
|
\cgalAdvancedFunction
|
||||||
\cgalAdvancedBegin
|
\cgalAdvancedBegin
|
||||||
Removes a vertex of degree three. Two of the incident faces are
|
Removes a vertex of degree three. Two of the incident faces are
|
||||||
destroyed, the third one is modified. \pre Vertex `v` is a vertex with degree three.
|
destroyed, the third one is modified.
|
||||||
|
\pre Vertex `v` is a vertex with degree three.
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
void remove_degree_3(Vertex_handle v);
|
void remove_degree_3(Vertex_handle v);
|
||||||
|
|
@ -1012,8 +1016,8 @@ public:
|
||||||
creates a new vertex `v` and use it to star the hole
|
creates a new vertex `v` and use it to star the hole
|
||||||
whose boundary is described by the sequence of edges
|
whose boundary is described by the sequence of edges
|
||||||
`[edge_begin, edge_end]`. Returns a handle to the new vertex.
|
`[edge_begin, edge_end]`. Returns a handle to the new vertex.
|
||||||
|
|
||||||
\pre The triangulation is a triangulation of 1 sheet
|
\pre The triangulation is a triangulation of 1 sheet
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
template<class EdgeIt>
|
template<class EdgeIt>
|
||||||
|
|
@ -1027,8 +1031,8 @@ public:
|
||||||
same as above, except that the algorithm
|
same as above, except that the algorithm
|
||||||
first recycles faces in the sequence `[face_begin, face_end]`
|
first recycles faces in the sequence `[face_begin, face_end]`
|
||||||
and create new ones only when the sequence is exhausted.
|
and create new ones only when the sequence is exhausted.
|
||||||
|
|
||||||
\pre The triangulation is a triangulation of 1 sheet
|
\pre The triangulation is a triangulation of 1 sheet
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
template<class EdgeIt, class FaceIt>
|
template<class EdgeIt, class FaceIt>
|
||||||
|
|
|
||||||
|
|
@ -1188,6 +1188,7 @@ public:
|
||||||
\return Returns a pair containing: the specified property map and a
|
\return Returns a pair containing: the specified property map and a
|
||||||
Boolean set to `true` or an empty property map and a Boolean set
|
Boolean set to `true` or an empty property map and a Boolean set
|
||||||
to `false` (if the property was not found).
|
to `false` (if the property was not found).
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
template <class T>
|
template <class T>
|
||||||
|
|
@ -1213,6 +1214,7 @@ public:
|
||||||
|
|
||||||
\note The normal property must have been added to the point set
|
\note The normal property must have been added to the point set
|
||||||
before calling this method (see `add_normal_map()`).
|
before calling this method (see `add_normal_map()`).
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
Vector_push_map normal_push_map ()
|
Vector_push_map normal_push_map ()
|
||||||
|
|
|
||||||
|
|
@ -528,6 +528,7 @@ public:
|
||||||
/// after a number of `contract_geometry()`, keeping the specified
|
/// after a number of `contract_geometry()`, keeping the specified
|
||||||
/// vertices fixed in place.
|
/// vertices fixed in place.
|
||||||
/// \tparam InputIterator a model of `InputIterator` with `boost::graph_traits<TriangleMesh>::%vertex_descriptor` as value type.
|
/// \tparam InputIterator a model of `InputIterator` with `boost::graph_traits<TriangleMesh>::%vertex_descriptor` as value type.
|
||||||
|
///
|
||||||
/// \cgalAdvancedEnd
|
/// \cgalAdvancedEnd
|
||||||
template<class InputIterator>
|
template<class InputIterator>
|
||||||
void set_fixed_vertices(InputIterator begin, InputIterator end)
|
void set_fixed_vertices(InputIterator begin, InputIterator end)
|
||||||
|
|
|
||||||
|
|
@ -130,6 +130,7 @@ data structure that only changes the vertex type. It has to define a type
|
||||||
`Rebind_vertex<Vb2>::%Other` which is a <I>rebound</I> triangulation data structure, that is, the
|
`Rebind_vertex<Vb2>::%Other` which is a <I>rebound</I> triangulation data structure, that is, the
|
||||||
one whose `TriangulationDSVertexBase_3` will be `Vb2`.
|
one whose `TriangulationDSVertexBase_3` will be `Vb2`.
|
||||||
\note It can be implemented using a nested template class.
|
\note It can be implemented using a nested template class.
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
template <typename Vb2>
|
template <typename Vb2>
|
||||||
|
|
@ -143,6 +144,7 @@ data structure that only changes the cell type. It has to define a type
|
||||||
`Rebind_cell<Cb2>::%Other` which is a <I>rebound</I> triangulation data structure, that is, the
|
`Rebind_cell<Cb2>::%Other` which is a <I>rebound</I> triangulation data structure, that is, the
|
||||||
one whose `TriangulationDSCellBase_3` will be `Cb2`.
|
one whose `TriangulationDSCellBase_3` will be `Cb2`.
|
||||||
\note It can be implemented using a nested template class.
|
\note It can be implemented using a nested template class.
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
template <typename Cb2>
|
template <typename Cb2>
|
||||||
|
|
|
||||||
|
|
@ -81,6 +81,7 @@ data structure that only changes the vertex type. It has to define a type
|
||||||
`Other` which is a <I>rebound</I> triangulation data structure with `Vb2`
|
`Other` which is a <I>rebound</I> triangulation data structure with `Vb2`
|
||||||
as vertex type.
|
as vertex type.
|
||||||
\note It can be implemented using a nested template class.
|
\note It can be implemented using a nested template class.
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
template <typename Vb2>
|
template <typename Vb2>
|
||||||
|
|
@ -94,6 +95,7 @@ data structure that only changes the full cell type. It has to define a type
|
||||||
`Other` which is a <I>rebound</I> triangulation data structure with `Fcb2`
|
`Other` which is a <I>rebound</I> triangulation data structure with `Fcb2`
|
||||||
as full cell type.
|
as full cell type.
|
||||||
\note It can be implemented using a nested template class.
|
\note It can be implemented using a nested template class.
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
template <typename Fcb2>
|
template <typename Fcb2>
|
||||||
|
|
@ -112,8 +114,9 @@ A set `C` of full cells satisfying the same condition as in method
|
||||||
method creates new full cells from vertex `v` to the boundary of `C`.
|
method creates new full cells from vertex `v` to the boundary of `C`.
|
||||||
The boundary is recognized by checking the mark of the full cells.
|
The boundary is recognized by checking the mark of the full cells.
|
||||||
This method is used by `Triangulation_data_structure::insert_in_hole()`.
|
This method is used by `Triangulation_data_structure::insert_in_hole()`.
|
||||||
s
|
|
||||||
\pre same as `TriangulationDataStructure::insert_in_hole()`
|
\pre same as `TriangulationDataStructure::insert_in_hole()`
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
|
|
@ -516,6 +516,7 @@ constraints based on a cost and stop function.
|
||||||
\pre The vertex referred by vicq is not contained in any other constraint.
|
\pre The vertex referred by vicq is not contained in any other constraint.
|
||||||
\pre Let `vip` and `vir` be defined as `vip = std::prev(vicq)` and `vir = std::next(vicr)`.
|
\pre Let `vip` and `vir` be defined as `vip = std::prev(vicq)` and `vir = std::next(vicr)`.
|
||||||
\pre The line segment between `*vicp->point()` and `*vicr->point()` must not intersect any constraint.
|
\pre The line segment between `*vicp->point()` and `*vicr->point()` must not intersect any constraint.
|
||||||
|
|
||||||
\cgalAdvancedEnd
|
\cgalAdvancedEnd
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue