diff --git a/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h index 1219e414c33..9a82d7e8ece 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Domains The class `Implicit_mesh_domain_3` implements a domain whose bounding surface is described diff --git a/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h index 4555d4bf79d..d013010e160 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Domains The class `Labeled_image_mesh_domain_3` implements a domain described by a 3D labeled image. A 3D labeled image is a grid of voxels, where each voxel is associated with an index diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h index 2f1b65cad01..74038e32f1b 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3MeshClasses The class `Mesh_cell_base_3` is a model of the concept `MeshCellBase_3`. It is designed to serve as cell base class for the 3D triangulation diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h index bb70c32b212..13e1592f2d2 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3MeshClasses The class `Mesh_cell_criteria_3` is a model of `MeshCellCriteria_3`. It provides, for the mesh tetrahedra, diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h index 627753e8863..850b5e32a81 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3MeshClasses The class `Mesh_complex_3_in_triangulation_3` implements a data structure to store the 3D restricted Delaunay triangulation used by a mesh diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h index cf6aa872dd9..654009c947b 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Domains The class `Mesh_constant_domain_field_3` is a model of concept `MeshDomainField_3`. It provides a constant field accessible using queries on 3D-points. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h index 35b720b7dde..dfa5726cbb2 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3MeshClasses The class `Mesh_criteria_3` is a model of both concepts `MeshCriteria_3` and `MeshCriteriaWithFeatures_3`. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h index fb5ca545746..77b562eec8e 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Domains The class `Mesh_domain_with_polyline_features_3` is designed to allow the user to add some 0- and 1-dimensional diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h index 46bd70aedff..ab38e69c7b3 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3MeshClasses The function object class `Mesh_edge_criteria_3` is a model of `MeshEdgeCriteria_3`. It provides a bound for the size criterion. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h index 4614112bb5a..9c20dcbaeff 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3MeshClasses The class `Mesh_facet_criteria_3` is a model of `MeshFacetCriteria_3`. It provides a uniform bound for the shape criterion, diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_polyhedron_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_polyhedron_3.h index e6690362838..e6ae758fab5 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_polyhedron_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_polyhedron_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Domains The class `Mesh_polyhedron_3` provides a customized `CGAL::Polyhedron_3` type. This type uses as `PolyhedronItems_3` a customized type which adds data to the Vertex, Face and diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_triangulation_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_triangulation_3.h index bd12ef845c8..8b695a882ff 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_triangulation_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_triangulation_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3MeshClasses The class `Mesh_triangulation_3` provides a default triangulation to be used as the 3D triangulation of a mesh generation process. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_vertex_base_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_vertex_base_3.h index 5a09c3bf48f..3916b67302d 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_vertex_base_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_vertex_base_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3MeshClasses The class `Mesh_vertex_base_3` is a model of the concept `MeshVertexBase_3`. It is designed to serve as vertex base class for the 3D triangulation diff --git a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h index 00346d362eb..0ffb63500eb 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Domains The class `Polyhedral_mesh_domain_3` implements a domain whose boundary is a simplicial polyhedral surface. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h index d9398f3ce5a..5c888959d5d 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Domains The class `Polyhedral_mesh_domain_with_features_3` implements a domain whose boundary is a simplicial polyhedral surface. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h b/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h index 1be78440cc4..1ec8496f168 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Domains The class `Triangle_accessor_3` is a model for the concept `TriangleAccessor_3`. It is designed to serve as accessor for objects of type `CGAL::Polyhedron_3`. diff --git a/Mesh_3/doc/Mesh_3/CGAL/exude_mesh_3.h b/Mesh_3/doc/Mesh_3/CGAL/exude_mesh_3.h index 7cebe2bbedc..4d4a1c80bdb 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/exude_mesh_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/exude_mesh_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Functions The function `exude_mesh_3` performs a sliver exudation process on a Delaunay mesh. diff --git a/Mesh_3/doc/Mesh_3/CGAL/lloyd_optimize_mesh_3.h b/Mesh_3/doc/Mesh_3/CGAL/lloyd_optimize_mesh_3.h index 545e3e51380..7bfeb0486b5 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/lloyd_optimize_mesh_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/lloyd_optimize_mesh_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Functions The function `lloyd_optimize_mesh_3` is a mesh optimization process based on the minimization of a global energy function. diff --git a/Mesh_3/doc/Mesh_3/CGAL/make_mesh_3.h b/Mesh_3/doc/Mesh_3/CGAL/make_mesh_3.h index 022b9dc8b86..a501bf779af 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/make_mesh_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/make_mesh_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Functions The function `make_mesh_3` is a 3D mesh generator. It produces simplicial meshes which discretize diff --git a/Mesh_3/doc/Mesh_3/CGAL/odt_optimize_mesh_3.h b/Mesh_3/doc/Mesh_3/CGAL/odt_optimize_mesh_3.h index b8610560afb..56cf60eb0b6 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/odt_optimize_mesh_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/odt_optimize_mesh_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Functions The function `odt_optimize_mesh_3` is a mesh optimization process based on the minimization of a global energy function. diff --git a/Mesh_3/doc/Mesh_3/CGAL/perturb_mesh_3.h b/Mesh_3/doc/Mesh_3/CGAL/perturb_mesh_3.h index cadec0b5d66..76a09208ef1 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/perturb_mesh_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/perturb_mesh_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Functions The function `perturb_mesh_3` is a mesh optimizer that improves the quality of a Delaunay mesh diff --git a/Mesh_3/doc/Mesh_3/CGAL/refine_mesh_3.h b/Mesh_3/doc/Mesh_3/CGAL/refine_mesh_3.h index 16aa8146b81..9c91add288f 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/refine_mesh_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/refine_mesh_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Functions The function `refine_mesh_3` is a 3D mesh generator. It produces simplicial meshes which discretize @@ -152,7 +152,7 @@ parameters::internal::Exude_options exude = parameters::exude()); namespace parameters { /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Parameters The function `parameters::exude` allows the user to trigger a call to `exude_mesh_3` in the `make_mesh_3` and `refine_mesh_3` mesh generation functions. @@ -188,7 +188,7 @@ parameters::internal::Exude_options exude( double parameters::sliver_bound = 0); /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Parameters The function `parameters::features` provides a value of internal type `Features` to specify if \f$ 0\f$ and \f$ 1\f$-dimensional features have to be taken into account. @@ -215,7 +215,7 @@ template Features features(MeshDomain_3 domain); /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Parameters The function `parameters::lloyd` allows the user to trigger a call of `lloyd_optimize_mesh_3` in the mesh generation functions @@ -254,7 +254,7 @@ double parameters::convergence = 0.02, double parameters::freeze_bound = 0.01); /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Parameters The function `parameters::no_exude` allows the user to tell the mesh generation functions `make_mesh_3` and `refine_mesh_3` that no exudation must be done. @@ -278,7 +278,7 @@ C3t3 c3t3 = make_mesh_3(domain, criteria, parameters::no_exude()); parameters::internal::Exude_options no_exude(); /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Parameters The function `parameters::no_features` allows the user to prevent the handling of \f$ 0\f$ and \f$ 1\f$ dimensional features. This is useful when the @@ -298,7 +298,7 @@ to take into account \f$ 0\f$ and \f$ 1\f$-dimensional input features. Features no_features(); /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Parameters The function `parameters::no_lloyd` allows the user to tell the mesh generation functions `make_mesh_3` and `refine_mesh_3` that no lloyd optimization must be done. @@ -322,7 +322,7 @@ C3t3 c3t3 = make_mesh_3(domain, criteria, parameters::no_lloyd()); parameters::internal::Lloyd_options no_lloyd(); /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Parameters The function `parameters::no_odt` allows the user to tell the mesh generation functions `make_mesh_3` and `refine_mesh_3` that no odt optimization must be done. @@ -346,7 +346,7 @@ C3t3 c3t3 = make_mesh_3(domain, criteria, parameters::no_odt()); parameters::internal::Odt_options no_odt(); /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Parameters The function `parameters::no_perturb` allows the user to tell mesh generation global functions `make_mesh_3` and `refine_mesh_3` that no perturbation must be done. @@ -375,7 +375,7 @@ C3t3 c3t3 = make_mesh_3(domain, criteria, parameters::no_perturb()); parameters::internal::Perturb_options no_perturb(); /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Parameters The function `parameters::odt` allows the user to trigger a call to `odt_optimize_mesh_3` in @@ -414,7 +414,7 @@ double parameters::convergence = 0.02, double parameters::freeze_bound = 0.01); /*! -\ingroup PkgMesh_3 +\ingroup PkgMesh_3Parameters The function `parameters::perturb` allows the user to trigger a call to `perturb_mesh_3` in diff --git a/Mesh_3/doc/Mesh_3/PackageDescription.txt b/Mesh_3/doc/Mesh_3/PackageDescription.txt index d143ff2e2b2..bcb80290c48 100644 --- a/Mesh_3/doc/Mesh_3/PackageDescription.txt +++ b/Mesh_3/doc/Mesh_3/PackageDescription.txt @@ -3,6 +3,27 @@ /// \defgroup PkgMesh_3Concepts Concepts /// \ingroup PkgMesh_3 +/// \defgroup PkgMesh_3SecondaryConcepts Secondary Concepts +/// \ingroup PkgMesh_3 + + + +/// \defgroup PkgMesh_3MeshClasses Mesh Classes +/// \ingroup PkgMesh_3 + + +/// \defgroup PkgMesh_3Domains Domains +/// \ingroup PkgMesh_3 + +/// \defgroup PkgMesh_3Functions Mesh Generation Functions +/// \ingroup PkgMesh_3 + + +/// \defgroup PkgMesh_3Parameters Parameter Functions +/// \ingroup PkgMesh_3 + + + /*! \addtogroup PkgMesh_3 \todo check generated documentation