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

Fix the documentation of the Tds parameters of cell base classes 

And add see also between Compact_mesh_cell_base_3 and Mesh_cell_base_3.
This commit is contained in:
Laurent Rineau 2013-10-16 16:29:49 +02:00
parent fcbbe713d5
commit 3ad8f223cd
4 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Mesh_3/doc/Mesh_3/CGAL/Compact_mesh_cell_base_3.h
View File

@ -3,7 +3,7 @@ namespace CGAL {
/*!
\ingroup PkgMesh_3MeshClasses
The class `Compact_mesh_cell_base_3` is a model of the concept `MeshCellBase_3`.
The class `Compact_mesh_cell_base_3<Gt, MD>` is a model of the concept `MeshCellBase_3`.
It is designed to serve as cell base class for the 3D triangulation
used in the 3D mesh generation process. It is more compact in memory than
`Mesh_cell_base_3`.
@ -15,15 +15,18 @@ It has to be a model of the concept `RegularTriangulationTraits_3`.
the faces of the input complex. It has to be a model
of the concept `MeshDomain_3`.
\tparam Tds is the triangulation data structure class to which cells belong. It has to be a model
of the concept `TriangulationDataStructure_3`.
\tparam Tds is the triangulation data structure class to which cells
belong. That parameter is only used by the rebind mechanism (see
`::TriangulationDSCellBase_3::Rebind_TDS`). Users should always use the
default parameter value `void`.
\cgalModels `MeshCellBase_3`
\sa `CGAL::Mesh_complex_3_in_triangulation_3<Tr,CornerIndex,CurveSegmentIndex>`
\sa `CGAL::Mesh_cell_base_3<Gt, MD, Cb>`
*/
template< typename Gt, typename MD, typename Tds >
template< typename Gt, typename MD, typename Tds = void >
class Compact_mesh_cell_base_3 {
public:

1
Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h
View File

@ -29,6 +29,7 @@ of the concept `RegularTriangulationCellBase_3` and defaults to
\cgalModels `MeshCellBase_3`
\sa `CGAL::Mesh_complex_3_in_triangulation_3<Tr,CornerIndex,CurveSegmentIndex>`
\sa `CGAL::Compact_mesh_cell_base_3<Gt, MD, Tds>`
*/
template< typename Gt, typename MD, typename Cb >

1
Mesh_3/doc/Mesh_3/dependencies
View File

@ -6,5 +6,6 @@ Circulator
Stream_support
Surface_mesher
Triangulation_3
TDS_3
Polyhedron
Miscellany

2
Triangulation_3/doc/TDS_3/CGAL/Triangulation_ds_cell_base_3.h
View File

@ -4,7 +4,7 @@ namespace CGAL {
/*!
\ingroup PkgTDS3Classes
The class `Triangulation_ds_cell_base_3` is a model for the concept
The class `Triangulation_ds_cell_base_3<>` is a model for the concept
`TriangulationDSCellBase_3` to be used by
`Triangulation_data_structure_3`.