From ee1183f8b5a87f3f019b247ba3de10a683fa682a Mon Sep 17 00:00:00 2001 From: Clement Jamin Date: Mon, 31 Mar 2014 19:38:56 +0200 Subject: [PATCH] Doc fixes according to Mariette's review --- .../doc/Triangulation/CGAL/Triangulation.h | 10 ++- .../CGAL/Triangulation_data_structure.h | 16 +--- .../Concepts/DelaunayTriangulationTraits.h | 12 ++- .../doc/Triangulation/Concepts/FullCellData.h | 40 ++++++++++ .../Concepts/TriangulationDSFace.h | 15 +++- .../Concepts/TriangulationDSFullCell.h | 33 +++++--- .../Concepts/TriangulationDSVertex.h | 29 ++++--- .../Concepts/TriangulationDataStructure.h | 6 ++ .../Concepts/TriangulationTraits.h | 79 ++++++++----------- .../doc/Triangulation/PackageDescription.txt | 20 ++--- .../include/CGAL/Triangulation_ds_full_cell.h | 2 + .../include/CGAL/Triangulation_ds_vertex.h | 5 +- .../include/CGAL/Triangulation_face.h | 1 + 13 files changed, 164 insertions(+), 104 deletions(-) create mode 100644 Triangulation/doc/Triangulation/Concepts/FullCellData.h diff --git a/Triangulation/doc/Triangulation/CGAL/Triangulation.h b/Triangulation/doc/Triangulation/CGAL/Triangulation.h index ff09454570b..9c7bdbce752 100644 --- a/Triangulation/doc/Triangulation/CGAL/Triangulation.h +++ b/Triangulation/doc/Triangulation/CGAL/Triangulation.h @@ -4,10 +4,14 @@ namespace CGAL { /*! \ingroup PkgTriangulations +\cgalModifBegin The class `Triangulation` is used to store and query the full cells and vertices of -a triangulationin dimension \f$ d\f$. A special vertex, named +a triangulationin dimension \f$ d\f$(see the +\ref Chapter_Triangulations "User Manual" for +a definition of "triangulation"). A special vertex, named infinite vertex, is used to triangulate the outside of the convex hull of the points in so called infinite cells. +\cgalModifEnd Parameters -------------- @@ -55,7 +59,7 @@ A point in Euclidean space. typedef TriangulationTraits::Point_d Point; /*! -This indicates whether the dimension of the underlying space is static +This indicates whether the maximal dimension is static (i.e.\ if the type of `Maximal_dimension` is `CGAL::Dimension_tag`) or dynamic (i.e.\ if the type of `Maximal_dimension` is `CGAL::Dynamic_dimension_tag`). @@ -542,7 +546,7 @@ to the newly created full cells are output in the `out` output iterator. interior and not contain any vertex all of whose incident full cells are in \f$C\f$ . (This implies that `t.current_dimension()`\f$ \geq 2\f$ if \f$|C|>1\f$ .) The boundary of \f$C\f$ must be a triangulation of the sphere -\f$ \mathcal S ^k-1\f$. +\f$ \mathcal S ^d-1\f$. \cgalAdvancedEnd */ template < typename ForwardIterator, typename OutputIterator > diff --git a/Triangulation/doc/Triangulation/CGAL/Triangulation_data_structure.h b/Triangulation/doc/Triangulation/CGAL/Triangulation_data_structure.h index a1ae58c3273..7183e779549 100644 --- a/Triangulation/doc/Triangulation/CGAL/Triangulation_data_structure.h +++ b/Triangulation/doc/Triangulation/CGAL/Triangulation_data_structure.h @@ -5,16 +5,16 @@ namespace CGAL { \ingroup PkgTriangulations This class is used for storing the combinatorial information of a triangulation -of dimension \f$ k\leq d\f$. +of dimension \f$ d\leq D\f$ (`D` is the maximal dimension). Parameters -------------- `Dimensionality` can be either