From f2d0cc34cdc610b62b05eb617cae33ca86bfb060 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Thu, 24 Jan 2013 11:22:24 +0100 Subject: [PATCH] add implementation note in template alias declaration --- Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h | 3 ++- .../doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h | 1 + .../doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h | 1 + .../doc/TDS_2/Concepts/TriangulationDataStructure_2.h | 6 ++++-- 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h index 22affdc6427..240116679c7 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h @@ -79,7 +79,8 @@ typedef Hidden_type Innermost_coefficient_const_iterator; /*! This template class has to define a type `Rebind::%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 using Rebind = Hidden_type; diff --git a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h index 4d10ccc0da4..f04c98482d4 100644 --- a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h +++ b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h @@ -73,6 +73,7 @@ This template class has to define a type `Rebind_TDS::%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 using Rebind_TDS = Hidden_type; diff --git a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h index d658d321ed7..713ea0b7170 100644 --- a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h +++ b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h @@ -71,6 +71,7 @@ This template class has to define a type `Rebind_TDS::%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 using Rebind_TDS = Hidden_type; diff --git a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h index 0e256531d50..6f9fe07925b 100644 --- a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h +++ b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h @@ -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::%Other` which is a rebound 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 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::%Other` which is a rebound 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 using Rebind_face = Hidden_type;