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

Fix doc

This commit is contained in:
Maxime Gimeno 2020-02-26 16:16:19 +01:00
parent 14669c213c
commit ddc784db22
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -269,7 +269,7 @@ that.
*/
void swap(TriangulationDataStructure_3 & tds1);
/*!
/*! \ingroup PkgIOTDS3
The tds streamed in `is`, of original type `TDS_src`, is written into the triangulation. As the vertex and cell
types might be different and incompatible, the creation of new cells and vertices
is made thanks to the functors `convert_vertex` and `convert_cell`, that convert
@ -293,8 +293,8 @@ converting the source cell `c_src` into the target cell:
- `void operator()(const TDS_src::Cell& c_src, Cell& c_tgt) const;` This operator
is meant to be used in case heavy data should be transferred to `c_tgt`.
\note It is required to know the type `Tr_src`, or one that is compatible with it, to call this function.
\note The triangulation contained in `is` can be obtained with the `operator>>` of a `Triangulation_3`.
\note It is required to know the type `TDS_src`, or one that is compatible with it, to call this function.
\note The triangulation contained in `is` can be obtained with the `operator>>` of a `TriangulationDataStructure_3`.
*/
template <typename TDS_src,
typename ConvertVertex,

2
TDS_3/doc/TDS_3/PackageDescription.txt
View File

@ -6,6 +6,8 @@
/// \defgroup PkgTDS3Classes Classes
/// \ingroup PkgTDS3Ref
/// \defgroup PkgIOTDS3 Input for a Triangulation_data_structure_3
/// \ingroup PkgTDS3Ref
/*!
\addtogroup PkgTDS3Ref
\todo check generated documentation