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

add implementation note in template alias declaration

This commit is contained in:
Sébastien Loriot 2013-01-24 11:22:24 +01:00
parent 4104ad62df
commit f2d0cc34cd
4 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h
View File

@ -79,7 +79,8 @@ typedef Hidden_type Innermost_coefficient_const_iterator;
/*!
This template class has to define a type `Rebind<T,d>::%Other` which is a model
of the concept `PolynomialTraits_d`, where `d` is the number of
variables and `T` the `Innermost_coefficient_type`.
variables and `T` the `Innermost_coefficient_type`.
\note It can be implemented using a nested template class.
*/
template <typename T, int d>
using Rebind = Hidden_type;

1
Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h
View File

@ -73,6 +73,7 @@ This template class has to define a type `Rebind_TDS<TDS_2>::%Other` which is th
`CGAL::Triangulation_data_structure_2` is actually plugged in.
This type `Other` will be the actual base
of the class `CGAL::Triangulation_data_structure_2::Face`.
\note It can be implemented using a nested template class.
*/
template <typename TDS2>
using Rebind_TDS = Hidden_type;

1
Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h
View File

@ -71,6 +71,7 @@ This template class has to define a type `Rebind_TDS<TDS2>::%Other` which is the
`CGAL::Triangulation_data_structure_2` is plugged in.
This type `Other` will be the actual base
of the class `CGAL::Triangulation_data_structure_2::Vertex`.
\note It can be implemented using a nested template class.
*/
template <typename TDS2>
using Rebind_TDS = Hidden_type;

6
Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h
View File

@ -114,7 +114,8 @@ typedef Hidden_type Face_handle;
This template class allows to get the type of a triangulation
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
one whose `TriangulationDSVertexBase_2` will be `Vb2`.
one whose `TriangulationDSVertexBase_2` will be `Vb2`.
\note It can be implemented using a nested template class.
*/
template <typename Vb2>
using Rebind_vertex = Hidden_type;
@ -123,7 +124,8 @@ using Rebind_vertex = Hidden_type;
This template class allows to get the type of a triangulation
data structure that only changes the face type. It has to define a type
`Rebind_face<Fb2>::%Other` which is a <I>rebound</I> triangulation data structure, that is, the
one whose `TriangulationDSFaceBase_2` will be `Fb2`.
one whose `TriangulationDSFaceBase_2` will be `Fb2`.
\note It can be implemented using a nested template class.
*/
template <typename Fb2>
using Rebind_face = Hidden_type;