Merge pull request #4363 from afabri/TDS_3-doc-GF

TDS_2/3: Cleanup in the documentation

TDS_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h

@@ -14,6 +14,10 @@ implemented using `Compact_container`. The class may offer some
 flexibility for the choice of container in the future, in the form of 
 additional template parameters. 
 
+\tparam VertexBase must be a model of `TriangulationDSVertexBase_2`. The default is `Triangulation_ds_vertex_base_2<TDS>`.
+
+\tparam FaceBase  must be a model of `TriangulationDSFaceBase_2`. The default is `Triangulation_ds_face_base_2<TDS>`.
+
 \cgalModels `TriangulationDataStructure_2`
 
 \cgalHeading{Modifiers}
@@ -33,7 +37,7 @@ guarantee the combinatorial validity of the resulting data structure.
 \image html tds-insert_degree_2.png "Insertion and removal of degree 2 vertices. "
 \image latex tds-insert_degree_2.png "Insertion and removal of degree 2 vertices. "
 */
-template< typename Vb, typename Fb >
+template< typename VertexBase, typename FaceBase >
 class Triangulation_data_structure_2 {
 public:
 
@@ -42,13 +46,13 @@ public:
 
 /// @{
 
-  typedef Triangulation_data_structure_2<Vb,Fb>  Tds;
+  typedef Triangulation_data_structure_2<VertexBase,FaceBase>  Tds;
 
 /// The vertex type.
-  typedef  typename Vb::template Rebind_TDS<Tds>::Other  Vertex;
+  typedef  typename VertexBase::template Rebind_TDS<Tds>::Other  Vertex;
 
 /// The face type.
-  typedef  typename Fb::template Rebind_TDS<Tds>::Other  Face;
+  typedef  typename FaceBase::template Rebind_TDS<Tds>::Other  Face;
 
 /// @}
 

TDS_2/doc/TDS_2/PackageDescription.txt

@@ -58,7 +58,7 @@ These refining concepts and their models are described in Chapter
 - `TriangulationDSVertexBase_2`
 
 \cgalCRPSection{Classes}
-- `CGAL::Triangulation_data_structure_2<Vb,Fb>`
+- `CGAL::Triangulation_data_structure_2<VertexBase,FaceBase>`
 - `CGAL::Triangulation_ds_face_base_2<Tds>`
 - `CGAL::Triangulation_ds_vertex_base_2<Tds>`
 

TDS_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h

@@ -15,21 +15,17 @@ see below). The class may offer some
 flexibility for the choice of container in the future, in the form of 
 additional template parameters. 
 
-\cgalHeading{Parameters}
+\tparam VertexBase must be a model of `TriangulationDSVertexBase_3`. The default is `Triangulation_ds_vertex_base_3<TDS>`.
 
-It is parameterized by base classes for vertices and cells which have to match 
+\tparam CellBase  must be a model of `TriangulationDSCellBase_3`. The default is `Triangulation_ds_cell_base_3<TDS>`.
-the requirements for the concepts `TriangulationDSCellBase_3` and 
-`TriangulationDSVertexBase_3` respectively. 
 
-They have the default values `Triangulation_ds_vertex_base_3<TDS>` and 
-`Triangulation_ds_cell_base_3<TDS>` respectively. 
 
-The `Concurrency_tag` parameter allows to enable the use of a concurrent
+\tparam ConcurrencyTag enables the use of a concurrent
 container to store vertices and cells. It can be `Sequential_tag` (use of a 
 `Compact_container` to store vertices and cells) or `Parallel_tag` 
 (use of a `Concurrent_compact_container`). If it is 
 `Parallel_tag`, the following functions can be called concurrently:
-`create_vertex`, `create_cell`, `delete_vertex`, `delete_cell`.
+`create_vertex()`, `create_cell()`, `delete_vertex()`, and `delete_cell()`.
 `Sequential_tag` is the default value.
 
 \cgalModels `TriangulationDataStructure_3`
@@ -45,9 +41,9 @@ specified by the concept.
 \sa `CGAL::Triangulation_vertex_base_with_info_3` 
 \sa `CGAL::Triangulation_cell_base_with_info_3` 
 */
-template< typename TriangulationDSVertexBase_3, 
+template< typename VertexBase, 
-          typename TriangulationDSCellBase_3,
+          typename CellBase,
-          typename Concurrency_tag >
+          typename ConcurrencyTag >
 class Triangulation_data_structure_3 : public CGAL::Triangulation_utils_3 {
 public:
 
@@ -55,13 +51,13 @@ public:
 /// @{
 
 /*!
-Vertex container type. If Concurrency_tag is Parallel_tag, a
+Vertex container type. If `ConcurrencyTag` is `Parallel_tag`, a
 `Concurrent_compact_container` is used instead of a `Compact_container`.
 */ 
 typedef Compact_container<Vertex, Default> Vertex_range; 
 
 /*!
-Cell container type. If Concurrency_tag is Parallel_tag, a
+Cell container type. If `ConcurrencyTag` is `Parallel_tag`, a
 `Concurrent_compact_container` is used instead of a `Compact_container`.
 */ 
 typedef Compact_container<Cell, Default> Cell_range; 

TDS_3/doc/TDS_3/PackageDescription.txt

@@ -56,7 +56,7 @@ Section  \ref TDS3secintro.)
 
 \cgalCRPSection{Classes}
 
-- `CGAL::Triangulation_data_structure_3<TriangulationDSVertexBase_3,TriangulationDSCellBase_3,Vertex_container_strategy,Cell_container_strategy,Concurrency_tag>` is a model for the concept of the 3D-triangulation data structure `TriangulationDataStructure_3`. It is templated by base classes for vertices and cells.
+- `CGAL::Triangulation_data_structure_3<VertexBase,CellBase,ConcurrencyTag>` is a model for the concept of the 3D-triangulation data structure `TriangulationDataStructure_3`. It is templated by base classes for vertices and cells.
 
 \cgal provides base vertex classes and base cell classes:
 

TDS_3/doc/TDS_3/TriangulationDS_3.txt

@@ -304,10 +304,10 @@ typedef Triangulation_vertex_base_3<GT, Vb2> Other;
 \subsection tds3parallel Parallel Operations
 
 The third template parameter of `Triangulation_data_structure_3` is 
-`Concurrency_tag`. It enables the use of a concurrent
+`ConcurrencyTag`. It enables the use of a concurrent
 container (`Concurrent_compact_container`) to store vertices and cells. 
-If it is `Parallel_tag`, then `create_vertex`, `create_cell`, `delete_vertex` 
+If it is `Parallel_tag`, then `create_vertex()`, `create_cell()`, `delete_vertex()` 
-and `delete_cell` can be called concurrently.
+and `delete_cell()` can be called concurrently.
 
 \section TDS3secexamples Examples