From 0b0e7a7890505a459ebb745df353ee1fb38908da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 30 Dec 2019 18:25:33 +0100 Subject: [PATCH] Document the Vertex/Cell types in the doc of CGAL::TDS_3 (the model) --- .../CGAL/Triangulation_data_structure_3.h | 25 ++++++++++++++----- 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/TDS_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h b/TDS_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h index 49bcbed73b4..68b5d9f74a0 100644 --- a/TDS_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h +++ b/TDS_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h @@ -33,23 +33,32 @@ container to store vertices and cells. It can be `Sequential_tag` (use of a The base class `Triangulation_utils_3` defines basic computations on indices of vertices and neighbors of cells. -\attention All members listed here are additional to the interface -specified by the concept. - \sa `CGAL::Triangulation_ds_vertex_base_3` \sa `CGAL::Triangulation_ds_cell_base_3` -\sa `CGAL::Triangulation_vertex_base_with_info_3` -\sa `CGAL::Triangulation_cell_base_with_info_3` */ template< typename VertexBase, typename CellBase, typename ConcurrencyTag > -class Triangulation_data_structure_3 : public CGAL::Triangulation_utils_3 { +class Triangulation_data_structure_3 + : public CGAL::Triangulation_utils_3 +{ public: /// \name Types /// @{ +typedef Triangulation_data_structure_2 Tds; + +/// The vertex type. +/// +/// \sa Section \ref tds3cyclic +typedef typename VertexBase::template Rebind_TDS::Other Vertex; + +/// The face type. +/// +/// \sa Section \ref tds3cyclic +typedef typename CellBase::template Rebind_TDS::Other Cell; + /*! Vertex container type. If `ConcurrencyTag` is `Parallel_tag`, a `Concurrent_compact_container` is used instead of a `Compact_container`. @@ -64,6 +73,10 @@ typedef Compact_container Cell_range; /// @} /// \name Operations +/// +/// In addition to the interface documented in the concept, +/// the class offers the following functions. +/// /// @{ /*!