From bd923feda7378230f422b7b3a6faa849bfe0f57c Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Fri, 25 Mar 2016 09:46:16 +0100 Subject: [PATCH] Document Default in the 3D triangulations --- .../doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h | 5 +++-- .../doc/Triangulation_3/CGAL/Regular_triangulation_3.h | 3 ++- Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h | 3 ++- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h index 7f3c6ac23d2..964feee468e 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h @@ -11,7 +11,8 @@ Delaunay triangulation. \tparam TriangulationDataStructure_3 is the triangulation data structure. It has the default value `Triangulation_data_structure_3, - Delaunay_triangulation_cell_base_3 >`. + Delaunay_triangulation_cell_base_3 >`. +`Default` may be used. \tparam LocationPolicy is a tag which must be a `Location_policy`: either `Fast_location` or `Compact_location`. @@ -35,7 +36,7 @@ manual \ref Triangulation3exfastlocation. \tparam SurjectiveLockDataStructure is an optional parameter to specify the type of the spatial lock data structure. It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when - TriangulationDataStructure_3::Concurrency_tag is Parallel_tag). + `TriangulationDataStructure_3::Concurrency_tag` is `Parallel_tag`). It must be a model of the `SurjectiveLockDataStructure` concept, with `Object` being a `Point`. The default value is `Spatial_lock_grid_3` if diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h index caa38ad1f8e..cbbd63cf678 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h @@ -31,10 +31,11 @@ of all simplices are regular. \tparam TriangulationDataStructure_3 is the triangulation data structure. It has the default value `Triangulation_data_structure_3, Regular_triangulation_cell_base_3 >`. +`Default` may be used. \tparam SurjectiveLockDataStructure is an optional parameter to specify the type of the spatial lock data structure. It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when - TriangulationDataStructure_3::Concurrency_tag is Parallel_tag). + `TriangulationDataStructure_3::Concurrency_tag` is `Parallel_tag`). It must be a model of the `SurjectiveLockDataStructure` concept, with `Object` being a `Point`. The default value is `Spatial_lock_grid_3` if diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h index 17a955fe9d4..4e756cdc279 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h @@ -11,10 +11,11 @@ of points. \tparam TriangulationDataStructure_3 is the triangulation data structure. It has the default value `Triangulation_data_structure_3< Triangulation_vertex_base_3,Triangulation_cell_base_3 >`. +`Default` may be used. \tparam SurjectiveLockDataStructure is an optional parameter to specify the type of the spatial lock data structure. It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when - TriangulationDataStructure_3::Concurrency_tag is Parallel_tag). + `TriangulationDataStructure_3::Concurrency_tag` is `Parallel_tag`). It must be a model of the `SurjectiveLockDataStructure` concept, with `Object` being a `Point`. The default value is `Spatial_lock_grid_3` if