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

Add \cgalRefines and polish a little bit

This commit is contained in:
Andreas Fabri 2017-03-24 09:29:21 +01:00
parent a9625f42ca
commit 98e41d81af
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
TDS_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h
View File

@ -4,7 +4,7 @@
\cgalConcept \cgalConcept
The concept `TriangulationDSFaceBase_2` describes the requirements for The concept `TriangulationDSFaceBase_2` describes the requirements for
the base face of a `CGAL::Triangulation_data_structure_2<Vb,Fb>`. the face base class of a `CGAL::Triangulation_data_structure_2<Vb,Fb>`.
Note that if the `CGAL::Triangulation_data_structure_2` Note that if the `CGAL::Triangulation_data_structure_2`
is plugged into a triangulation class, is plugged into a triangulation class,
@ -30,7 +30,7 @@ In order
to break the cycle, the base classes for faces and vertices to break the cycle, the base classes for faces and vertices
which are plugged in to instantiate a which are plugged in to instantiate a
`CGAL::Triangulation_data_structure_2` `CGAL::Triangulation_data_structure_2`
use a `void` as triangulation use `void` as triangulation
data structure parameter. Then, data structure parameter. Then,
the `CGAL::Triangulation_data_structure_2` the `CGAL::Triangulation_data_structure_2`
uses a <I>rebind</I> mechanism (similar to the one specified in uses a <I>rebind</I> mechanism (similar to the one specified in
@ -46,6 +46,8 @@ that the `CGAL::Triangulation_data_structure_2`
actually uses as a base class for the class actually uses as a base class for the class
`CGAL::Triangulation_data_structure_2::Face`. `CGAL::Triangulation_data_structure_2::Face`.
\cgalRefines `TriangulationDataStructure_2::Face`
\cgalHasModel `CGAL::Triangulation_ds_face_base_2<Tds>` \cgalHasModel `CGAL::Triangulation_ds_face_base_2<Tds>`
\cgalHasModel `CGAL::Triangulation_face_base_2<Traits,Fb>` \cgalHasModel `CGAL::Triangulation_face_base_2<Traits,Fb>`
\cgalHasModel `CGAL::Regular_triangulation_face_base_2<Traits,Fb>` \cgalHasModel `CGAL::Regular_triangulation_face_base_2<Traits,Fb>`

8
TDS_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h
View File

@ -4,16 +4,16 @@
\cgalConcept \cgalConcept
The concept `TriangulationDSVertexBase_2` describes the requirements for the The concept `TriangulationDSVertexBase_2` describes the requirements for the
vertex base class of a `CGAL::Triangulation_data_structure_2<Vb,Fb>`. vertex base class of a `CGAL::Triangulation_data_structure_2<Vb,Fb>`.
Note that if the `CGAL::Triangulation_data_structure_2` Note that if the `CGAL::Triangulation_data_structure_2`
is plugged into a triangulation class, is plugged into a triangulation class,
the vertex base class has additional geometric the vertex base class may have additional geometric
requirements depending on the triangulation class. requirements depending on the triangulation class.
At the base level, At the base level,
provides access to one of its incident provides access to one of its incident
face through a `Face_handle`. faces through a `Face_handle`.
Since the `CGAL::Triangulation_data_structure_2` is the class Since the `CGAL::Triangulation_data_structure_2` is the class
which defines the handle which defines the handle
@ -26,7 +26,7 @@ In order
to break the cycle, the base classes for faces and vertices to break the cycle, the base classes for faces and vertices
which are plugged in to instantiate a which are plugged in to instantiate a
`Triangulation_data_structure_2` `Triangulation_data_structure_2`
use a `void` as triangulation use `void` as triangulation
data structure parameter. Then, data structure parameter. Then,
the `CGAL::Triangulation_data_structure_2` the `CGAL::Triangulation_data_structure_2`
uses a <I>rebind</I> mechanism (similar to the one specified in uses a <I>rebind</I> mechanism (similar to the one specified in