From 607ada33ea714e67f50487876319dbafb953f700 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Wed, 14 May 2025 09:48:44 +0100 Subject: [PATCH 01/16] Polygon: prefix functions with CGAL::IO --- Polygon/include/CGAL/General_polygon_with_holes_2.h | 4 ++-- Polygon/include/CGAL/Polygon_with_holes_2.h | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Polygon/include/CGAL/General_polygon_with_holes_2.h b/Polygon/include/CGAL/General_polygon_with_holes_2.h index 90b3bca3b48..097db4ada45 100644 --- a/Polygon/include/CGAL/General_polygon_with_holes_2.h +++ b/Polygon/include/CGAL/General_polygon_with_holes_2.h @@ -148,8 +148,8 @@ protected: This operator exports a `General_polygon_with_holes_2` to the output stream `os`. An \ascii and a binary format exist. The format can be selected with -the \cgal modifiers for streams, `set_ascii_mode()` and `set_binary_mode()`, -respectively. The modifier `set_pretty_mode()` can be used to allow for (a +the \cgal modifiers for streams, `GAL::IO::set_ascii_mode()` and `GAL::IO::set_binary_mode()`, +respectively. The modifier `GAL::IO::set_pretty_mode()` can be used to allow for (a few) structuring comments in the output. Otherwise, the output would be free of comments. The default for writing is \ascii without comments. diff --git a/Polygon/include/CGAL/Polygon_with_holes_2.h b/Polygon/include/CGAL/Polygon_with_holes_2.h index 7d581a28150..23dbb43b4b0 100644 --- a/Polygon/include/CGAL/Polygon_with_holes_2.h +++ b/Polygon/include/CGAL/Polygon_with_holes_2.h @@ -111,8 +111,8 @@ public: This operator exports a polygon with holes to the output stream `os`. An \ascii and a binary format exist. The format can be selected with -the \cgal modifiers for streams, `set_ascii_mode()` and `set_binary_mode()`, -respectively. The modifier `set_pretty_mode()` can be used to allow for (a +the \cgal modifiers for streams, `CGAL::IO::set_ascii_mode()` and `GAL::IO::set_binary_mode()`, +respectively. The modifier `GAL::IO::set_pretty_mode()` can be used to allow for (a few) structuring comments in the output. Otherwise, the output would be free of comments. The default for writing is \ascii without comments. From ad917a942172344668064ed32a5ad16fda8a2913 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Thu, 15 May 2025 07:44:00 +0200 Subject: [PATCH 02/16] Apply suggestions from code review Co-authored-by: Laurent Rineau --- Polygon/include/CGAL/General_polygon_with_holes_2.h | 4 ++-- Polygon/include/CGAL/Polygon_with_holes_2.h | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Polygon/include/CGAL/General_polygon_with_holes_2.h b/Polygon/include/CGAL/General_polygon_with_holes_2.h index 097db4ada45..fb55b75c79e 100644 --- a/Polygon/include/CGAL/General_polygon_with_holes_2.h +++ b/Polygon/include/CGAL/General_polygon_with_holes_2.h @@ -148,8 +148,8 @@ protected: This operator exports a `General_polygon_with_holes_2` to the output stream `os`. An \ascii and a binary format exist. The format can be selected with -the \cgal modifiers for streams, `GAL::IO::set_ascii_mode()` and `GAL::IO::set_binary_mode()`, -respectively. The modifier `GAL::IO::set_pretty_mode()` can be used to allow for (a +the \cgal modifiers for streams, `CGAL::IO::set_ascii_mode()` and `CGAL::IO::set_binary_mode()`, +respectively. The modifier `CGAL::IO::set_pretty_mode()` can be used to allow for (a few) structuring comments in the output. Otherwise, the output would be free of comments. The default for writing is \ascii without comments. diff --git a/Polygon/include/CGAL/Polygon_with_holes_2.h b/Polygon/include/CGAL/Polygon_with_holes_2.h index 23dbb43b4b0..84451adf2a7 100644 --- a/Polygon/include/CGAL/Polygon_with_holes_2.h +++ b/Polygon/include/CGAL/Polygon_with_holes_2.h @@ -111,8 +111,8 @@ public: This operator exports a polygon with holes to the output stream `os`. An \ascii and a binary format exist. The format can be selected with -the \cgal modifiers for streams, `CGAL::IO::set_ascii_mode()` and `GAL::IO::set_binary_mode()`, -respectively. The modifier `GAL::IO::set_pretty_mode()` can be used to allow for (a +the \cgal modifiers for streams, `CGAL::IO::set_ascii_mode()` and `CGAL::IO::set_binary_mode()`, +respectively. The modifier `CGAL::IO::set_pretty_mode()` can be used to allow for (a few) structuring comments in the output. Otherwise, the output would be free of comments. The default for writing is \ascii without comments. From e2058c01c615ddeef0ead216c3276ed26d286b3e Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Thu, 15 May 2025 07:28:31 +0100 Subject: [PATCH 03/16] Remove some hyphens --- .../Advancing_front_surface_reconstruction.txt | 2 +- .../CGAL/Advancing_front_surface_reconstruction.h | 4 ++-- .../CGAL/Alpha_wrap_3/internal/Alpha_wrap_3.h | 2 +- .../Boolean_set_operations_2/Gps_bfs_xor_visitor.h | 2 +- .../Tutorials/Tutorial_reconstruction.txt | 2 +- Documentation/doc/scripts/test_doxygen_versions.sh | 2 +- Jet_fitting_3/doc/Jet_fitting_3/Jet_fitting_3.txt | 2 +- Mesh_3/include/CGAL/Labeled_mesh_domain_3.h | 2 +- .../Poisson_surface_reconstruction_3.txt | 4 ++-- .../Scale_space_reconstruction_3.txt | 4 ++-- .../Set_movable_separability_2.txt | 2 +- .../CGAL/Polygon_mesh_processing/region_growing.h | 4 ++-- .../Shape_regularization/Shape_regularization.txt | 2 +- .../ARAP_parameterizer_3.h | 2 +- .../Surface_Mesh_Segmentation.txt | 14 +++++++------- .../internal/Surface_mesh_segmentation.h | 4 ++-- .../include/CGAL/mesh_segmentation.h | 8 ++++---- .../Tetrahedral_remeshing.txt | 2 +- .../CGAL/Rotational_sweep_visibility_2.h | 2 +- .../CGAL/Simple_polygon_visibility_2.h | 2 +- 20 files changed, 34 insertions(+), 34 deletions(-) diff --git a/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/Advancing_front_surface_reconstruction.txt b/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/Advancing_front_surface_reconstruction.txt index 90502e1bdf6..515d0b4054b 100644 --- a/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/Advancing_front_surface_reconstruction.txt +++ b/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/Advancing_front_surface_reconstruction.txt @@ -49,7 +49,7 @@ We describe next the algorithm and provide examples. \note A \ref tuto_reconstruction "detailed tutorial on surface reconstruction" is provided with a guide to choose the most appropriate method along -with pre- and post-processing. +with pre- and postprocessing. \section AFSR_Definitions Definitions and the Algorithm diff --git a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction.h b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction.h index b91a7d0f5ec..f5a16e14402 100644 --- a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction.h +++ b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction.h @@ -382,7 +382,7 @@ namespace CGAL { int _facet_number; //--------------------------------------------------------------------- - // For post-processing + // For postprocessing mutable int _postprocessing_counter; int _size_before_postprocessing; @@ -2432,7 +2432,7 @@ namespace CGAL { std::size_t itmp, L_v_size_mem; L_v_size_mem = L_v.size(); - if ((vh_on_border_inserted != 0)&& // to post-process only the borders + if ((vh_on_border_inserted != 0)&& // to postprocess only the borders (L_v.size() < .1 * _size_before_postprocessing)) { { diff --git a/Alpha_wrap_3/include/CGAL/Alpha_wrap_3/internal/Alpha_wrap_3.h b/Alpha_wrap_3/include/CGAL/Alpha_wrap_3/internal/Alpha_wrap_3.h index d61154a9747..057e015158b 100644 --- a/Alpha_wrap_3/include/CGAL/Alpha_wrap_3/internal/Alpha_wrap_3.h +++ b/Alpha_wrap_3/include/CGAL/Alpha_wrap_3/internal/Alpha_wrap_3.h @@ -348,7 +348,7 @@ public: #ifdef CGAL_AW3_TIMER t.stop(); - std::cout << "Manifoldness post-processing took: " << t.time() << " s." << std::endl; + std::cout << "Manifoldness postprocessing took: " << t.time() << " s." << std::endl; t.reset(); t.start(); #endif diff --git a/Boolean_set_operations_2/include/CGAL/Boolean_set_operations_2/Gps_bfs_xor_visitor.h b/Boolean_set_operations_2/include/CGAL/Boolean_set_operations_2/Gps_bfs_xor_visitor.h index d716452220e..591113740d9 100644 --- a/Boolean_set_operations_2/include/CGAL/Boolean_set_operations_2/Gps_bfs_xor_visitor.h +++ b/Boolean_set_operations_2/include/CGAL/Boolean_set_operations_2/Gps_bfs_xor_visitor.h @@ -52,7 +52,7 @@ public: return (ic % 2) == 1; } - //! after_scan post-processing after bfs scan. + //! after_scan postprocessing after bfs scan. /*! The function fixes some of the curves, to be in the same direction as the half-edges. diff --git a/Documentation/doc/Documentation/Tutorials/Tutorial_reconstruction.txt b/Documentation/doc/Documentation/Tutorials/Tutorial_reconstruction.txt index 8fbc5618881..be563e0d919 100644 --- a/Documentation/doc/Documentation/Tutorials/Tutorial_reconstruction.txt +++ b/Documentation/doc/Documentation/Tutorials/Tutorial_reconstruction.txt @@ -255,7 +255,7 @@ through the points. Each of these methods produce a triangle mesh stored in different ways. If this output mesh is hampered by defects such as holes or -self-intersections, \cgal provide several algorithms to post-process +self-intersections, \cgal provide several algorithms to postprocess it (hole filling, remeshing, etc.) in the package \ref PkgPolygonMeshProcessing "Polygon Mesh Processing". We do not discuss these functions here as there are many diff --git a/Documentation/doc/scripts/test_doxygen_versions.sh b/Documentation/doc/scripts/test_doxygen_versions.sh index c847e110a2d..56b10538a33 100644 --- a/Documentation/doc/scripts/test_doxygen_versions.sh +++ b/Documentation/doc/scripts/test_doxygen_versions.sh @@ -91,7 +91,7 @@ else bash -$- ./compare_testsuites.sh $PWD/build_doc/doc_output $PWD/doc_ref 1> /dev/null fi echo "done." -#add post-processing +#add postprocessing cd ./build_doc echo "Adding postprocessing..." make -j$NB_CORES doc_with_postprocessing &>> ./build_logs diff --git a/Jet_fitting_3/doc/Jet_fitting_3/Jet_fitting_3.txt b/Jet_fitting_3/doc/Jet_fitting_3/Jet_fitting_3.txt index 991d49026dc..605d045b85f 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Jet_fitting_3.txt +++ b/Jet_fitting_3/doc/Jet_fitting_3/Jet_fitting_3.txt @@ -280,7 +280,7 @@ computed using rings on the triangulation. Results are twofold: numerical information on the computation: condition number and the PCA basis;
  • another text file that records raw data (better for a visualization -post-processing). +postprocessing). \cgalFigureRef{figjet3figdavid} and diff --git a/Mesh_3/include/CGAL/Labeled_mesh_domain_3.h b/Mesh_3/include/CGAL/Labeled_mesh_domain_3.h index a9284359d4a..316454d45a5 100644 --- a/Mesh_3/include/CGAL/Labeled_mesh_domain_3.h +++ b/Mesh_3/include/CGAL/Labeled_mesh_domain_3.h @@ -656,7 +656,7 @@ public: * \cgalParamExtra{The return type of the function depends on whether this parameter * or `input_features` are provided or not.} * \cgalParamExtra{If `weights` is provided, it must either be adapted to the detected features, - * or post-processed during feature detection to keep consistency + * or postprocessed during feature detection to keep consistency * of the output `MeshDomainWithFeatures_3`. * Available functors implement the necessary modifications.} * \cgalParamNEnd diff --git a/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/Poisson_surface_reconstruction_3.txt b/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/Poisson_surface_reconstruction_3.txt index bbdee6e662e..d63bf625e67 100644 --- a/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/Poisson_surface_reconstruction_3.txt +++ b/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/Poisson_surface_reconstruction_3.txt @@ -29,7 +29,7 @@ solving for the implicit function before function evaluation. \note A \ref tuto_reconstruction "detailed tutorial on surface reconstruction" is provided with a guide to choose the most appropriate method along -with pre- and post-processing. +with pre- and postprocessing. \section Poisson_surface_reconstruction_3Common Common Reconstruction Pipeline @@ -45,7 +45,7 @@ and 6) Surface reconstruction. \cgal provides algorithms for all steps listed above except alignment. Chapter \ref chappoint_set_processing_3 "Point Set Processing" -describes algorithms to pre-process the point set before +describes algorithms to preprocess the point set before reconstruction with functions devoted to the simplification, outlier removal, smoothing, normal estimation and normal orientation. diff --git a/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/Scale_space_reconstruction_3.txt b/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/Scale_space_reconstruction_3.txt index 0a7abd096bd..08f50790985 100644 --- a/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/Scale_space_reconstruction_3.txt +++ b/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/Scale_space_reconstruction_3.txt @@ -19,7 +19,7 @@ A triangulated surface mesh is generated by first computing the point set at a c \note A \ref tuto_reconstruction "detailed tutorial on surface reconstruction" is provided with a guide to choose the most appropriate method along -with pre- and post-processing. +with pre- and postprocessing. \section ScaleSpaceReconstruction3secMethod Scale-Space @@ -92,7 +92,7 @@ The surface mesh constructed at scale \f$ s \f$ is non-self-intersecting. The in The surface mesh will not have edges incident to only one triangle or holes, loops of such edges, and the triangles are all oriented away from the point set. If the point set has holes, it is likely that the surface mesh will contain overlapping triangles with opposite orientation touching this hole. -An additional treatment can be applied to force the output surface to be 2-manifold: small flat volumes are found before reconstructing and the surface is forced to only use one side of the volume while keeping consistency with the adjacent singular facets. Only one side of each singular facet is used. In addition, non-manifold edges and vertices are removed as a post-processing. The facets that have been discarded to make the surface 2-manifold are stored and accessible. +An additional treatment can be applied to force the output surface to be 2-manifold: small flat volumes are found before reconstructing and the surface is forced to only use one side of the volume while keeping consistency with the adjacent singular facets. Only one side of each singular facet is used. In addition, non-manifold edges and vertices are removed as a postprocessing. The facets that have been discarded to make the surface 2-manifold are stored and accessible. If the object is not densely sampled or has disconnected components, the reconstructed surface may have several disconnected components. The surface is either an unordered collection of triangles, or the same collection sorted per \em shell. A shell is a collection of connected triangles that are locally oriented towards the same side of the surface. diff --git a/Set_movable_separability_2/doc/Set_movable_separability_2/Set_movable_separability_2.txt b/Set_movable_separability_2/doc/Set_movable_separability_2/Set_movable_separability_2.txt index 1fe21f70345..b14af2a62bc 100644 --- a/Set_movable_separability_2/doc/Set_movable_separability_2/Set_movable_separability_2.txt +++ b/Set_movable_separability_2/doc/Set_movable_separability_2/Set_movable_separability_2.txt @@ -77,7 +77,7 @@ Chapter_2D_Regularized_Boolean_Set-Operations "2D Regularized Boolean Set-Operations" for the precise definition of simple polygons. Secondly, any consecutive three vertices cannot be collinear. If you suspect that the input polygon may not satisfy the -latter condition, pre-process the polygon to eliminate this +latter condition, preprocess the polygon to eliminate this ill-condition. The implementation is based on an algorithm developed by Shamai and diff --git a/Shape_detection/include/CGAL/Polygon_mesh_processing/region_growing.h b/Shape_detection/include/CGAL/Polygon_mesh_processing/region_growing.h index d6f78085c44..1fab16df0d7 100644 --- a/Shape_detection/include/CGAL/Polygon_mesh_processing/region_growing.h +++ b/Shape_detection/include/CGAL/Polygon_mesh_processing/region_growing.h @@ -126,7 +126,7 @@ private: \cgalParamExtra{this parameter and `cosine_of_maximum_angle` are exclusive} \cgalParamNEnd \cgalParamNBegin{postprocess_regions} - \cgalParamDescription{Apply a post-processing step to the output of the region growing algorithm.} + \cgalParamDescription{Apply a postprocessing step to the output of the region growing algorithm.} \cgalParamType{`bool`} \cgalParamDefault{false} \cgalParamNEnd @@ -212,7 +212,7 @@ region_growing_of_planes_on_faces(const PolygonMesh& mesh, if (choose_parameter(get_parameter(np, internal_np::postprocess_regions), false)) { - // first try for a post-processing: look at regions made of one face and check if a + // first try for a postprocessing: look at regions made of one face and check if a // larger region contains its 3 vertices and if so assigned it to it. typedef typename boost::property_traits::value_type Id; for (std::size_t i=0; i` /// to attempt to obtain a valid final embedding. /// diff --git a/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/Surface_Mesh_Segmentation.txt b/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/Surface_Mesh_Segmentation.txt index ca138cd3e89..0e444c46dfc 100644 --- a/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/Surface_Mesh_Segmentation.txt +++ b/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/Surface_Mesh_Segmentation.txt @@ -51,9 +51,9 @@ The raw SDF values are computed through function `sdf_values()`, setting `postpr or rays that form an obtuse angle with the inward-normal of the first intersected facet are ignored. Only facets having no ray get no raw SDF values -\subsubsection Surface_mesh_segmentationPostprocessing Post-processing of Raw SDF Values +\subsubsection Surface_mesh_segmentationPostprocessing Postprocessing of Raw SDF Values After having calculated the raw SDF value for each facet, the SDF values used in the segmentation algorithm are -the result of several post-processing steps: +the result of several postprocessing steps: - Facets with no raw SDF values are assigned the average raw SDF value of their edge-adjacent neighbors. If there is still a facet having no SDF value, the minimum amongst all the SDF values is assigned to it (this is a deviation from the description of the algorithm in \cgalCite{Shapira2008Consistent}). @@ -70,7 +70,7 @@ The main reason for not assigning 0 to facets with no SDF values is that it can Large range parameters make smoothing closer to Gaussian smoothing and may also lead to over-smoothed SDF values. - SDF values are linearly normalized between [0,1]. -These post-processing steps can be applied to raw SDF values (or an alternative set of similar scalar values associated with facets) using the function `sdf_values_postprocessing()`. +These postprocessing steps can be applied to raw SDF values (or an alternative set of similar scalar values associated with facets) using the function `sdf_values_postprocessing()`. \subsection Surface_mesh_segmentationSoftClustering Soft Clustering @@ -154,11 +154,11 @@ Clusters and segments. The input number of clusters is set to 5. (a) Resu \subsection Surface_mesh_segmentationAPI Summary Four functions are provided: - - `sdf_values()` : computes the SDF value of each facet of an input mesh in either raw or post-processed form. + - `sdf_values()` : computes the SDF value of each facet of an input mesh in either raw or postprocessed form. SDF values are associated to facets using a property map (see \ref Chapter_CGAL_and_Boost_Property_Maps "CGAL and Boost Property Maps"). - - `sdf_values_postprocessing()` : post-processes raw SDF values. The post-processing is decoupled from - the function `sdf_values()` to allow the use of alternative methods to compute SDF values or additional post-processing step. + - `sdf_values_postprocessing()` : postprocesses raw SDF values. The postprocessing is decoupled from + the function `sdf_values()` to allow the use of alternative methods to compute SDF values or additional postprocessing step. - `segmentation_from_sdf_values()` : computes the mesh segmentation from the SDF values of the facets of an input mesh. The input SDF values can be any set of scalar values associated to each facet as long as they have been normalized between 0 and 1. This function allows using the same SDF values with different parameters for the segmentation stage. @@ -188,7 +188,7 @@ This operation is reliable when the `AABBTraits` model provided has exact predic \cgalExample{Surface_mesh_segmentation/segmentation_from_sdf_values_example.cpp} \subsubsection Example_3 Computation of SDF Values and Segmentation -The function `segmentation_via_sdf_values()` combines the computation of sdf values, the post-processing and the segmentation. +The function `segmentation_via_sdf_values()` combines the computation of sdf values, the postprocessing and the segmentation. Note that when computing several segmentations of a mesh with different parameters (i.e. number of levels, and smoothing lambda), it is advised to first compute the SDF values using `sdf_values()` and use them in calls of the function `segmentation_from_sdf_values()`. diff --git a/Surface_mesh_segmentation/include/CGAL/Surface_mesh_segmentation/internal/Surface_mesh_segmentation.h b/Surface_mesh_segmentation/include/CGAL/Surface_mesh_segmentation/internal/Surface_mesh_segmentation.h index eb78e5ed48d..93c14d721cf 100644 --- a/Surface_mesh_segmentation/include/CGAL/Surface_mesh_segmentation/internal/Surface_mesh_segmentation.h +++ b/Surface_mesh_segmentation/include/CGAL/Surface_mesh_segmentation/internal/Surface_mesh_segmentation.h @@ -45,7 +45,7 @@ namespace CGAL namespace internal { -// Post-process functions for sdf values +// postprocess functions for sdf values template class Postprocess_sdf_values { @@ -186,7 +186,7 @@ public: * - Expectation_maximization for soft clustering * - An implementation of alpha-expansion graph cut for hard clustering * - * Other than being a connector, it is also responsible for pre-process and postprocess on intermediate data, which are: + * Other than being a connector, it is also responsible for preprocess and postprocess on intermediate data, which are: * - log-normalizing probabilities received from soft clustering * - log-normalizing and calculating dihedral-angle based weights for edges * - smoothing and log-normalizing sdf values received from sdf calculation (Filters.h) diff --git a/Surface_mesh_segmentation/include/CGAL/mesh_segmentation.h b/Surface_mesh_segmentation/include/CGAL/mesh_segmentation.h index 411d820c0a9..98af65ee5b2 100644 --- a/Surface_mesh_segmentation/include/CGAL/mesh_segmentation.h +++ b/Surface_mesh_segmentation/include/CGAL/mesh_segmentation.h @@ -63,7 +63,7 @@ sdf_values( const TriangleMesh& triangle_mesh, * @brief Function computing the Shape Diameter Function over a surface mesh. * * This function implements the Shape Diameter Function (SDF) as described in \cgalCite{Shapira2008Consistent}. - * It is possible to compute raw SDF values (without post-processing). In such a case, + * It is possible to compute raw SDF values (without postprocessing). In such a case, * -1 is used to indicate when no SDF value could be computed for a facet. * * @pre `is_triangle_mesh(triangle_mesh)` @@ -108,12 +108,12 @@ sdf_values( const TriangleMesh& triangle_mesh, /*! * \ingroup PkgSurfaceMeshSegmentationRef - * @brief Function post-processing raw SDF values computed per facet. + * @brief Function postprocessing raw SDF values computed per facet. * - * Post-processing steps applied : + * Postprocessing steps applied : * - Facets with -1 SDF values are assigned the average SDF value of their edge-adjacent neighbors. * If there is still a facet having -1 SDF value, the minimum valid SDF value assigned to it. Note that this step is not inherited from the paper. - * The main reason for not assigning 0 to facets with no SDF values (i.e. -1) is that it can obstruct log-normalization process which takes place at the beginning of `CGAL::segmentation_from_sdf_values()`. + * The main reason for not assigning 0 to facets with no SDF values (i.e., -1) is that it can obstruct log-normalization process which takes place at the beginning of `CGAL::segmentation_from_sdf_values()`. * - SDF values are smoothed with bilateral filtering. * - SDF values are linearly normalized between [0,1]. * diff --git a/Tetrahedral_remeshing/doc/Tetrahedral_remeshing/Tetrahedral_remeshing.txt b/Tetrahedral_remeshing/doc/Tetrahedral_remeshing/Tetrahedral_remeshing.txt index 49823e27292..43d891a7574 100644 --- a/Tetrahedral_remeshing/doc/Tetrahedral_remeshing/Tetrahedral_remeshing.txt +++ b/Tetrahedral_remeshing/doc/Tetrahedral_remeshing/Tetrahedral_remeshing.txt @@ -163,7 +163,7 @@ stored as complex edges in a `Mesh_complex_3_in_triangulation_3` \subsection ssecEx4 Tetrahedral Remeshing After Mesh Generation -The tetrahedral remeshing algorithm is designed as a post-processing for +The tetrahedral remeshing algorithm is designed as a postprocessing for mesh generation algorithms. The API allows to generate a tetrahedral mesh with the \cgal \ref PkgMesh3 package, and further improve it with the tetrahedral remeshing algorithm. diff --git a/Visibility_2/doc/Visibility_2/CGAL/Rotational_sweep_visibility_2.h b/Visibility_2/doc/Visibility_2/CGAL/Rotational_sweep_visibility_2.h index fd4eb03d5ed..9b566c94de8 100644 --- a/Visibility_2/doc/Visibility_2/CGAL/Rotational_sweep_visibility_2.h +++ b/Visibility_2/doc/Visibility_2/CGAL/Rotational_sweep_visibility_2.h @@ -63,7 +63,7 @@ public: /*! Attaches the given arrangement to the visibility object. -This operation takes \cgalBigO{1} as the class does no pre-processing. +This operation takes \cgalBigO{1} as the class does no preprocessing. In case the object is already attached to another arrangement, the visibility object gets detached before being attached to `arr`. diff --git a/Visibility_2/doc/Visibility_2/CGAL/Simple_polygon_visibility_2.h b/Visibility_2/doc/Visibility_2/CGAL/Simple_polygon_visibility_2.h index e8e246b5346..41647d820c0 100644 --- a/Visibility_2/doc/Visibility_2/CGAL/Simple_polygon_visibility_2.h +++ b/Visibility_2/doc/Visibility_2/CGAL/Simple_polygon_visibility_2.h @@ -67,7 +67,7 @@ public: /*! Attaches the given arrangement to the visibility object. -This operation takes \cgalBigO{1} as the class does no pre-processing. +This operation takes \cgalBigO{1} as the class does no preprocessing. In case the object is already attached to another arrangement, the visibility object gets detached before being attached to `arr`. From 2bdeff8687e2b07c561c51fda53dd87a471077c1 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Thu, 15 May 2025 07:41:00 +0100 Subject: [PATCH 04/16] counter-clockwise -> counterclockwise --- .../Boolean_set_operations_2.txt | 2 +- .../include/CGAL/Compute_cone_boundaries_2.h | 2 +- Cone_spanners_2/include/CGAL/Construct_theta_graph_2.h | 2 +- Cone_spanners_2/include/CGAL/Construct_yao_graph_2.h | 2 +- Heat_method_3/doc/Heat_method_3/Heat_method_3.txt | 2 +- Mesh_2/include/CGAL/Mesh_2/Refine_edges_visitor.h | 2 +- Nef_2/include/CGAL/Nef_2/PM_checker.h | 4 ++-- Nef_S2/include/CGAL/Nef_S2/SM_checker.h | 4 ++-- .../CGAL/Periodic_2_Delaunay_triangulation_2.h | 2 +- .../CGAL/Hyperbolic_octagon_translation.h | 2 +- .../Periodic_4HyperbolicTriangulationFaceBase_2.h | 2 +- .../PackageDescription.txt | 2 +- Polygon_repair/doc/Polygon_repair/Polygon_repair.txt | 2 +- .../Concepts/SegmentDelaunayGraphDataStructure_2.h | 4 ++-- .../Concepts/SegmentDelaunayGraphTraits_2.h | 2 +- .../Concepts/SegmentDelaunayGraphLinfTraits_2.h | 6 +++--- .../CGAL/Polygon_offset_builder_2.h | 2 +- .../doc/Straight_skeleton_2/CGAL/Straight_skeleton_2.h | 6 +++--- .../CGAL/Straight_skeleton_builder_2.h | 2 +- .../doc/Straight_skeleton_2/Straight_skeleton_2.txt | 10 +++++----- .../File_formats/Supported_file_formats.txt | 2 +- TDS_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h | 2 +- .../CGAL/Constrained_Delaunay_triangulation_2.h | 2 +- .../Triangulation_2/CGAL/Delaunay_triangulation_2.h | 2 +- .../doc/Triangulation_2/CGAL/Regular_triangulation_2.h | 2 +- .../Triangulation_on_hyperbolic_surface_2.txt | 4 ++-- .../CGAL/Triangulation_on_hyperbolic_surface_2.h | 2 +- .../CGAL/Delaunay_triangulation_on_sphere_2.h | 2 +- .../include/CGAL/Rotational_sweep_visibility_2.h | 4 ++-- 29 files changed, 42 insertions(+), 42 deletions(-) diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt index adfd0e20e78..2a3b938bf2f 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt @@ -116,7 +116,7 @@ In our context, a polygon must uphold the following conditions:
    1. Closed Boundary - the polygon's outer boundary must be a connected sequence of curves, that start and end at the same vertex.
    2. Simplicity - the polygon must be simple. -
    3. Orientation - the polygon's outer boundary must be counter-clockwise oriented. +
    4. Orientation - the polygon's outer boundary must be counterclockwise oriented.
    \subsection bso_ssecpolygon_with_holes_validation Conditions for Valid Polygons with Holes diff --git a/Cone_spanners_2/include/CGAL/Compute_cone_boundaries_2.h b/Cone_spanners_2/include/CGAL/Compute_cone_boundaries_2.h index a4069a1168a..7a4021cfafe 100644 --- a/Cone_spanners_2/include/CGAL/Compute_cone_boundaries_2.h +++ b/Cone_spanners_2/include/CGAL/Compute_cone_boundaries_2.h @@ -137,7 +137,7 @@ public: The direction of the first ray can be specified by the parameter initial_direction, which allows the first ray to start at any direction. - The remaining directions are calculated in counter-clockwise order. + The remaining directions are calculated in counterclockwise order. \param cone_number The number of cones \param initial_direction The direction of the first ray diff --git a/Cone_spanners_2/include/CGAL/Construct_theta_graph_2.h b/Cone_spanners_2/include/CGAL/Construct_theta_graph_2.h index 5a6a73299fb..cd71ce6d04d 100644 --- a/Cone_spanners_2/include/CGAL/Construct_theta_graph_2.h +++ b/Cone_spanners_2/include/CGAL/Construct_theta_graph_2.h @@ -169,7 +169,7 @@ protected: /* Construct edges in one cone bounded by two directions. \param cwBound The direction of the clockwise boundary of the cone. - \param ccwBound The direction of the counter-clockwise boundary. + \param ccwBound The direction of the counterclockwise boundary. \param g The Theta graph to be built. */ void add_edges_in_cone(const Direction_2& cwBound, const Direction_2& ccwBound, Graph_& g) { diff --git a/Cone_spanners_2/include/CGAL/Construct_yao_graph_2.h b/Cone_spanners_2/include/CGAL/Construct_yao_graph_2.h index 58090bdd506..640bb25a299 100644 --- a/Cone_spanners_2/include/CGAL/Construct_yao_graph_2.h +++ b/Cone_spanners_2/include/CGAL/Construct_yao_graph_2.h @@ -164,7 +164,7 @@ protected: /* Construct edges in one cone bounded by two directions. \param cwBound The direction of the clockwise boundary of the cone. - \param ccwBound The direction of the counter-clockwise boundary. + \param ccwBound The direction of the counterclockwise boundary. \param g The Yao graph to be built. */ void add_edges_in_cone(const Direction_2& cwBound, const Direction_2& ccwBound, Graph_& g) { diff --git a/Heat_method_3/doc/Heat_method_3/Heat_method_3.txt b/Heat_method_3/doc/Heat_method_3/Heat_method_3.txt index 99ad2fb4344..3c637a18bfd 100644 --- a/Heat_method_3/doc/Heat_method_3/Heat_method_3.txt +++ b/Heat_method_3/doc/Heat_method_3/Heat_method_3.txt @@ -149,7 +149,7 @@ Next, the gradient in a given triangle can be expressed as \f$\nabla u = \frac{1}{2 A_f} \sum_i u_i ( N \times e_i ) \f$ -where \f$A_f\f$ is the area of the triangle, \f$N\f$ is its outward unit normal, \f$e_i\f$ is the \f$i\f$th edge vector (oriented counter-clockwise), and \f$u_i\f$ is the value of \f$u\f$ at the opposing vertex. The integrated divergence associated with vertex \f$i\f$ can be written as +where \f$A_f\f$ is the area of the triangle, \f$N\f$ is its outward unit normal, \f$e_i\f$ is the \f$i\f$th edge vector (oriented counterclockwise), and \f$u_i\f$ is the value of \f$u\f$ at the opposing vertex. The integrated divergence associated with vertex \f$i\f$ can be written as \f$\nabla \cdot X = \frac{1}{2} \sum_j cot\theta_1 (e_1 \cdot X_j) + cot \theta_2 (e_2 \cdot X_j)\f$ diff --git a/Mesh_2/include/CGAL/Mesh_2/Refine_edges_visitor.h b/Mesh_2/include/CGAL/Mesh_2/Refine_edges_visitor.h index 216ed38c035..e6cbe9320d7 100644 --- a/Mesh_2/include/CGAL/Mesh_2/Refine_edges_visitor.h +++ b/Mesh_2/include/CGAL/Mesh_2/Refine_edges_visitor.h @@ -98,7 +98,7 @@ public: // set fh to the face at the right of [va,v] typename Tr::Face_circulator fc = tr.incident_faces(v, fh), fcbegin(fc); - // circulators are counter-clockwise, so we start at the right of + // circulators are counterclockwise, so we start at the right of // [va,v] do { if( !tr.is_infinite(fc) ) diff --git a/Nef_2/include/CGAL/Nef_2/PM_checker.h b/Nef_2/include/CGAL/Nef_2/PM_checker.h index 89d60c6cd7e..ae92226feb8 100644 --- a/Nef_2/include/CGAL/Nef_2/PM_checker.h +++ b/Nef_2/include/CGAL/Nef_2/PM_checker.h @@ -95,12 +95,12 @@ bool is_forward(Halfedge_const_handle e) const void check_order_preserving_embedding(Vertex_const_handle v) const; /*{\Mop checks if the embedding of the targets of the edges in -the adjacency list |A(v)| is counter-clockwise order-preserving with +the adjacency list |A(v)| is counterclockwise order-preserving with respect to the order of the edges in |A(v)|.}*/ void check_order_preserving_embedding() const; /*{\Mop checks if the embedding of all vertices of |P| is -counter-clockwise order-preserving with respect to the adjacency +counterclockwise order-preserving with respect to the adjacency list ordering of all vertices.}*/ void check_forward_prefix_condition(Vertex_const_handle v) const; diff --git a/Nef_S2/include/CGAL/Nef_S2/SM_checker.h b/Nef_S2/include/CGAL/Nef_S2/SM_checker.h index dd659105e70..c5e82ea46ca 100644 --- a/Nef_S2/include/CGAL/Nef_S2/SM_checker.h +++ b/Nef_S2/include/CGAL/Nef_S2/SM_checker.h @@ -79,12 +79,12 @@ bool is_forward(Halfedge_const_handle e) const void check_order_preserving_embedding(Vertex_const_handle v) const; /*{\Mop checks if the embedding of the targets of the edges in -the adjacency list |A(v)| is counter-clockwise order-preserving with +the adjacency list |A(v)| is counterclockwise order-preserving with respect to the order of the edges in |A(v)|.}*/ void check_order_preserving_embedding() const; /*{\Mop checks if the embedding of all vertices of |P| is -counter-clockwise order-preserving with respect to the adjacency +counterclockwise order-preserving with respect to the adjacency list ordering of all vertices.}*/ void check_forward_prefix_condition(Vertex_const_handle v) const; diff --git a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_Delaunay_triangulation_2.h b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_Delaunay_triangulation_2.h index 279f21dec86..e4c592a7ce7 100644 --- a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_Delaunay_triangulation_2.h +++ b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_Delaunay_triangulation_2.h @@ -212,7 +212,7 @@ public: contains `p`. It outputs in the container pointed to by `eit` the boundary of the zone in conflict with `p`. The boundary edges of the conflict zone are output in - counter-clockwise order and each edge is described through its + counterclockwise order and each edge is described through its incident face which is not in conflict with `p`. The function returns in a std::pair the resulting output iterators. \pre `start` is in conflict with `p` and `p` lies in the original domain `domain`. diff --git a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/CGAL/Hyperbolic_octagon_translation.h b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/CGAL/Hyperbolic_octagon_translation.h index 026bb2efaa2..add3cf68651 100644 --- a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/CGAL/Hyperbolic_octagon_translation.h +++ b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/CGAL/Hyperbolic_octagon_translation.h @@ -124,7 +124,7 @@ public: Comparison operator. Each translation \f$g\f$ of \f$\mathcal G\f$, when applied to the octagon \f$\mathcal D_O\f$, produces a copy of \f$\mathcal D_O\f$ labeled by the translation \f$g\f$. The copies of - \f$\mathcal D_O\f$ incident to \f$\mathcal D_O\f$ are naturally ordered counter-clockwise around + \f$\mathcal D_O\f$ incident to \f$\mathcal D_O\f$ are naturally ordered counterclockwise around \f$\mathcal D_O\f$. The comparison operator compares two translations based on the ordering of the copies of \f$\mathcal D_O\f$ that they produce. For more details, see Section \ref P4HT2_representation of the User manual. diff --git a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/Concepts/Periodic_4HyperbolicTriangulationFaceBase_2.h b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/Concepts/Periodic_4HyperbolicTriangulationFaceBase_2.h index 2ebf4a74bbd..d2f106c51a4 100644 --- a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/Concepts/Periodic_4HyperbolicTriangulationFaceBase_2.h +++ b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/Concepts/Periodic_4HyperbolicTriangulationFaceBase_2.h @@ -11,7 +11,7 @@ A refinement of the concept `TriangulationFaceBase_2` that adds an interface for At the base level, a face stores handles to its incident vertices and to its neighboring faces. Compare with Section \ref Section_2D_Triangulations_Software_Design of the 2D Triangulations -package. The vertices and neighbors are indexed counter-clockwise 0, 1, and 2. Neighbor `i` lies +package. The vertices and neighbors are indexed counterclockwise 0, 1, and 2. Neighbor `i` lies opposite to vertex `i`. For periodic hyperbolic triangulations, the face base class needs to store three hyperbolic diff --git a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt index f5b7200ee7e..1384fcdc8af 100644 --- a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt +++ b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt @@ -54,7 +54,7 @@ Each face gives access to its three incident vertices and to its three adjacent to store additionally three hyperbolic translations. When applied to the three points stored in the vertices of the face, these translations produce the canonical representative of the face in the hyperbolic plane. -The three vertices of a face are indexed with 0, 1, and 2 in positive (counter-clockwise) orientation. The +The three vertices of a face are indexed with 0, 1, and 2 in positive (counterclockwise) orientation. The orientation of faces on the Bolza surface is defined as the orientation of their canonical representatives in the hyperbolic plane. diff --git a/Polygon_repair/doc/Polygon_repair/Polygon_repair.txt b/Polygon_repair/doc/Polygon_repair/Polygon_repair.txt index f837f18e9eb..34e7145d474 100644 --- a/Polygon_repair/doc/Polygon_repair/Polygon_repair.txt +++ b/Polygon_repair/doc/Polygon_repair/Polygon_repair.txt @@ -123,7 +123,7 @@ strict criteria: - Adjacent collinear edges touching at vertices of degree two are merged - The sequence of vertices representing a boundary starts from its lexicographically smallest vertex -- Outer boundaries are oriented counter-clockwise and inner boundaries are +- Outer boundaries are oriented counterclockwise and inner boundaries are oriented clockwise - The inner boundaries of a polygon with holes are stored in lexicographic order diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h index 88e901da204..5ee787b77f3 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h @@ -21,7 +21,7 @@ reverses the action of the other. The join and split operations. Left to right: The vertex `v` is split into \f$ v_1\f$ and \f$ v_2\f$. The faces \f$ f\f$ and \f$ g\f$ are inserted after \f$ f_1\f$ and \f$ f_2\f$, respectively, in the -counter-clockwise sense. The vertices \f$ v_1\f$, \f$ v_2\f$ and the +counterclockwise sense. The vertices \f$ v_1\f$, \f$ v_2\f$ and the faces \f$ f\f$ and \f$ g\f$ are returned as a `boost::tuple` in that order. Right to left: The edge `(f,i)` is collapsed, and thus the vertices \f$ v_1\f$ and \f$ v_2\f$ are joined. The vertex `v` is @@ -60,7 +60,7 @@ Vertex_handle join_vertices(Face_handle f, int i); /*! Splits the vertex `v` into two vertices `v1` and `v2`. The common faces `f` and `g` of `v1` and -`v2` are created after (in the counter-clockwise sense) the +`v2` are created after (in the counterclockwise sense) the faces `f1` and `f2`. The 4-tuple `(v1,v2,f,g)` is returned (see \cgalFigureRef{figsdgdssplitjoin}). */ diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h index 933124e25d1..ecb00ed9b23 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h @@ -206,7 +206,7 @@ returns the sign of the distance of `q` from the Voronoi circle of `s1`, `s2`, `s3` (the Voronoi circle of three sites `s1`, `s2`, `s3` is a circle co-tangent to all three sites, that touches them in that order as we walk on its circumference -in the counter-clockwise sense). +in the counterclockwise sense). \pre the Voronoi circle of `s1`, `s2`, `s3` must exist. Must also provide `Sign operator()(Site_2 s1, Site_2 s2, Site_2 q)`, which returns the sign of the distance of diff --git a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/Concepts/SegmentDelaunayGraphLinfTraits_2.h b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/Concepts/SegmentDelaunayGraphLinfTraits_2.h index 62c9a4f8f5b..bbef09563ef 100644 --- a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/Concepts/SegmentDelaunayGraphLinfTraits_2.h +++ b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/Concepts/SegmentDelaunayGraphLinfTraits_2.h @@ -78,7 +78,7 @@ segment Voronoi diagram. /*! A constructor for the point \f$ v \f$ at which the three \f$ L_{\infty} \f$ bisectors between the three given sites `s1`, `s2` and `s3` intersect -and the regions of `s1`, `s2` and `s3` appear in the counter-clockwise order +and the regions of `s1`, `s2` and `s3` appear in the counterclockwise order `s1`, `s2`, `s3` around \f$ v\f$. Point \f$ v \f$ is equidistant @@ -116,7 +116,7 @@ of `s1`, `s2`, `s3`. The \f$ L_{\infty} \f$ Voronoi square of three sites `s1`, `s2`, `s3` is an axis-parallel square which is passing through all three sites and touches them in the `s1`, `s2`, `s3` -order as we walk on the square in the counter-clockwise sense. +order as we walk on the square in the counterclockwise sense. The center of the square is at the intersection of the three \f$ L_{\infty} \f$ bisectors of the three sites. @@ -256,7 +256,7 @@ Since CGAL segments have also an orientation, we also orient For an oriented segment \f$ s \f$, we orient its \f$L_{\infty}\f$-perpendicular lines so that the lines' orientation is closest to the following orientation: -the orientation of \f$ s \f$ rotated counter-clockwise by +the orientation of \f$ s \f$ rotated counterclockwise by \f$ \pi/2 \f$. Let `s` be a segment and `p` a point contained in its interior. diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_2.h index 65cbf5cbb71..939e0817de3 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_2.h @@ -70,7 +70,7 @@ For any given input polygon, its offset polygons at a certain distance are compo This method returns all such contours in an unspecified order and with no parental relationship between them (that is why it is called `construct_offset_contours()` and not `construct_offset_polygons()`). -Those offset contours in the resulting sequence which are oriented counter-clockwise are outer contours +Those offset contours in the resulting sequence which are oriented counterclockwise are outer contours and those oriented clockwise are holes. It is up to the user to match each hole to its parent in order to reconstruct the parent-hole relationship of the conceptual output. It is sufficient to test each hole against each parent as there won't be a hole inside a hole, a parent inside any other contour, diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_2.h index 727da054561..9b19a44c449 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_2.h @@ -96,10 +96,10 @@ of the straight skeleton HDS, such border halfedges are oriented such that their outwards the polygon. Therefore, the opposite halfedge of any border halfedge is oriented such that its left side faces inward the polygon. -This \cgal package requires the input polygon (with holes) to be weakly simple and oriented counter-clockwise. +This \cgal package requires the input polygon (with holes) to be weakly simple and oriented counterclockwise. The skeleton halfedges are oriented such that their left side faces inward the region they bound. -That is, the vertices (both contour and skeleton) of a face are circulated in counter-clockwise order. +That is, the vertices (both contour and skeleton) of a face are circulated in counterclockwise order. There is one and only one contour halfedge incident upon any face. The contours of the input polygon are traced by the border halfedges of the HDS (those facing outward), @@ -115,7 +115,7 @@ Thus, the 2 opposite halfedges of a skeleton edge link the edge to its 2 definin Starting from any border contour halfedge, circulating the structure walks through border counter halfedges and traces the vertices of the polygon's contours (in opposite order). -Starting from any non-border but contour halfedge, circulating the structure walks counter-clockwise +Starting from any non-border but contour halfedge, circulating the structure walks counterclockwise around the face corresponding to that contour halfedge. The vertices around a face always describe a non-convex weakly simple polygon. diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h index 1331edf5f38..2226c78af51 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h @@ -169,7 +169,7 @@ whose straight skeleton is to be built. Each contour must be input in turn starting with the outer contour and following with the holes (if any). The order of the holes is unimportant but the outer contour must be entered first. -The outer contour must be oriented counter-clockwise while holes must be oriented clockwise. +The outer contour must be oriented counterclockwise while holes must be oriented clockwise. It is an error to enter more than one outer contour, to enter a hole which is not inside the outer contour, to enter a hole that is inside another hole, or to enter a contour which crosses diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Straight_skeleton_2.txt b/Straight_skeleton_2/doc/Straight_skeleton_2/Straight_skeleton_2.txt index 9686bdf2e97..1c183705474 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Straight_skeleton_2.txt +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Straight_skeleton_2.txt @@ -175,7 +175,7 @@ for each boundary that does not contain the defining contour edge of its inciden \cgalFigureCaptionBegin{SLSArtificial} A polygon with four holes (black) and its straight skeleton (red). -Three artificial bisectors (green) are added in a post-processing step to recover the simply-connected +Three artificial bisectors (green) are added in a postprocessing step to recover the simply-connected property for the straight skeleton face (gray) of the rightmost vertical contour edge. \cgalFigureCaptionEnd @@ -454,7 +454,7 @@ To construct the straight skeleton of a polygon the user must:
  • Instantiate the straight skeleton builder.
  • Enter one contour at a time, starting from the outer contour, via the method `Straight_skeleton_builder_2::enter_contour()`. The input polygon must be - weakly simple and counter-clockwise oriented (see the definitions at the beginning + weakly simple and counterclockwise oriented (see the definitions at the beginning of this chapter). Collinear edges are allowed. The insertion order of each hole is unimportant but the outer contour must be entered first.
  • Call `Straight_skeleton_builder_2::construct_skeleton()` once all the contours @@ -480,18 +480,18 @@ The resulting sequence of offset contours can contain both outer and inner conto However, this algorithm returns a sequence of contours in arbitrary order and there is no indication whatsoever of the parental relationship between inner and outer contours. -On the other hand, each outer contour is counter-clockwise oriented while each hole is clockwise-oriented. +On the other hand, each outer contour is counterclockwise oriented while each hole is clockwise-oriented. And since offset contours do form simple polygons, it is guaranteed that no hole will be inside another hole, no outer contour will be inside any other contour, and each hole will be inside exactly 1 outer contour. Parental relationships are not automatically reconstructed by this algorithm because -this relation is not directly given by the input polygon and must be done as a post-processing +this relation is not directly given by the input polygon and must be done as a postprocessing step. The function `CGAL::arrange_offset_polygons_2()` can be used to do that efficiently. A user can reconstruct the parental relationships as a post processing operation by testing each inner contour (which is identified by being clockwise) against each outer contour (identified -as being counter-clockwise) for insideness. +as being counterclockwise) for insideness. This algorithm requires exact predicates but not exact constructions. Therefore, the `Exact_predicates_inexact_constructions_kernel` should be used. diff --git a/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt b/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt index 8f9a99e0877..84a23f73a67 100644 --- a/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt +++ b/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt @@ -106,7 +106,7 @@ which offers combinatorial repairing while reading bad inputs. \section IOStreamOBJ Wavefront Advanced Visualizer Object Format (OBJ) The `OBJ` file format, using the file extension `.obj`, is a simple \ascii data format that represents 3D geometry. -Vertices are stored in a counter-clockwise order by default, making explicit declaration of face normals unnecessary. +Vertices are stored in a counterclockwise order by default, making explicit declaration of face normals unnecessary. A precise specification of the format is available here. diff --git a/TDS_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h b/TDS_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h index 5c076eed68f..327d5c1b910 100644 --- a/TDS_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h +++ b/TDS_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h @@ -134,7 +134,7 @@ Vertex_handle join_vertices(Edges_circulator ec); /*! splits the vertex `v` into two vertices `v1` and `v2`. -The common faces `f` and `g` of `v1` and `v2` are created after (in the counter-clockwise sense) the +The common faces `f` and `g` of `v1` and `v2` are created after (in the counterclockwise sense) the faces `f1` and `f2`. The 4-tuple `(v1,v2,f,g)` is returned (see Fig. \ref figtdssplitjoin). \pre `dimension()` must be equal to `2`, `f1` and `f2` must be different from `Face_handle()` and `v` must be a vertex of both `f1` and `f2`. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h index d0c228c5880..3ba65d37b27 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h @@ -305,7 +305,7 @@ outputs the boundary edges of the conflict zone of point `p` into an output iter This functions outputs in the container pointed to by `eit`, the boundary of the zone in conflict with `p`. The boundary edges -of the conflict zone are output in counter-clockwise order +of the conflict zone are output in counterclockwise order and each edge is described through the incident face which is not in conflict with `p`. The function returns the resulting output iterator. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h index ec43542e73f..6779a7eb4df 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h @@ -221,7 +221,7 @@ i. e., the faces whose circumcircle contains `p`. It outputs in the container pointed to by `eit` the the boundary of the zone in conflict with `p`. The boundary edges -of the conflict zone are output in counter-clockwise order +of the conflict zone are output in counterclockwise order and each edge is described through its incident face which is not in conflict with `p`. The function returns in a `std::pair` the resulting output iterators. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h index 2c9bf5384ae..7005ff7f1b0 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h @@ -295,7 +295,7 @@ have negative power wrt. `p`. It outputs in the container pointed to by `eit` the boundary of the zone in conflict with `p`. It inserts the vertices that would be hidden by `p` into the container pointed to by `vit`. The boundary edges of -the conflict zone are output in counter-clockwise order and each edge +the conflict zone are output in counterclockwise order and each edge is described through its incident face which is not in conflict with `p`. The function returns in a `CGAL::Triple` the resulting output iterators. diff --git a/Triangulation_on_hyperbolic_surface_2/doc/Triangulation_on_hyperbolic_surface_2/Triangulation_on_hyperbolic_surface_2.txt b/Triangulation_on_hyperbolic_surface_2/doc/Triangulation_on_hyperbolic_surface_2/Triangulation_on_hyperbolic_surface_2.txt index 17c1cac5374..781793b956d 100644 --- a/Triangulation_on_hyperbolic_surface_2/doc/Triangulation_on_hyperbolic_surface_2/Triangulation_on_hyperbolic_surface_2.txt +++ b/Triangulation_on_hyperbolic_surface_2/doc/Triangulation_on_hyperbolic_surface_2/Triangulation_on_hyperbolic_surface_2.txt @@ -60,9 +60,9 @@ In order to perform fast and exact computations with a fundamental domain, every \subsection Subsection_Hyperbolic_Surface_Triangulations_DS_Domains Data Structure for Domains -We represent every fundamental domain as a polygon in the Poincaré disk, given by the list of its vertices in counter-clockwise order and by the list of its side pairings. +We represent every fundamental domain as a polygon in the Poincaré disk, given by the list of its vertices in counterclockwise order and by the list of its side pairings. This package can generate a random convex fundamental domain \f$ P \f$ of a surface of genus two, with eight vertices \f$ z_0, \dots, z_7 \in \mathbb{C} \f$. -The vertices and the sides are in counter-clockwise order, the side between \f$ z_0 \f$ and \f$ z_1 \f$ is \f$ A \f$, the side between \f$ z_4 \f$ and \f$ z_5 \f$ is \f$ \overline{A} \f$ and so on as on \cgalFigureRef{THS2-octagon}. The side pairings are \f$ A \f$ with \f$\overline{A} \f$ , \f$ B \f$ with \f$ \overline{B} \f$ , \f$ C \f$ with \f$ \overline{C} \f$ and \f$ D \f$ with \f$ \overline{D} \f$. +The vertices and the sides are in counterclockwise order, the side between \f$ z_0 \f$ and \f$ z_1 \f$ is \f$ A \f$, the side between \f$ z_4 \f$ and \f$ z_5 \f$ is \f$ \overline{A} \f$ and so on as on \cgalFigureRef{THS2-octagon}. The side pairings are \f$ A \f$ with \f$\overline{A} \f$ , \f$ B \f$ with \f$ \overline{B} \f$ , \f$ C \f$ with \f$ \overline{C} \f$ and \f$ D \f$ with \f$ \overline{D} \f$. These octagons are symmetric, i.e. \f$ z_i = -z_{i+4} \f$ for every \f$ i \f$, where indices are modulo eight. Such octagons are described in \cgalCite{aigon2005hyperbolic}. diff --git a/Triangulation_on_hyperbolic_surface_2/include/CGAL/Triangulation_on_hyperbolic_surface_2.h b/Triangulation_on_hyperbolic_surface_2/include/CGAL/Triangulation_on_hyperbolic_surface_2.h index c592f4d17a2..4112762f5cd 100644 --- a/Triangulation_on_hyperbolic_surface_2/include/CGAL/Triangulation_on_hyperbolic_surface_2.h +++ b/Triangulation_on_hyperbolic_surface_2/include/CGAL/Triangulation_on_hyperbolic_surface_2.h @@ -35,7 +35,7 @@ namespace CGAL { Represents a geodesic triangulation of a closed orientable hyperbolic surface. The triangulation is stored as combinatorial map decorated with one cross-ratio per edge. It is also possible to specify an anchor for the triangulation. An anchor consists in 1) a dart of the combinatorial map, belonging by definition to a vertex V and a triangle T, together with -2) three points A,B,C in the hyperbolic plane. The points A,B,C are the three vertices in counter-clockwise order of a triangle. This triangle is a lift +2) three points A,B,C in the hyperbolic plane. The points A,B,C are the three vertices in counterclockwise order of a triangle. This triangle is a lift of T, and A is a lift of V. */ template diff --git a/Triangulation_on_sphere_2/doc/Triangulation_on_sphere_2/CGAL/Delaunay_triangulation_on_sphere_2.h b/Triangulation_on_sphere_2/doc/Triangulation_on_sphere_2/CGAL/Delaunay_triangulation_on_sphere_2.h index b8dd0b0678c..72908531f39 100644 --- a/Triangulation_on_sphere_2/doc/Triangulation_on_sphere_2/CGAL/Delaunay_triangulation_on_sphere_2.h +++ b/Triangulation_on_sphere_2/doc/Triangulation_on_sphere_2/CGAL/Delaunay_triangulation_on_sphere_2.h @@ -157,7 +157,7 @@ public: This function outputs in the container pointed to by `fit` the faces which are in conflict with point `p`, i. e., the faces whose circumcircle contains `p`. It outputs in the container pointed to by `eit` the boundary of the zone in conflict with `p`. The boundary edges of the conflict zone - are output in counter-clockwise order and each edge is described through its incident face + are output in counterclockwise order and each edge is described through its incident face which is not in conflict with `p`. The function returns in a `std::pair` the resulting output iterators. \tparam OutItFaces is an output iterator with `Face_handle` as value type. diff --git a/Visibility_2/include/CGAL/Rotational_sweep_visibility_2.h b/Visibility_2/include/CGAL/Rotational_sweep_visibility_2.h index fd7bfd719a8..a2bf487b43f 100644 --- a/Visibility_2/include/CGAL/Rotational_sweep_visibility_2.h +++ b/Visibility_2/include/CGAL/Rotational_sweep_visibility_2.h @@ -806,7 +806,7 @@ private: } //for face query: traverse the face to get all edges - //and sort vertices in counter-clockwise order. + //and sort vertices in counterclockwise order. void input_face (Face_const_handle fh) const { Ccb_halfedge_const_circulator curr = fh->outer_ccb(); @@ -840,7 +840,7 @@ private: } } //for vertex or edge query: traverse the face to get all edges - //and sort vertices in counter-clockwise order. + //and sort vertices in counterclockwise order. void input_face (Face_const_handle fh, EHs& good_edges, Arrangement_2& bbox) const From d8e17c22c5dcfc54eea8a26f94c4de3ed5305d0a Mon Sep 17 00:00:00 2001 From: Sven Oesau Date: Thu, 15 May 2025 10:43:34 +0200 Subject: [PATCH 05/16] Don't generate a CMake error if GMP has not been found --- Installation/cmake/modules/CGAL_SetupGMP.cmake | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/Installation/cmake/modules/CGAL_SetupGMP.cmake b/Installation/cmake/modules/CGAL_SetupGMP.cmake index f4797f39e0a..f4059c9f2cf 100644 --- a/Installation/cmake/modules/CGAL_SetupGMP.cmake +++ b/Installation/cmake/modules/CGAL_SetupGMP.cmake @@ -21,9 +21,18 @@ set(CGAL_SetupGMP_included TRUE) # That is required to find the FindGMP and FindMPFR modules. set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CGAL_MODULES_DIR}) -find_package(GMP REQUIRED) -find_package(MPFR REQUIRED) -find_package(GMPXX QUIET) +find_package(GMP QUIET) +find_package(MPFR QUIET) + +if (GMP_FOUND) + find_package(GMPXX QUIET) +endif() + +if(NOT GMP_FOUND OR NOT MPFR_FOUND) + message(STATUS "GMP not found.") + set(CGAL_DISABLE_GMP ON) + return() +endif() if(NOT GMPXX_FOUND) option(CGAL_WITH_GMPXX "Use CGAL with GMPXX: use C++ classes of GNU MP instead of CGAL wrappers" OFF) From 21d4eecd82aabba72811676d725d7c36c4c91bd3 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Mon, 19 May 2025 14:17:22 +0100 Subject: [PATCH 06/16] CGAL: About namespace internal --- .../Developer_manual/Chapter_namespaces.txt | 38 +++++++++++-------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/Documentation/doc/Documentation/Developer_manual/Chapter_namespaces.txt b/Documentation/doc/Documentation/Developer_manual/Chapter_namespaces.txt index 2564834e1ed..a5d4583afd8 100644 --- a/Documentation/doc/Documentation/Developer_manual/Chapter_namespaces.txt +++ b/Documentation/doc/Documentation/Developer_manual/Chapter_namespaces.txt @@ -13,19 +13,31 @@ but the better alternative is the usage of `namespace`. \section Developer_manualNamespaceCGAL Namespace CGAL -All names introduced by \cgal should be in namespace `CGAL`, e.g.: +All names introduced by \cgal should be in namespace `CGAL`, or in a subnamespace +corresponding to a package, e.g.: \code{.cpp} #include namespace CGAL { -class My_new_cgal_class {}; +/*! + * This class ... + */ +class Foo {}; -My_new_cgal_class -my_new_function( My_new_cgal_class& ); +namespace Polygon_mesh_processing { + +/*! + * modifies `f` by ... + */ +void +bar( foo & f); + +} // namespace Polygon_mesh_processing } // namespace CGAL \endcode + Make sure not to have include statements inside the `namespace CGAL`. Otherwise, all names defined in the file included will be added to the namespace. @@ -35,19 +47,15 @@ added to the namespace. All names introduced by \cgal which are not documented to the user should be under an `internal` subnamespace of `CGAL`, e.g.: \code{.cpp} -namespace CGAL { namespace internal { +namespace CGAL { +namespace Polygon_mesh_processing { +namespace internal { -class My_undocumented_class {}; +class Baz_used_by_foo {}; -void my_new_function( My_undocumented_class& ); - -}} // namespace CGAL::internal - -namespace CGAL { namespace internal { namespace Package { namespace tags { - -class Some_further_class_local_to_Package; - -}}}} // namespace CGAL::internal::Package::tags +} // namespace internal +} // namespace Polygon_mesh_processing +} // namespace CGAL \endcode \section Developer_manualNoteonglobaltemplatefunctions Note on global template functions From 1ec16b9ac7ad74cc72e60feaa38aaa865897e332 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Thu, 22 May 2025 11:01:55 +0100 Subject: [PATCH 07/16] Add section on boodt::mp --- Number_types/doc/Number_types/NumberTypeSupport.txt | 9 +++++++++ Number_types/doc/Number_types/PackageDescription.txt | 3 +++ Number_types/include/CGAL/Exact_integer.h | 3 +-- Number_types/include/CGAL/Exact_rational.h | 3 +-- 4 files changed, 14 insertions(+), 4 deletions(-) diff --git a/Number_types/doc/Number_types/NumberTypeSupport.txt b/Number_types/doc/Number_types/NumberTypeSupport.txt index d22aee9d648..1da205cb16b 100644 --- a/Number_types/doc/Number_types/NumberTypeSupport.txt +++ b/Number_types/doc/Number_types/NumberTypeSupport.txt @@ -115,6 +115,15 @@ requirements. To use these classes, \gmp and \mpfr must be installed. + +\section Number_typesBoost Number Types Provided by boost + +\anchor boostnt + +Boost provides an arbitrary precision integer and rational number type. +These number types can have \gmp as backend, but they can also be used +with a native backend. + \section Number_typesLEDA Number Types Provided by LEDA \anchor ledant diff --git a/Number_types/doc/Number_types/PackageDescription.txt b/Number_types/doc/Number_types/PackageDescription.txt index 84bfd6debbd..0fe0870dcf1 100644 --- a/Number_types/doc/Number_types/PackageDescription.txt +++ b/Number_types/doc/Number_types/PackageDescription.txt @@ -15,6 +15,9 @@ /// \defgroup nt_gmp GMP /// \ingroup PkgNumberTypesRef +/// \defgroup nt_boost boost multiprecision +/// \ingroup PkgNumberTypesRef + /// \defgroup nt_cgal CGAL Number Types /// \ingroup PkgNumberTypesRef diff --git a/Number_types/include/CGAL/Exact_integer.h b/Number_types/include/CGAL/Exact_integer.h index fe5d793a99c..7bc5767650d 100644 --- a/Number_types/include/CGAL/Exact_integer.h +++ b/Number_types/include/CGAL/Exact_integer.h @@ -27,8 +27,7 @@ namespace CGAL { `Exact_integer` is an exact integer number type. It is a typedef of another number type. Its exact definition depends on -the availability the third-party libraries \gmp, \core, and \leda. \cgal must -be configured with at least one of those libraries. +the availability the third-party libraries \gmp and \leda. \cgalModels{EuclideanRing,RealEmbeddable} diff --git a/Number_types/include/CGAL/Exact_rational.h b/Number_types/include/CGAL/Exact_rational.h index a80795a61dc..5fbb46dec99 100644 --- a/Number_types/include/CGAL/Exact_rational.h +++ b/Number_types/include/CGAL/Exact_rational.h @@ -27,8 +27,7 @@ namespace CGAL { `Exact_rational` is an exact rational number type, constructible from `double`. It is a typedef of another number type. Its exact definition depends on -the availability the third-party libraries \gmp, \core, and \leda. \cgal must -be configured with at least one of those libraries. +the availability the third-party libraries \gmp and \leda. \cgalModels{Field,RealEmbeddable,Fraction,FromDoubleConstructible} From d8298ae79058bfcbb28fe0148ba5288b3e140b57 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Thu, 22 May 2025 13:17:16 +0100 Subject: [PATCH 08/16] Fixes --- Number_types/doc/Number_types/NumberTypeSupport.txt | 12 ++++++++---- Number_types/doc/Number_types/PackageDescription.txt | 10 ++++++++++ 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/Number_types/doc/Number_types/NumberTypeSupport.txt b/Number_types/doc/Number_types/NumberTypeSupport.txt index 1da205cb16b..e395630a434 100644 --- a/Number_types/doc/Number_types/NumberTypeSupport.txt +++ b/Number_types/doc/Number_types/NumberTypeSupport.txt @@ -116,13 +116,17 @@ requirements. To use these classes, \gmp and \mpfr must be installed. -\section Number_typesBoost Number Types Provided by boost +\section Number_typesBoost Number Types Provided by Boost \anchor boostnt -Boost provides an arbitrary precision integer and rational number type. -These number types can have \gmp as backend, but they can also be used -with a native backend. +Boost provides arbitrary precision integer and rational number types. +The number types `boost::multiprecision::gmp_int` and `boost::multiprecision::gmp_rational` +have \gmp as backend, while the number types `boost::multiprecision::cpp_int` +and `boost::multiprecision::cpp_rational` have a native backend. +The file CGAL/boost_mp.h provides the functions to make +these classes models of number type concepts. + \section Number_typesLEDA Number Types Provided by LEDA diff --git a/Number_types/doc/Number_types/PackageDescription.txt b/Number_types/doc/Number_types/PackageDescription.txt index 0fe0870dcf1..5c851aafb7a 100644 --- a/Number_types/doc/Number_types/PackageDescription.txt +++ b/Number_types/doc/Number_types/PackageDescription.txt @@ -9,6 +9,9 @@ /// \defgroup nt_core CORE /// \ingroup PkgNumberTypesRef +/// \defgroup nt_boost Boost +/// \ingroup PkgNumberTypesRef + /// \defgroup nt_leda LEDA /// \ingroup PkgNumberTypesRef @@ -74,6 +77,13 @@ - `leda_bigfloat` - `leda_real` +\cgalCRPSubsection{Boost} + +- `boost::multiprecision::cpp_int` +- `boost::multiprecision::cpp_rational` +- `boost::multiprecision::gmp_int` +- `boost::multiprecision::gmp_rational` + \cgalCRPSubsection{GMP} - `mpz_class` From 2615a2abe8b46f6bc9d5c553048fe75046e1bd98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Thu, 22 May 2025 16:22:04 +0200 Subject: [PATCH 09/16] add missing addgroup --- Scripts/developer_scripts/cgal_create_package_dir.py | 1 + 1 file changed, 1 insertion(+) diff --git a/Scripts/developer_scripts/cgal_create_package_dir.py b/Scripts/developer_scripts/cgal_create_package_dir.py index e2445915d5b..560e6bf308e 100755 --- a/Scripts/developer_scripts/cgal_create_package_dir.py +++ b/Scripts/developer_scripts/cgal_create_package_dir.py @@ -47,6 +47,7 @@ r"""// PRETTY PACKAGE NAME should equal the project title in Doxyfile.in /// \ingroup PkgPACKAGERef /*! +\addtogroup PkgPACKAGERef \cgalPkgDescriptionBegin{PACKAGE NAME,PkgPACKAGE} \cgalPkgPicture{pkg-small.png} From 821514ef5bd30200ff8944a296dd77a72309bdc2 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Thu, 22 May 2025 15:51:10 +0100 Subject: [PATCH 10/16] double group definition --- Number_types/doc/Number_types/PackageDescription.txt | 3 --- 1 file changed, 3 deletions(-) diff --git a/Number_types/doc/Number_types/PackageDescription.txt b/Number_types/doc/Number_types/PackageDescription.txt index 5c851aafb7a..36676bd07ab 100644 --- a/Number_types/doc/Number_types/PackageDescription.txt +++ b/Number_types/doc/Number_types/PackageDescription.txt @@ -18,9 +18,6 @@ /// \defgroup nt_gmp GMP /// \ingroup PkgNumberTypesRef -/// \defgroup nt_boost boost multiprecision -/// \ingroup PkgNumberTypesRef - /// \defgroup nt_cgal CGAL Number Types /// \ingroup PkgNumberTypesRef From 13609a69663d4379297720a7c700d01bbb6c4ac9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Thu, 22 May 2025 17:53:41 +0200 Subject: [PATCH 11/16] no need to repeat the package name as it is on the line above --- AABB_tree/doc/AABB_tree/PackageDescription.txt | 2 +- .../PackageDescription.txt | 2 +- .../doc/Algebraic_foundations/PackageDescription.txt | 2 +- .../doc/Algebraic_kernel_d/PackageDescription.txt | 2 +- Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt | 2 +- Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt | 2 +- Alpha_wrap_3/doc/Alpha_wrap_3/PackageDescription.txt | 2 +- .../doc/Apollonius_graph_2/PackageDescription.txt | 2 +- .../doc/Arrangement_on_surface_2/PackageDescription.txt | 2 +- BGL/doc/BGL/PackageDescription.txt | 2 +- .../doc/Barycentric_coordinates_2/PackageDescription.txt | 8 +------- Basic_viewer/doc/Basic_viewer/PackageDescription.txt | 2 +- .../doc/Boolean_set_operations_2/PackageDescription.txt | 2 +- .../doc/Bounding_volumes/PackageDescription.txt | 2 +- .../doc/Box_intersection_d/PackageDescription.txt | 2 +- CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt | 2 +- .../doc/Circular_kernel_2/PackageDescription.txt | 2 +- .../doc/Circular_kernel_3/PackageDescription.txt | 2 +- Circulator/doc/Circulator/PackageDescription.txt | 2 +- Classification/doc/Classification/PackageDescription.txt | 2 +- .../doc/Combinatorial_map/PackageDescription.txt | 2 +- .../doc/Cone_spanners_2/PackageDescription.txt | 2 +- .../doc/Convex_decomposition_3/PackageDescription.txt | 2 +- Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt | 2 +- Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt | 2 +- Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt | 2 +- Envelope_2/doc/Envelope_2/PackageDescription.txt | 2 +- Envelope_3/doc/Envelope_3/PackageDescription.txt | 2 +- .../doc/Generalized_map/PackageDescription.txt | 2 +- Generator/doc/Generator/PackageDescription.txt | 2 +- GraphicsView/doc/GraphicsView/PackageDescription.txt | 2 +- HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt | 2 +- Heat_method_3/doc/Heat_method_3/PackageDescription.txt | 4 +--- .../doc/Hyperbolic_triangulation_2/PackageDescription.txt | 2 +- .../doc/Inscribed_areas/PackageDescription.txt | 2 +- Interpolation/doc/Interpolation/PackageDescription.txt | 2 +- .../doc/Interval_skip_list/PackageDescription.txt | 2 +- Isosurfacing_3/doc/Isosurfacing_3/PackageDescription.txt | 2 +- Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt | 2 +- Kernel_23/doc/Kernel_23/PackageDescription.txt | 2 +- Kernel_d/doc/Kernel_d/PackageDescription.txt | 2 +- .../doc/Kinetic_space_partition/PackageDescription.txt | 2 +- .../Kinetic_surface_reconstruction/PackageDescription.txt | 2 +- .../doc/Linear_cell_complex/PackageDescription.txt | 2 +- Matrix_search/doc/Matrix_search/PackageDescription.txt | 2 +- Mesh_2/doc/Mesh_2/PackageDescription.txt | 2 +- Mesh_3/doc/Mesh_3/PackageDescription.txt | 2 +- .../doc/Minkowski_sum_2/PackageDescription.txt | 2 +- .../doc/Minkowski_sum_3/PackageDescription.txt | 2 +- Miscellany/doc/Miscellany/PackageDescription.txt | 2 +- .../doc/Modular_arithmetic/PackageDescription.txt | 2 +- Nef_2/doc/Nef_2/PackageDescription.txt | 2 +- Nef_3/doc/Nef_3/PackageDescription.txt | 2 +- Nef_S2/doc/Nef_S2/PackageDescription.txt | 2 +- Number_types/doc/Number_types/PackageDescription.txt | 2 +- .../doc/Optimal_bounding_box/PackageDescription.txt | 2 +- .../PackageDescription.txt | 2 +- Orthtree/doc/Orthtree/PackageDescription.txt | 2 +- Partition_2/doc/Partition_2/PackageDescription.txt | 2 +- .../doc/Periodic_2_triangulation_2/PackageDescription.txt | 2 +- .../doc/Periodic_3_mesh_3/PackageDescription.txt | 2 +- .../doc/Periodic_3_triangulation_3/PackageDescription.txt | 2 +- .../PackageDescription.txt | 2 +- Point_set_2/doc/Point_set_2/PackageDescription.txt | 2 +- Point_set_3/doc/Point_set_3/PackageDescription.txt | 2 +- .../doc/Point_set_processing_3/PackageDescription.txt | 2 +- .../PackageDescription.txt | 2 +- Polygon/doc/Polygon/PackageDescription.txt | 2 +- .../doc/Polygon_mesh_processing/PackageDescription.txt | 2 +- Polygon_repair/doc/Polygon_repair/PackageDescription.txt | 2 +- .../PackageDescription.txt | 4 +--- Polyhedron/doc/Polyhedron/PackageDescription.txt | 2 +- .../doc/Polyline_simplification_2/PackageDescription.txt | 2 +- Polynomial/doc/Polynomial/PackageDescription.txt | 2 +- .../doc/Polytope_distance_d/PackageDescription.txt | 2 +- .../Principal_component_analysis/PackageDescription.txt | 2 +- Property_map/doc/Property_map/PackageDescription.txt | 2 +- QP_solver/doc/QP_solver/PackageDescription.txt | 2 +- Ridges_3/doc/Ridges_3/PackageDescription.txt | 2 +- SMDS_3/doc/SMDS_3/PackageDescription.txt | 2 +- STL_Extension/doc/STL_Extension/PackageDescription.txt | 2 +- .../Scale_space_reconstruction_3/PackageDescription.txt | 2 +- .../doc/SearchStructures/PackageDescription.txt | 2 +- .../doc/Segment_Delaunay_graph_2/PackageDescription.txt | 2 +- .../Segment_Delaunay_graph_Linf_2/PackageDescription.txt | 2 +- .../doc/Set_movable_separability_2/PackageDescription.txt | 2 +- .../doc/Shape_detection/PackageDescription.txt | 4 +--- .../doc/Shape_regularization/PackageDescription.txt | 8 +------- Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt | 2 +- .../doc/Snap_rounding_2/PackageDescription.txt | 2 +- .../doc/Solver_interface/PackageDescription.txt | 2 +- .../doc/Spatial_searching/PackageDescription.txt | 2 +- .../doc/Spatial_sorting/PackageDescription.txt | 2 +- .../doc/Straight_skeleton_2/PackageDescription.txt | 2 +- Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt | 2 +- Stream_support/doc/Stream_support/PackageDescription.txt | 2 +- .../doc/Subdivision_method_3/PackageDescription.txt | 2 +- .../doc/Surface_mesh_approximation/PackageDescription.txt | 2 +- .../doc/Surface_mesh_deformation/PackageDescription.txt | 2 +- .../Surface_mesh_parameterization/PackageDescription.txt | 2 +- .../doc/Surface_mesh_segmentation/PackageDescription.txt | 2 +- .../doc/Surface_mesh_shortest_path/PackageDescription.txt | 2 +- .../Surface_mesh_simplification/PackageDescription.txt | 2 +- .../Surface_mesh_skeletonization/PackageDescription.txt | 2 +- .../doc/Surface_mesh_topology/PackageDescription.txt | 2 +- Surface_mesher/doc/Surface_mesher/PackageDescription.txt | 2 +- .../doc/Surface_sweep_2/PackageDescription.txt | 2 +- TDS_2/doc/TDS_2/PackageDescription.txt | 2 +- TDS_3/doc/TDS_3/PackageDescription.txt | 2 +- .../doc/Tetrahedral_remeshing/PackageDescription.txt | 4 +--- Three/doc/Three/PackageDescription.txt | 2 +- Triangulation/doc/Triangulation/PackageDescription.txt | 2 +- .../doc/Triangulation_2/PackageDescription.txt | 2 +- .../doc/Triangulation_3/PackageDescription.txt | 2 +- .../PackageDescription.txt | 2 +- .../doc/Triangulation_on_sphere_2/PackageDescription.txt | 2 +- Visibility_2/doc/Visibility_2/PackageDescription.txt | 2 +- .../doc/Voronoi_diagram_2/PackageDescription.txt | 2 +- Weights/doc/Weights/PackageDescription.txt | 2 +- 119 files changed, 119 insertions(+), 139 deletions(-) diff --git a/AABB_tree/doc/AABB_tree/PackageDescription.txt b/AABB_tree/doc/AABB_tree/PackageDescription.txt index 4aea07e8e6a..e16cfc867d4 100644 --- a/AABB_tree/doc/AABB_tree/PackageDescription.txt +++ b/AABB_tree/doc/AABB_tree/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgAABBTreeRef AABB Tree Reference +/// \defgroup PkgAABBTreeRef Reference Manual /// \defgroup PkgAABBTreeConcepts Concepts /// \ingroup PkgAABBTreeRef diff --git a/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/PackageDescription.txt b/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/PackageDescription.txt index a0df1f768f4..4799cda1813 100644 --- a/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/PackageDescription.txt +++ b/Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgAdvancingFrontSurfaceReconstructionRef Advancing Front Surface Reconstruction Reference +/// \defgroup PkgAdvancingFrontSurfaceReconstructionRef Reference Manual /// \defgroup PkgAdvancingFrontSurfaceReconstructionRefConcepts Concepts /// \ingroup PkgAdvancingFrontSurfaceReconstructionRef diff --git a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt index 9e12449ab5b..7121abc1afd 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt +++ b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgAlgebraicFoundationsRef Algebraic Foundations Reference +/// \defgroup PkgAlgebraicFoundationsRef Reference Manual /// \defgroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts Concepts /// \ingroup PkgAlgebraicFoundationsRef diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt b/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt index b8107073f4a..036c5761e5d 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgAlgebraicKernelDRef Algebraic Kernel Reference +/// \defgroup PkgAlgebraicKernelDRef Reference Manual /// \defgroup PkgAlgebraicKernelDConcepts Concepts /// \ingroup PkgAlgebraicKernelDRef diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt b/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt index 78941b31d7d..14ef6b83398 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgAlphaShapes2Ref 2D Alpha Shapes Reference +/// \defgroup PkgAlphaShapes2Ref Reference Manual /// \defgroup PkgAlphaShapes2Concepts Concepts /// \ingroup PkgAlphaShapes2Ref diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt b/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt index 97bf10a844d..8b95b04ea7d 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgAlphaShapes3Ref 3D Alpha Shapes Reference +/// \defgroup PkgAlphaShapes3Ref Reference Manual /// \defgroup PkgAlphaShapes3Concepts Concepts /// \ingroup PkgAlphaShapes3Ref /*! diff --git a/Alpha_wrap_3/doc/Alpha_wrap_3/PackageDescription.txt b/Alpha_wrap_3/doc/Alpha_wrap_3/PackageDescription.txt index 883ea17c9f3..328084ce9a8 100644 --- a/Alpha_wrap_3/doc/Alpha_wrap_3/PackageDescription.txt +++ b/Alpha_wrap_3/doc/Alpha_wrap_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgAlphaWrap3Ref 3D Alpha Wrapping +/// \defgroup PkgAlphaWrap3Ref Reference Manual /// \defgroup AW3_free_functions_grp Free Functions /// Functions to create a wrap from point clouds, triangle soups, and triangle meshes. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt b/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt index 102f019f68c..9f9d5909963 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgApolloniusGraph2Ref 2D Apollonius Graphs (Delaunay Graphs of Disks) Reference +/// \defgroup PkgApolloniusGraph2Ref Reference Manual /// \defgroup PkgApolloniusGraph2Concepts Concepts /// \ingroup PkgApolloniusGraph2Ref /*! diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt index bae19005dc3..ea1b0b666e7 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgArrangementOnSurface2Ref 2D Arrangement Reference +/// \defgroup PkgArrangementOnSurface2Ref Reference Manual /// \defgroup PkgArrangementOnSurface2Concepts Concepts /// \ingroup PkgArrangementOnSurface2Ref diff --git a/BGL/doc/BGL/PackageDescription.txt b/BGL/doc/BGL/PackageDescription.txt index 93687510006..57a92c68be7 100644 --- a/BGL/doc/BGL/PackageDescription.txt +++ b/BGL/doc/BGL/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgBGLRef CGAL and the Boost Graph Library Reference +/// \defgroup PkgBGLRef Reference Manual /*! \defgroup PkgBGLConcepts Concepts \ingroup PkgBGLRef diff --git a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt index cb19750c5db..aa97705025b 100644 --- a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt +++ b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt @@ -1,8 +1,5 @@ -namespace CGAL { -namespace Barycentric_coordinates { - /*! -\defgroup PkgBarycentricCoordinates2Ref 2D Generalized Barycentric Coordinates Reference +\defgroup PkgBarycentricCoordinates2Ref Reference Manual \defgroup PkgBarycentricCoordinates2RefConcepts Concepts \ingroup PkgBarycentricCoordinates2Ref @@ -77,6 +74,3 @@ coordinates from the Package \ref PkgInterpolation2.} - `discrete_harmonic_coordinates_2()` - `boundary_coordinates_2()` */ - -} /* namespace Barycentric_coordinates */ -} /* namespace CGAL */ diff --git a/Basic_viewer/doc/Basic_viewer/PackageDescription.txt b/Basic_viewer/doc/Basic_viewer/PackageDescription.txt index d90a773fed5..da2de3d1e9b 100644 --- a/Basic_viewer/doc/Basic_viewer/PackageDescription.txt +++ b/Basic_viewer/doc/Basic_viewer/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgBasicViewerRef Basic Viewer Reference +/// \defgroup PkgBasicViewerRef Reference Manual /// \defgroup PkgBasicViewerConcepts Concepts /// \ingroup PkgBasicViewerRef diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt b/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt index d9e29fbf99a..85f62d9ea35 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgBooleanSetOperations2Ref 2D Regularized Boolean Set-Operations Reference +/// \defgroup PkgBooleanSetOperations2Ref Reference Manual /// \defgroup PkgBooleanSetOperations2Concepts Concepts /// \ingroup PkgBooleanSetOperations2Ref diff --git a/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt b/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt index 6777f112a5b..b4f9d89eb4b 100644 --- a/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt +++ b/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgBoundingVolumesRef Bounding Volumes Reference +/// \defgroup PkgBoundingVolumesRef Reference Manual /// \defgroup PkgBoundingVolumesConcepts Concepts /// \ingroup PkgBoundingVolumesRef /*! diff --git a/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt b/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt index e5adae34d21..80c0079f38b 100644 --- a/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt +++ b/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgBoxIntersectionDRef Intersecting Sequences of dD Iso-oriented Boxes Reference +/// \defgroup PkgBoxIntersectionDRef Reference Manual /// \defgroup PkgBoxIntersectionDConcepts Concepts /// \ingroup PkgBoxIntersectionDRef diff --git a/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt b/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt index 3f15baf90de..f46ea0dda8c 100644 --- a/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt +++ b/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgCGALIpeletsRef CGAL Ipelets Reference +/// \defgroup PkgCGALIpeletsRef Reference Manual /*! \addtogroup PkgCGALIpeletsRef \cgalPkgDescriptionBegin{CGAL Ipelets,PkgCGALIpelets} diff --git a/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt b/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt index 3092d4092ba..75052441fab 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt +++ b/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgCircularKernel2Ref 2D Circular Geometry Kernel Reference +/// \defgroup PkgCircularKernel2Ref Reference Manual /// \defgroup PkgCircularKernel2GeometricConcepts Geometric Concepts /// \ingroup PkgCircularKernel2Ref diff --git a/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt b/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt index 5f1aa8ea9a6..3df6588762b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt +++ b/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgCircularKernel3Ref 3D Spherical Geometry Kernel Reference +/// \defgroup PkgCircularKernel3Ref Reference Manual /// \defgroup PkgCircularKernel3GeometricConcepts Geometric Concepts /// \ingroup PkgCircularKernel3Ref diff --git a/Circulator/doc/Circulator/PackageDescription.txt b/Circulator/doc/Circulator/PackageDescription.txt index 4f6971cd65b..bcff8470c4e 100644 --- a/Circulator/doc/Circulator/PackageDescription.txt +++ b/Circulator/doc/Circulator/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgHandlesAndCirculatorsRef Handles and Circulators Reference +/// \defgroup PkgHandlesAndCirculatorsRef Reference Manual /// \defgroup PkgHandlesAndCirculatorsConcepts Concepts /// \ingroup PkgHandlesAndCirculatorsRef diff --git a/Classification/doc/Classification/PackageDescription.txt b/Classification/doc/Classification/PackageDescription.txt index 24784495683..94ae4dcaec4 100644 --- a/Classification/doc/Classification/PackageDescription.txt +++ b/Classification/doc/Classification/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgClassificationRef Classification Reference +/// \defgroup PkgClassificationRef Reference Manual /*! \defgroup PkgClassificationConcepts Concepts diff --git a/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt b/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt index 202866c0046..5016a763697 100644 --- a/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt +++ b/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgCombinatorialMapsRef Combinatorial Maps Reference +/// \defgroup PkgCombinatorialMapsRef Reference Manual /// \defgroup PkgCombinatorialMapsConcepts Concepts /// \ingroup PkgCombinatorialMapsRef diff --git a/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt b/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt index 6b59b805a38..9460f5d6fef 100644 --- a/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt +++ b/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgConeSpanners2Ref Cone-Based Spanners Reference +/// \defgroup PkgConeSpanners2Ref Reference Manual /*! \addtogroup PkgConeSpanners2Ref diff --git a/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt b/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt index 2e386901cca..fac4f8479c7 100644 --- a/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt +++ b/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgConvexDecomposition3Ref Convex Decomposition of Polyhedra Reference +/// \defgroup PkgConvexDecomposition3Ref Reference Manual /*! \addtogroup PkgConvexDecomposition3Ref diff --git a/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt b/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt index 7fa7625b04f..8a0e81aa648 100644 --- a/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt +++ b/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgConvexHull2Ref 2D Convex Hulls and Extreme Points Reference +/// \defgroup PkgConvexHull2Ref Reference Manual /// \defgroup PkgConvexHull2Concepts Concepts /// \ingroup PkgConvexHull2Ref diff --git a/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt b/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt index 17134ef6c71..f8530e90c99 100644 --- a/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt +++ b/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgConvexHull3Ref 3D Convex Hulls Reference +/// \defgroup PkgConvexHull3Ref Reference Manual /// \defgroup PkgConvexHull3Concepts Concepts /// \ingroup PkgConvexHull3Ref diff --git a/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt b/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt index bf45d7bfeb3..2d9f3b16163 100644 --- a/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt +++ b/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgConvexHullDRef dD Convex Hulls and Delaunay Triangulations Reference +/// \defgroup PkgConvexHullDRef Reference Manual /// \defgroup PkgConvexHullDConcepts Concepts /// \ingroup PkgConvexHullDRef /*! diff --git a/Envelope_2/doc/Envelope_2/PackageDescription.txt b/Envelope_2/doc/Envelope_2/PackageDescription.txt index 0fe4c06e4ea..c4da5cd042e 100644 --- a/Envelope_2/doc/Envelope_2/PackageDescription.txt +++ b/Envelope_2/doc/Envelope_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgEnvelope2Ref 2D Envelopes Reference +/// \defgroup PkgEnvelope2Ref Reference Manual /// \defgroup PkgEnvelope2Concepts Concepts /// \ingroup PkgEnvelope2Ref /*! diff --git a/Envelope_3/doc/Envelope_3/PackageDescription.txt b/Envelope_3/doc/Envelope_3/PackageDescription.txt index 920f6b7054b..bbaa343b150 100644 --- a/Envelope_3/doc/Envelope_3/PackageDescription.txt +++ b/Envelope_3/doc/Envelope_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgEnvelope3Ref 3D Envelopes Reference +/// \defgroup PkgEnvelope3Ref Reference Manual /// \defgroup PkgEnvelope3Concepts Concepts /// \ingroup PkgEnvelope3Ref /*! diff --git a/Generalized_map/doc/Generalized_map/PackageDescription.txt b/Generalized_map/doc/Generalized_map/PackageDescription.txt index 1d3b4236aaf..5d583be2db0 100644 --- a/Generalized_map/doc/Generalized_map/PackageDescription.txt +++ b/Generalized_map/doc/Generalized_map/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgGeneralizedMapsRef Generalized Maps Reference +/// \defgroup PkgGeneralizedMapsRef Reference Manual /// \defgroup PkgGeneralizedMapsConcepts Concepts /// \ingroup PkgGeneralizedMapsRef diff --git a/Generator/doc/Generator/PackageDescription.txt b/Generator/doc/Generator/PackageDescription.txt index efee2250337..361419d9c33 100644 --- a/Generator/doc/Generator/PackageDescription.txt +++ b/Generator/doc/Generator/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgGeneratorsRef Geometric Object Generators Reference +/// \defgroup PkgGeneratorsRef Reference Manual /// \defgroup PkgGeneratorsConcepts Concepts /// \ingroup PkgGeneratorsRef /*! diff --git a/GraphicsView/doc/GraphicsView/PackageDescription.txt b/GraphicsView/doc/GraphicsView/PackageDescription.txt index 3c32ad7863c..b95109777fc 100644 --- a/GraphicsView/doc/GraphicsView/PackageDescription.txt +++ b/GraphicsView/doc/GraphicsView/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgGraphicsViewRef CGAL and the Qt Graphics View Framework Reference +/// \defgroup PkgGraphicsViewRef Reference Manual /// \defgroup PkgGraphicsViewGraphicsItemClasses Graphics Item Classes /// \ingroup PkgGraphicsViewRef /// \defgroup PkgGraphicsViewInputClasses Input Classes diff --git a/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt b/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt index ea6800cd6b1..64f9a951f2a 100644 --- a/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt +++ b/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgHalfedgeDSRef Halfedge Data Structures Reference +/// \defgroup PkgHalfedgeDSRef Reference Manual /// \defgroup PkgHalfedgeDSConcepts Concepts /// \ingroup PkgHalfedgeDSRef diff --git a/Heat_method_3/doc/Heat_method_3/PackageDescription.txt b/Heat_method_3/doc/Heat_method_3/PackageDescription.txt index 524591e2d7f..92c1ce5ee76 100644 --- a/Heat_method_3/doc/Heat_method_3/PackageDescription.txt +++ b/Heat_method_3/doc/Heat_method_3/PackageDescription.txt @@ -1,6 +1,4 @@ -// The Heat Method - -/// \defgroup PkgHeatMethodRef Heat Method Reference +/// \defgroup PkgHeatMethodRef Reference Manual /// \defgroup PkgHeatMethodConcepts Concepts /// \ingroup PkgHeatMethodRef diff --git a/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/PackageDescription.txt b/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/PackageDescription.txt index eb96082b7c3..c347636ff34 100644 --- a/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/PackageDescription.txt +++ b/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgHyperbolicTriangulation2Ref 2D Hyperbolic Delaunay Triangulations Reference +/// \defgroup PkgHyperbolicTriangulation2Ref Reference Manual /// \defgroup PkgHyperbolicTriangulation2Concepts Concepts /// \ingroup PkgHyperbolicTriangulation2Ref diff --git a/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt b/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt index aa77a9b9cc9..23a9b6d97dc 100644 --- a/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt +++ b/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgInscribedAreasRef Inscribed Areas Reference +/// \defgroup PkgInscribedAreasRef Reference Manual /// \defgroup PkgInscribedAreasConcepts Concepts /// \ingroup PkgInscribedAreasRef diff --git a/Interpolation/doc/Interpolation/PackageDescription.txt b/Interpolation/doc/Interpolation/PackageDescription.txt index 3800f5a9ccf..f76c55d40ee 100644 --- a/Interpolation/doc/Interpolation/PackageDescription.txt +++ b/Interpolation/doc/Interpolation/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgInterpolation2Ref 2D and Surface Function Interpolation Reference +/// \defgroup PkgInterpolation2Ref Reference Manual /// \defgroup PkgInterpolation2Concepts Concepts /// \ingroup PkgInterpolation2Ref diff --git a/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt b/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt index e7db8cc6251..556d5c7b115 100644 --- a/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt +++ b/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgIntervalSkipListRef Interval Skip List Reference +/// \defgroup PkgIntervalSkipListRef Reference Manual /// \defgroup PkgIntervalSkipListConcepts Concepts /// \ingroup PkgIntervalSkipListRef /*! diff --git a/Isosurfacing_3/doc/Isosurfacing_3/PackageDescription.txt b/Isosurfacing_3/doc/Isosurfacing_3/PackageDescription.txt index c7df5e6b418..0a74fe28740 100644 --- a/Isosurfacing_3/doc/Isosurfacing_3/PackageDescription.txt +++ b/Isosurfacing_3/doc/Isosurfacing_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgIsosurfacing3Ref 3D Isosurfacing Reference +/// \defgroup PkgIsosurfacing3Ref Reference Manual /// \defgroup PkgIsosurfacing3Concepts Concepts /// \ingroup PkgIsosurfacing3Ref diff --git a/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt b/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt index 90af6ff6785..2074cb659b3 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt +++ b/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgJetFitting3Ref Estimation of Local Differential Properties of Point-Sampled Surfaces Reference +/// \defgroup PkgJetFitting3Ref Reference Manual /// \defgroup PkgJetFitting3Concepts Concepts /// \ingroup PkgJetFitting3Ref /*! diff --git a/Kernel_23/doc/Kernel_23/PackageDescription.txt b/Kernel_23/doc/Kernel_23/PackageDescription.txt index 71f339fd082..f9b9d6991e7 100644 --- a/Kernel_23/doc/Kernel_23/PackageDescription.txt +++ b/Kernel_23/doc/Kernel_23/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgKernel23Ref 2D and 3D Linear Geometry Kernel Reference +/// \defgroup PkgKernel23Ref Reference Manual /// \defgroup PkgKernel23Concepts Concepts /// \ingroup PkgKernel23Ref diff --git a/Kernel_d/doc/Kernel_d/PackageDescription.txt b/Kernel_d/doc/Kernel_d/PackageDescription.txt index 783f291db01..106d47cb7bf 100644 --- a/Kernel_d/doc/Kernel_d/PackageDescription.txt +++ b/Kernel_d/doc/Kernel_d/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgKernelDRef dD Geometry Kernel Reference +/// \defgroup PkgKernelDRef Reference Manual /// \defgroup PkgKernelDLinAlgConcepts Linear Algebra Concepts /// \ingroup PkgKernelDRef diff --git a/Kinetic_space_partition/doc/Kinetic_space_partition/PackageDescription.txt b/Kinetic_space_partition/doc/Kinetic_space_partition/PackageDescription.txt index c0e9c21b476..80b03cbd7c4 100644 --- a/Kinetic_space_partition/doc/Kinetic_space_partition/PackageDescription.txt +++ b/Kinetic_space_partition/doc/Kinetic_space_partition/PackageDescription.txt @@ -1,5 +1,5 @@ /*! -\defgroup PkgKineticSpacePartitionRef Kinetic Space Partition Reference +\defgroup PkgKineticSpacePartitionRef Reference Manual \defgroup PkgKineticSpacePartitionConcepts Concepts \ingroup PkgKineticSpacePartitionRef diff --git a/Kinetic_surface_reconstruction/doc/Kinetic_surface_reconstruction/PackageDescription.txt b/Kinetic_surface_reconstruction/doc/Kinetic_surface_reconstruction/PackageDescription.txt index 02fae11525d..4ca51b048d4 100644 --- a/Kinetic_surface_reconstruction/doc/Kinetic_surface_reconstruction/PackageDescription.txt +++ b/Kinetic_surface_reconstruction/doc/Kinetic_surface_reconstruction/PackageDescription.txt @@ -1,5 +1,5 @@ /*! -\defgroup PkgKineticSurfaceReconstructionRef Kinetic Surface Reconstruction Reference +\defgroup PkgKineticSurfaceReconstructionRef Reference Manual \addtogroup PkgKineticSurfaceReconstructionRef \cgalPkgDescriptionBegin{Kinetic Surface Reconstruction, PkgKineticSurfaceReconstruction} diff --git a/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt b/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt index a9ead2ceac0..caf7173fbee 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt +++ b/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgLinearCellComplexRef Linear Cell Complex Reference +/// \defgroup PkgLinearCellComplexRef Reference Manual /// \defgroup PkgLinearCellComplexConcepts Concepts /// \ingroup PkgLinearCellComplexRef diff --git a/Matrix_search/doc/Matrix_search/PackageDescription.txt b/Matrix_search/doc/Matrix_search/PackageDescription.txt index 1dabc40e68c..660f5a3ad66 100644 --- a/Matrix_search/doc/Matrix_search/PackageDescription.txt +++ b/Matrix_search/doc/Matrix_search/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgMatrixSearchRef Monotone and Sorted Matrix Search Reference +/// \defgroup PkgMatrixSearchRef Reference Manual /// \defgroup PkgMatrixSearchConcepts Concepts /// \ingroup PkgMatrixSearchRef diff --git a/Mesh_2/doc/Mesh_2/PackageDescription.txt b/Mesh_2/doc/Mesh_2/PackageDescription.txt index 458e3bf6b05..4b68cc1389c 100644 --- a/Mesh_2/doc/Mesh_2/PackageDescription.txt +++ b/Mesh_2/doc/Mesh_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgMesh2Ref 2D Conforming Triangulations and Meshes Reference +/// \defgroup PkgMesh2Ref Reference Manual /// \defgroup PkgMesh2Concepts Concepts /// \ingroup PkgMesh2Ref diff --git a/Mesh_3/doc/Mesh_3/PackageDescription.txt b/Mesh_3/doc/Mesh_3/PackageDescription.txt index 926491fc627..9de466df99f 100644 --- a/Mesh_3/doc/Mesh_3/PackageDescription.txt +++ b/Mesh_3/doc/Mesh_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgMesh3Ref 3D Mesh Generation Reference +/// \defgroup PkgMesh3Ref Reference Manual /// \defgroup PkgMesh3Concepts Main Concepts /// \ingroup PkgMesh3Ref diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt b/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt index bb770a24620..d2d6d6199d6 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgMinkowskiSum2Ref 2D Minkowski Sums Reference +/// \defgroup PkgMinkowskiSum2Ref Reference Manual /// \defgroup PkgMinkowskiSum2Concepts Concepts /// \ingroup PkgMinkowskiSum2Ref diff --git a/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt b/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt index 5f467e1e05f..2e41020ef53 100644 --- a/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt +++ b/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgMinkowskiSum3Ref 3D Minkowski Sum of Polyhedra Reference +/// \defgroup PkgMinkowskiSum3Ref Reference Manual /*! \addtogroup PkgMinkowskiSum3Ref diff --git a/Miscellany/doc/Miscellany/PackageDescription.txt b/Miscellany/doc/Miscellany/PackageDescription.txt index a4fbd2da549..c3795981dd9 100644 --- a/Miscellany/doc/Miscellany/PackageDescription.txt +++ b/Miscellany/doc/Miscellany/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup MiscellanyRef Profiling Tools, Hash Map, Union-find, Modifiers Reference +/// \defgroup MiscellanyRef Reference Manual /// \defgroup MiscellanyConcepts Concepts /// \ingroup MiscellanyRef /*! diff --git a/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt b/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt index 0d7b0e90757..a13c67cfbde 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt +++ b/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgModularArithmeticRef Modular Arithmetic Reference +/// \defgroup PkgModularArithmeticRef Reference Manual /// \defgroup PkgModularArithmeticConcepts Concepts /// \ingroup PkgModularArithmeticRef /*! diff --git a/Nef_2/doc/Nef_2/PackageDescription.txt b/Nef_2/doc/Nef_2/PackageDescription.txt index 431ae610e7c..43c958c43ef 100644 --- a/Nef_2/doc/Nef_2/PackageDescription.txt +++ b/Nef_2/doc/Nef_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgNef2Ref 2D Boolean Operations on Nef Polygons Reference +/// \defgroup PkgNef2Ref Reference Manual /// \defgroup PkgNef2Concepts Concepts /// \ingroup PkgNef2Ref /*! diff --git a/Nef_3/doc/Nef_3/PackageDescription.txt b/Nef_3/doc/Nef_3/PackageDescription.txt index 6f591bcfb6c..392c4b3c75c 100644 --- a/Nef_3/doc/Nef_3/PackageDescription.txt +++ b/Nef_3/doc/Nef_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgNef3Ref 3D Boolean Operations on Nef Polyhedra Reference +/// \defgroup PkgNef3Ref Reference Manual /// /// \defgroup PkgNef3IOFunctions I/O Functions /// \ingroup PkgNef3Ref diff --git a/Nef_S2/doc/Nef_S2/PackageDescription.txt b/Nef_S2/doc/Nef_S2/PackageDescription.txt index f85581381e8..5cc86eb32f7 100644 --- a/Nef_S2/doc/Nef_S2/PackageDescription.txt +++ b/Nef_S2/doc/Nef_S2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgNefS2Ref 2D Boolean Operations on Nef Polygons Embedded on the Sphere Reference +/// \defgroup PkgNefS2Ref Reference Manual /*! \addtogroup PkgNefS2Ref diff --git a/Number_types/doc/Number_types/PackageDescription.txt b/Number_types/doc/Number_types/PackageDescription.txt index ba551f7c153..91898eddb5b 100644 --- a/Number_types/doc/Number_types/PackageDescription.txt +++ b/Number_types/doc/Number_types/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgNumberTypesRef Number Types Reference +/// \defgroup PkgNumberTypesRef Reference Manual /// \defgroup PkgNumberTypesConcepts Concepts /// \ingroup PkgNumberTypesRef diff --git a/Optimal_bounding_box/doc/Optimal_bounding_box/PackageDescription.txt b/Optimal_bounding_box/doc/Optimal_bounding_box/PackageDescription.txt index 994cb41bbef..b332dd4494d 100644 --- a/Optimal_bounding_box/doc/Optimal_bounding_box/PackageDescription.txt +++ b/Optimal_bounding_box/doc/Optimal_bounding_box/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgOptimalBoundingBoxRef Optimal Bounding Box Reference +/// \defgroup PkgOptimalBoundingBoxRef Reference Manual /// \defgroup PkgOptimalBoundingBoxConcepts Concepts /// \ingroup PkgOptimalBoundingBoxRef diff --git a/Optimal_transportation_reconstruction_2/doc/Optimal_transportation_reconstruction_2/PackageDescription.txt b/Optimal_transportation_reconstruction_2/doc/Optimal_transportation_reconstruction_2/PackageDescription.txt index 66636bca10b..3bd06554ae3 100644 --- a/Optimal_transportation_reconstruction_2/doc/Optimal_transportation_reconstruction_2/PackageDescription.txt +++ b/Optimal_transportation_reconstruction_2/doc/Optimal_transportation_reconstruction_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgOptimalTransportationReconstruction2Ref Optimal Transportation Curve Reconstruction Reference +/// \defgroup PkgOptimalTransportationReconstruction2Ref Reference Manual /// \defgroup PkgOptimalTransportationReconstruction2Concepts Concepts /// \ingroup PkgOptimalTransportationReconstruction2Ref diff --git a/Orthtree/doc/Orthtree/PackageDescription.txt b/Orthtree/doc/Orthtree/PackageDescription.txt index 98825d8e237..a39a141f81c 100644 --- a/Orthtree/doc/Orthtree/PackageDescription.txt +++ b/Orthtree/doc/Orthtree/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgOrthtreeRef Quadtrees, Octrees and Orthtrees Reference +/// \defgroup PkgOrthtreeRef Reference Manual Quadtree, Octree and Orthtree Reference /// \defgroup PkgOrthtreeConcepts Concepts diff --git a/Partition_2/doc/Partition_2/PackageDescription.txt b/Partition_2/doc/Partition_2/PackageDescription.txt index 2d33fd123ce..c97c815c64d 100644 --- a/Partition_2/doc/Partition_2/PackageDescription.txt +++ b/Partition_2/doc/Partition_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPartition2Ref 2D Polygon Partitioning Reference +/// \defgroup PkgPartition2Ref Reference Manual /// \defgroup PkgPartition2Concepts Concepts /// \ingroup PkgPartition2Ref /// \defgroup PkgPartition2FunctionObjectConcepts Function Object Concepts diff --git a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt index 3c527f6fdd2..39c580cff30 100644 --- a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt +++ b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPeriodic2Triangulation2Ref 2D Periodic Triangulations Reference +/// \defgroup PkgPeriodic2Triangulation2Ref Reference Manual /// \defgroup PkgPeriodic2Triangulation2Concepts Concepts /// \ingroup PkgPeriodic2Triangulation2Ref diff --git a/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/PackageDescription.txt b/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/PackageDescription.txt index f93700399ec..c42bc7a74b6 100644 --- a/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/PackageDescription.txt +++ b/Periodic_3_mesh_3/doc/Periodic_3_mesh_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPeriodic3Mesh3Ref 3D Periodic Mesh Generation Reference +/// \defgroup PkgPeriodic3Mesh3Ref Reference Manual /// \defgroup PkgPeriodic3Mesh3Concepts Concepts /// \ingroup PkgPeriodic3Mesh3Ref diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt index fefa62fa8f6..8d219074e05 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPeriodic3Triangulation3Ref 3D Periodic Triangulations Reference +/// \defgroup PkgPeriodic3Triangulation3Ref Reference Manual /// \defgroup PkgPeriodic3Triangulation3Concepts Concepts /// \ingroup PkgPeriodic3Triangulation3Ref diff --git a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt index f5b7200ee7e..3709d89b78b 100644 --- a/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt +++ b/Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPeriodic4HyperbolicTriangulation2Ref 2D Periodic Hyperbolic Triangulations Reference +/// \defgroup PkgPeriodic4HyperbolicTriangulation2Ref Reference Manual /// \defgroup PkgPeriodic4HyperbolicTriangulation2Concepts Concepts /// \ingroup PkgPeriodic4HyperbolicTriangulation2Ref diff --git a/Point_set_2/doc/Point_set_2/PackageDescription.txt b/Point_set_2/doc/Point_set_2/PackageDescription.txt index bf3a90fd689..2bd3b84c548 100644 --- a/Point_set_2/doc/Point_set_2/PackageDescription.txt +++ b/Point_set_2/doc/Point_set_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPointSet2Ref 2D Range and Neighbor Search Reference +/// \defgroup PkgPointSet2Ref Reference Manual /// \defgroup PkgPointSet2Concepts Concepts /// \ingroup PkgPointSet2Ref diff --git a/Point_set_3/doc/Point_set_3/PackageDescription.txt b/Point_set_3/doc/Point_set_3/PackageDescription.txt index 78599903870..ff2bbcbc02e 100644 --- a/Point_set_3/doc/Point_set_3/PackageDescription.txt +++ b/Point_set_3/doc/Point_set_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPointSet3Ref 3D Point Set Reference +/// \defgroup PkgPointSet3Ref Reference Manual /*! \cgalInclude{CGAL/draw_point_set_3.h} diff --git a/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt b/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt index 7107d1bd198..f351e426e8f 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPointSetProcessing3Ref Point Set Processing Reference +/// \defgroup PkgPointSetProcessing3Ref Reference Manual /*! \defgroup PkgPointSetProcessing3Algorithms Algorithms diff --git a/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/PackageDescription.txt b/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/PackageDescription.txt index 8aee390473b..7cc67812dbd 100644 --- a/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/PackageDescription.txt +++ b/Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPoissonSurfaceReconstruction3Ref Poisson Surface Reconstruction Reference +/// \defgroup PkgPoissonSurfaceReconstruction3Ref Reference Manual /*! \addtogroup PkgPoissonSurfaceReconstruction3Ref \cgalPkgDescriptionBegin{Poisson Surface Reconstruction,PkgPoissonSurfaceReconstruction3} diff --git a/Polygon/doc/Polygon/PackageDescription.txt b/Polygon/doc/Polygon/PackageDescription.txt index 8083eb8e15b..a96bb2c8d32 100644 --- a/Polygon/doc/Polygon/PackageDescription.txt +++ b/Polygon/doc/Polygon/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPolygon2Ref 2D Polygon Reference +/// \defgroup PkgPolygon2Ref Reference Manual /// \defgroup PkgPolygon2Concepts Concepts /// \ingroup PkgPolygon2Ref diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt index 39b10beabe1..700ec7fdac0 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPolygonMeshProcessingRef Polygon Mesh Processing Reference +/// \defgroup PkgPolygonMeshProcessingRef Reference Manual /// \defgroup PkgPolygonMeshProcessingConcepts Concepts /// \ingroup PkgPolygonMeshProcessingRef diff --git a/Polygon_repair/doc/Polygon_repair/PackageDescription.txt b/Polygon_repair/doc/Polygon_repair/PackageDescription.txt index 3a311dd0cd1..78767d4cf18 100644 --- a/Polygon_repair/doc/Polygon_repair/PackageDescription.txt +++ b/Polygon_repair/doc/Polygon_repair/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPolygonRepairRef 2D Polygon Repair Reference +/// \defgroup PkgPolygonRepairRef Reference Manual /// \defgroup PkgPolygonRepairFunctions Functions /// \ingroup PkgPolygonRepairRef diff --git a/Polygonal_surface_reconstruction/doc/Polygonal_surface_reconstruction/PackageDescription.txt b/Polygonal_surface_reconstruction/doc/Polygonal_surface_reconstruction/PackageDescription.txt index 2bbf0b19b6e..467b75bb0fd 100644 --- a/Polygonal_surface_reconstruction/doc/Polygonal_surface_reconstruction/PackageDescription.txt +++ b/Polygonal_surface_reconstruction/doc/Polygonal_surface_reconstruction/PackageDescription.txt @@ -1,6 +1,4 @@ -// Polygonal Surface Reconstruction should equal the project title in Doxyfile.in - -/// \defgroup PkgPolygonalSurfaceReconstructionRef Polygonal Surface Reconstruction Reference +/// \defgroup PkgPolygonalSurfaceReconstructionRef Reference Manual /*! \addtogroup PkgPolygonalSurfaceReconstructionRef diff --git a/Polyhedron/doc/Polyhedron/PackageDescription.txt b/Polyhedron/doc/Polyhedron/PackageDescription.txt index f0033c7efd7..27cc5bcbd99 100644 --- a/Polyhedron/doc/Polyhedron/PackageDescription.txt +++ b/Polyhedron/doc/Polyhedron/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPolyhedronRef 3D Polyhedral Surface Reference +/// \defgroup PkgPolyhedronRef Reference Manual /// \defgroup PkgPolyhedronConcepts Concepts /// \ingroup PkgPolyhedronRef diff --git a/Polyline_simplification_2/doc/Polyline_simplification_2/PackageDescription.txt b/Polyline_simplification_2/doc/Polyline_simplification_2/PackageDescription.txt index 8944dbadbb8..26d18b9d541 100644 --- a/Polyline_simplification_2/doc/Polyline_simplification_2/PackageDescription.txt +++ b/Polyline_simplification_2/doc/Polyline_simplification_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPolylineSimplification2Ref 2D Polyline Simplification Reference +/// \defgroup PkgPolylineSimplification2Ref Reference Manual /// \defgroup PkgPolylineSimplification2Concepts Concepts /// \ingroup PkgPolylineSimplification2Ref diff --git a/Polynomial/doc/Polynomial/PackageDescription.txt b/Polynomial/doc/Polynomial/PackageDescription.txt index 96273a5ada8..929a91b02c6 100644 --- a/Polynomial/doc/Polynomial/PackageDescription.txt +++ b/Polynomial/doc/Polynomial/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPolynomialRef Polynomial Reference +/// \defgroup PkgPolynomialRef Reference Manual /// \defgroup PkgPolynomialConcepts Concepts /// \ingroup PkgPolynomialRef diff --git a/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt b/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt index b49377cf9ed..d5284e50354 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt +++ b/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPolytopeDistanceDRef Optimal Distances Reference +/// \defgroup PkgPolytopeDistanceDRef Reference Manual /// \defgroup PkgPolytopeDistanceDConcepts Concepts /// \ingroup PkgPolytopeDistanceDRef diff --git a/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt b/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt index 03acad4f33b..de1e1e5a04e 100644 --- a/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt +++ b/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPrincipalComponentAnalysisDRef Principal Component Analysis Reference +/// \defgroup PkgPrincipalComponentAnalysisDRef Reference Manual /// \defgroup PkgPrincipalComponentAnalysisDBary CGAL::barycenter() /// \ingroup PkgPrincipalComponentAnalysisDRef diff --git a/Property_map/doc/Property_map/PackageDescription.txt b/Property_map/doc/Property_map/PackageDescription.txt index 0f52bd4e7b7..60fac46a48e 100644 --- a/Property_map/doc/Property_map/PackageDescription.txt +++ b/Property_map/doc/Property_map/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgPropertyMapRef CGAL and Boost Property Maps Reference +/// \defgroup PkgPropertyMapRef Reference Manual /*! \addtogroup PkgPropertyMapRef diff --git a/QP_solver/doc/QP_solver/PackageDescription.txt b/QP_solver/doc/QP_solver/PackageDescription.txt index 0da82f7f3b6..57e0e238589 100644 --- a/QP_solver/doc/QP_solver/PackageDescription.txt +++ b/QP_solver/doc/QP_solver/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgQPSolverRef Linear and Quadratic Programming Solver Reference +/// \defgroup PkgQPSolverRef Reference Manual /*! \defgroup PkgQPSolverConcepts Concepts \ingroup PkgQPSolverRef diff --git a/Ridges_3/doc/Ridges_3/PackageDescription.txt b/Ridges_3/doc/Ridges_3/PackageDescription.txt index 5c06986a879..388f5a534dc 100644 --- a/Ridges_3/doc/Ridges_3/PackageDescription.txt +++ b/Ridges_3/doc/Ridges_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgRidges3Ref Approximation of Ridges and Umbilics on Triangulated Surface Meshes Reference +/// \defgroup PkgRidges3Ref Reference Manual /// \defgroup PkgRidges3Enums Enums /// \ingroup PkgRidges3Ref diff --git a/SMDS_3/doc/SMDS_3/PackageDescription.txt b/SMDS_3/doc/SMDS_3/PackageDescription.txt index 7384e5682c0..c3d9d6d6cd8 100644 --- a/SMDS_3/doc/SMDS_3/PackageDescription.txt +++ b/SMDS_3/doc/SMDS_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSMDS3Ref 3D Simplicial Mesh Data Structures Reference +/// \defgroup PkgSMDS3Ref Reference Manual /// \defgroup PkgSMDS3Concepts Concepts /// \ingroup PkgSMDS3Ref diff --git a/STL_Extension/doc/STL_Extension/PackageDescription.txt b/STL_Extension/doc/STL_Extension/PackageDescription.txt index 266a3b15f52..1580d503f9d 100644 --- a/STL_Extension/doc/STL_Extension/PackageDescription.txt +++ b/STL_Extension/doc/STL_Extension/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSTLExtensionRef STL Extensions for CGAL Reference +/// \defgroup PkgSTLExtensionRef Reference Manual /// \defgroup PkgSTLExtensionConcepts Concepts /// \ingroup PkgSTLExtensionRef diff --git a/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/PackageDescription.txt b/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/PackageDescription.txt index 08d1f716eb2..a02396244c2 100644 --- a/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/PackageDescription.txt +++ b/Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgScaleSpaceReconstruction3Ref Scale-Space Surface Reconstruction Reference +/// \defgroup PkgScaleSpaceReconstruction3Ref Reference Manual /// \defgroup PkgScaleSpaceReconstruction3Concepts Concepts /// \ingroup PkgScaleSpaceReconstruction3Ref diff --git a/SearchStructures/doc/SearchStructures/PackageDescription.txt b/SearchStructures/doc/SearchStructures/PackageDescription.txt index 3fdc12fd5b8..b912c17c53d 100644 --- a/SearchStructures/doc/SearchStructures/PackageDescription.txt +++ b/SearchStructures/doc/SearchStructures/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSearchStructuresRef dD Range and Segment Trees Reference +/// \defgroup PkgSearchStructuresRef Reference Manual /// \defgroup PkgSearchStructuresConcepts Concepts /// \ingroup PkgSearchStructuresRef diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt index 8db5cfb3b9b..d617f6ad2ef 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSegmentDelaunayGraph2Ref 2D Segment Delaunay Graphs Reference +/// \defgroup PkgSegmentDelaunayGraph2Ref Reference Manual /// \defgroup PkgSegmentDelaunayGraph2Concepts Concepts /// \ingroup PkgSegmentDelaunayGraph2Ref /*! diff --git a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/PackageDescription.txt b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/PackageDescription.txt index 42096623238..c049367585b 100644 --- a/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/PackageDescription.txt +++ b/Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSegmentDelaunayGraphLinf2Ref L Infinity Segment Delaunay Graphs Reference +/// \defgroup PkgSegmentDelaunayGraphLinf2Ref Reference Manual /// \defgroup PkgSegmentDelaunayGraphLinf2Concepts Concepts /// \ingroup PkgSegmentDelaunayGraphLinf2Ref diff --git a/Set_movable_separability_2/doc/Set_movable_separability_2/PackageDescription.txt b/Set_movable_separability_2/doc/Set_movable_separability_2/PackageDescription.txt index cf30ff00507..b5d6207296e 100644 --- a/Set_movable_separability_2/doc/Set_movable_separability_2/PackageDescription.txt +++ b/Set_movable_separability_2/doc/Set_movable_separability_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSetMovableSeparability2Ref 2D Movable Separability of Sets Reference +/// \defgroup PkgSetMovableSeparability2Ref Reference Manual /// \defgroup top_edges_grp Top Edges /// These function determine whether a cavity (of a mold in the plane) diff --git a/Shape_detection/doc/Shape_detection/PackageDescription.txt b/Shape_detection/doc/Shape_detection/PackageDescription.txt index e1efc07b3dd..6e8530ce9f0 100644 --- a/Shape_detection/doc/Shape_detection/PackageDescription.txt +++ b/Shape_detection/doc/Shape_detection/PackageDescription.txt @@ -1,7 +1,5 @@ - -// RANSAC /*! -\defgroup PkgShapeDetectionRef Shape Detection Reference +\defgroup PkgShapeDetectionRef Reference Manual \defgroup PkgShapeDetectionRANSAC Efficient RANSAC \ingroup PkgShapeDetectionRef diff --git a/Shape_regularization/doc/Shape_regularization/PackageDescription.txt b/Shape_regularization/doc/Shape_regularization/PackageDescription.txt index e274c857c40..f22c7cbe09c 100644 --- a/Shape_regularization/doc/Shape_regularization/PackageDescription.txt +++ b/Shape_regularization/doc/Shape_regularization/PackageDescription.txt @@ -1,8 +1,5 @@ -namespace CGAL { -namespace Shape_regularization { - /*! -\defgroup PkgShapeRegularizationRef Shape Regularization Reference +\defgroup PkgShapeRegularizationRef Reference Manual \defgroup PkgShapeRegularizationRefConcepts Concepts \ingroup PkgShapeRegularizationRef @@ -100,6 +97,3 @@ to the user-specified conditions.} ### QP Regularization ### - `QP_regularization` */ - -} /* namespace Shape_regularization */ -} /* namespace CGAL */ diff --git a/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt b/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt index 2945d9f75b3..67f8d8a5b95 100644 --- a/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt +++ b/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSkinSurface3Ref 3D Skin Surface Meshing Reference +/// \defgroup PkgSkinSurface3Ref Reference Manual /// \defgroup PkgSkinSurface3Concepts Concepts /// \ingroup PkgSkinSurface3Ref diff --git a/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt b/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt index 58e533bedcf..9426f5b4808 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt +++ b/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSnapRounding2Ref 2D Snap Rounding Reference +/// \defgroup PkgSnapRounding2Ref Reference Manual /// \defgroup PkgSnapRounding2Concepts Concepts /// \ingroup PkgSnapRounding2Ref /*! diff --git a/Solver_interface/doc/Solver_interface/PackageDescription.txt b/Solver_interface/doc/Solver_interface/PackageDescription.txt index 55f61bed124..6e6c1902cf0 100644 --- a/Solver_interface/doc/Solver_interface/PackageDescription.txt +++ b/Solver_interface/doc/Solver_interface/PackageDescription.txt @@ -1,5 +1,5 @@ /*! -\defgroup PkgSolverInterfaceRef CGAL and Solvers Reference +\defgroup PkgSolverInterfaceRef Reference Manual \defgroup PkgSolverInterfaceConcepts Concepts \ingroup PkgSolverInterfaceRef diff --git a/Spatial_searching/doc/Spatial_searching/PackageDescription.txt b/Spatial_searching/doc/Spatial_searching/PackageDescription.txt index 0ba29710374..bcd161d7cea 100644 --- a/Spatial_searching/doc/Spatial_searching/PackageDescription.txt +++ b/Spatial_searching/doc/Spatial_searching/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSpatialSearchingDRef dD Spatial Searching Reference +/// \defgroup PkgSpatialSearchingDRef Reference Manual /// \defgroup PkgSpatialSearchingDConcepts Concepts /// \ingroup PkgSpatialSearchingDRef diff --git a/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt b/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt index 0960831b264..2ccf6db8f73 100644 --- a/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt +++ b/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSpatialSortingRef Spatial Sorting Reference +/// \defgroup PkgSpatialSortingRef Reference Manual /// \defgroup PkgSpatialSortingConcepts Concepts /// \ingroup PkgSpatialSortingRef diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt b/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt index a035d036665..99b781303b2 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgStraightSkeleton2Ref 2D Straight Skeleton and Polygon Offsetting Reference +/// \defgroup PkgStraightSkeleton2Ref Reference Manual /// \defgroup PkgStraightSkeleton2Concepts Concepts /// \ingroup PkgStraightSkeleton2Ref diff --git a/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt b/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt index 42733d78f85..9615a377a36 100644 --- a/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt +++ b/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgStreamLines2Ref 2D Placement of Streamlines Reference +/// \defgroup PkgStreamLines2Ref Reference Manual /// \defgroup PkgStreamLines2Concepts Concepts /// \ingroup PkgStreamLines2Ref /*! diff --git a/Stream_support/doc/Stream_support/PackageDescription.txt b/Stream_support/doc/Stream_support/PackageDescription.txt index 0cacc80c631..2d97d36e3c1 100644 --- a/Stream_support/doc/Stream_support/PackageDescription.txt +++ b/Stream_support/doc/Stream_support/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgStreamSupportRef I/O Streams Reference +/// \defgroup PkgStreamSupportRef Reference Manual /// \defgroup IOstreamOperators Stream Operators /// \ingroup PkgStreamSupportRef /// \defgroup IOstreamFunctions I/O Functions diff --git a/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt b/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt index bdd1a46337c..efd456b9904 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt +++ b/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSurfaceSubdivisionMethod3Ref 3D Surface Subdivision Methods Reference +/// \defgroup PkgSurfaceSubdivisionMethod3Ref Reference Manual /// \defgroup PkgSurfaceSubdivisionMethod3Concepts Concepts /// \ingroup PkgSurfaceSubdivisionMethod3Ref diff --git a/Surface_mesh_approximation/doc/Surface_mesh_approximation/PackageDescription.txt b/Surface_mesh_approximation/doc/Surface_mesh_approximation/PackageDescription.txt index 66ac1fb214e..2a262f74824 100644 --- a/Surface_mesh_approximation/doc/Surface_mesh_approximation/PackageDescription.txt +++ b/Surface_mesh_approximation/doc/Surface_mesh_approximation/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgTSMARef Triangulated Surface Mesh Approximation Reference +/// \defgroup PkgTSMARef Reference Manual /// \defgroup PkgTSMAConcepts Concepts /// \ingroup PkgTSMARef diff --git a/Surface_mesh_deformation/doc/Surface_mesh_deformation/PackageDescription.txt b/Surface_mesh_deformation/doc/Surface_mesh_deformation/PackageDescription.txt index df5695c208e..aa0fa9f1f00 100644 --- a/Surface_mesh_deformation/doc/Surface_mesh_deformation/PackageDescription.txt +++ b/Surface_mesh_deformation/doc/Surface_mesh_deformation/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSurfaceMeshDeformationRef Triangulated Surface Mesh Deformation Reference +/// \defgroup PkgSurfaceMeshDeformationRef Reference Manual /// \defgroup PkgSurfaceMeshDeformationConcepts Concepts /// \ingroup PkgSurfaceMeshDeformationRef diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt index d10f2b91ae6..61c216245e5 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSurfaceMeshParameterizationRef Triangulated Surface Mesh Parameterization Reference +/// \defgroup PkgSurfaceMeshParameterizationRef Reference Manual /*! diff --git a/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/PackageDescription.txt b/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/PackageDescription.txt index 855dc4524ac..3fffb38be7a 100644 --- a/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/PackageDescription.txt +++ b/Surface_mesh_segmentation/doc/Surface_mesh_segmentation/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSurfaceMeshSegmentationRef Triangulated Surface Mesh Segmentation Reference +/// \defgroup PkgSurfaceMeshSegmentationRef Reference Manual /// \defgroup PkgSurfaceMeshSegmentationConcepts Concepts /// \ingroup PkgSurfaceMeshSegmentationRef diff --git a/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt b/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt index 185684bd3de..6c8c97b47e0 100644 --- a/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt +++ b/Surface_mesh_shortest_path/doc/Surface_mesh_shortest_path/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSurfaceMeshShortestPathRef Triangulated Surface Mesh Geodesic Shortest Paths Reference +/// \defgroup PkgSurfaceMeshShortestPathRef Reference Manual /// \defgroup PkgSurfaceMeshShortestPathConcepts Concepts /// \ingroup PkgSurfaceMeshShortestPathRef diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt index da58a2534fc..a597bb02a77 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSurfaceMeshSimplificationRef Triangulated Surface Mesh Simplification Reference +/// \defgroup PkgSurfaceMeshSimplificationRef Reference Manual /// \defgroup PkgSurfaceMeshSimplificationConcepts Concepts /// \ingroup PkgSurfaceMeshSimplificationRef /*! diff --git a/Surface_mesh_skeletonization/doc/Surface_mesh_skeletonization/PackageDescription.txt b/Surface_mesh_skeletonization/doc/Surface_mesh_skeletonization/PackageDescription.txt index 8de78b7f35f..6f3f5ca63fa 100644 --- a/Surface_mesh_skeletonization/doc/Surface_mesh_skeletonization/PackageDescription.txt +++ b/Surface_mesh_skeletonization/doc/Surface_mesh_skeletonization/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSurfaceMeshSkeletonizationRef Triangulated Surface Mesh Skeletonization Reference +/// \defgroup PkgSurfaceMeshSkeletonizationRef Reference Manual /// \defgroup PkgSurfaceMeshSkeletonizationConcepts Concepts /// \ingroup PkgSurfaceMeshSkeletonizationRef diff --git a/Surface_mesh_topology/doc/Surface_mesh_topology/PackageDescription.txt b/Surface_mesh_topology/doc/Surface_mesh_topology/PackageDescription.txt index b39b30e8f93..8a4a2b95f01 100644 --- a/Surface_mesh_topology/doc/Surface_mesh_topology/PackageDescription.txt +++ b/Surface_mesh_topology/doc/Surface_mesh_topology/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSurfaceMeshTopologyRef Surface Mesh Topology Reference +/// \defgroup PkgSurfaceMeshTopologyRef Reference Manual /// \defgroup PkgSurfaceMeshTopologyConcepts Concepts /// \ingroup PkgSurfaceMeshTopologyRef diff --git a/Surface_mesher/doc/Surface_mesher/PackageDescription.txt b/Surface_mesher/doc/Surface_mesher/PackageDescription.txt index 091d2399df4..6b4244d716b 100644 --- a/Surface_mesher/doc/Surface_mesher/PackageDescription.txt +++ b/Surface_mesher/doc/Surface_mesher/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSurfaceMesher3Ref 3D Surface Mesh Generation Reference +/// \defgroup PkgSurfaceMesher3Ref Reference Manual /// \defgroup PkgSurfaceMesher3Concepts Concepts /// \ingroup PkgSurfaceMesher3Ref diff --git a/Surface_sweep_2/doc/Surface_sweep_2/PackageDescription.txt b/Surface_sweep_2/doc/Surface_sweep_2/PackageDescription.txt index 8f4d6fcc4d6..45a46c156a6 100644 --- a/Surface_sweep_2/doc/Surface_sweep_2/PackageDescription.txt +++ b/Surface_sweep_2/doc/Surface_sweep_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgSurfaceSweep2Ref 2D Intersection of Curves Reference +/// \defgroup PkgSurfaceSweep2Ref Reference Manual /*! \addtogroup PkgSurfaceSweep2Ref \cgalPkgDescriptionBegin{2D Intersection of Curves,PkgSurfaceSweep2} diff --git a/TDS_2/doc/TDS_2/PackageDescription.txt b/TDS_2/doc/TDS_2/PackageDescription.txt index 95af343936f..acec919a94d 100644 --- a/TDS_2/doc/TDS_2/PackageDescription.txt +++ b/TDS_2/doc/TDS_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgTDS2Ref 2D Triangulation Data Structure Reference +/// \defgroup PkgTDS2Ref Reference Manual /// \defgroup PkgTDS2Concepts Concepts /// \ingroup PkgTDS2Ref /*! diff --git a/TDS_3/doc/TDS_3/PackageDescription.txt b/TDS_3/doc/TDS_3/PackageDescription.txt index 9f2efbc741f..b7f33ff29c3 100644 --- a/TDS_3/doc/TDS_3/PackageDescription.txt +++ b/TDS_3/doc/TDS_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgTDS3Ref 3D Triangulation Data Structure Reference +/// \defgroup PkgTDS3Ref Reference Manual /// \defgroup PkgTDS3Concepts Concepts /// \ingroup PkgTDS3Ref diff --git a/Tetrahedral_remeshing/doc/Tetrahedral_remeshing/PackageDescription.txt b/Tetrahedral_remeshing/doc/Tetrahedral_remeshing/PackageDescription.txt index 9c96d128006..a49442ec7a5 100644 --- a/Tetrahedral_remeshing/doc/Tetrahedral_remeshing/PackageDescription.txt +++ b/Tetrahedral_remeshing/doc/Tetrahedral_remeshing/PackageDescription.txt @@ -1,6 +1,4 @@ -// Tetrahedral Remeshing - -/// \defgroup PkgTetrahedralRemeshingRef Tetrahedral Remeshing Reference +/// \defgroup PkgTetrahedralRemeshingRef Reference Manual /// \defgroup PkgTetrahedralRemeshingConcepts Concepts /// \ingroup PkgTetrahedralRemeshingRef diff --git a/Three/doc/Three/PackageDescription.txt b/Three/doc/Three/PackageDescription.txt index 067d3fa3763..9d3211389fe 100644 --- a/Three/doc/Three/PackageDescription.txt +++ b/Three/doc/Three/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgThreeRef Three Reference +/// \defgroup PkgThreeRef Reference Manual /// /*! \addtogroup PkgThreeRef diff --git a/Triangulation/doc/Triangulation/PackageDescription.txt b/Triangulation/doc/Triangulation/PackageDescription.txt index 2ef98bf9d84..9816b3efa1e 100644 --- a/Triangulation/doc/Triangulation/PackageDescription.txt +++ b/Triangulation/doc/Triangulation/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgTriangulationsRef dD Triangulations Reference +/// \defgroup PkgTriangulationsRef Reference Manual /// \defgroup PkgTriangulationsConcepts Concepts /// \ingroup PkgTriangulationsRef diff --git a/Triangulation_2/doc/Triangulation_2/PackageDescription.txt b/Triangulation_2/doc/Triangulation_2/PackageDescription.txt index 815186bb141..2800ac58008 100644 --- a/Triangulation_2/doc/Triangulation_2/PackageDescription.txt +++ b/Triangulation_2/doc/Triangulation_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgTriangulation2Ref 2D Triangulations Reference +/// \defgroup PkgTriangulation2Ref Reference Manual /// \defgroup PkgTriangulation2Concepts Concepts /// \ingroup PkgTriangulation2Ref diff --git a/Triangulation_3/doc/Triangulation_3/PackageDescription.txt b/Triangulation_3/doc/Triangulation_3/PackageDescription.txt index df07b990016..d08497377f6 100644 --- a/Triangulation_3/doc/Triangulation_3/PackageDescription.txt +++ b/Triangulation_3/doc/Triangulation_3/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgTriangulation3Ref 3D Triangulations Reference +/// \defgroup PkgTriangulation3Ref Reference Manual /// \defgroup PkgTriangulation3Concepts Concepts /// \ingroup PkgTriangulation3Ref diff --git a/Triangulation_on_hyperbolic_surface_2/doc/Triangulation_on_hyperbolic_surface_2/PackageDescription.txt b/Triangulation_on_hyperbolic_surface_2/doc/Triangulation_on_hyperbolic_surface_2/PackageDescription.txt index 5a59dd46ecc..5f3b585103b 100644 --- a/Triangulation_on_hyperbolic_surface_2/doc/Triangulation_on_hyperbolic_surface_2/PackageDescription.txt +++ b/Triangulation_on_hyperbolic_surface_2/doc/Triangulation_on_hyperbolic_surface_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgHyperbolicSurfaceTriangulation2Ref 2D Triangulations on Hyperbolic Surfaces Reference +/// \defgroup PkgHyperbolicSurfaceTriangulation2Ref Reference Manual /// \defgroup PkgHyperbolicSurfaceTriangulation2Concepts Concepts /// \ingroup PkgHyperbolicSurfaceTriangulation2Ref diff --git a/Triangulation_on_sphere_2/doc/Triangulation_on_sphere_2/PackageDescription.txt b/Triangulation_on_sphere_2/doc/Triangulation_on_sphere_2/PackageDescription.txt index 5fd9ff30df1..f48dc2f47ec 100644 --- a/Triangulation_on_sphere_2/doc/Triangulation_on_sphere_2/PackageDescription.txt +++ b/Triangulation_on_sphere_2/doc/Triangulation_on_sphere_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgTriangulationOnSphere2Ref 2D Triangulation on the Sphere Reference +/// \defgroup PkgTriangulationOnSphere2Ref Reference Manual /// \defgroup PkgTriangulationOnSphere2Concepts Concepts /// \ingroup PkgTriangulationOnSphere2Ref diff --git a/Visibility_2/doc/Visibility_2/PackageDescription.txt b/Visibility_2/doc/Visibility_2/PackageDescription.txt index 4f1919adc56..7be9b8ab4cc 100644 --- a/Visibility_2/doc/Visibility_2/PackageDescription.txt +++ b/Visibility_2/doc/Visibility_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgVisibility2Ref Visibility_2 Reference +/// \defgroup PkgVisibility2Ref Reference Manual /// \defgroup PkgVisibility2Concepts Concepts /// \ingroup PkgVisibility2Ref diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt b/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt index 898f2932d71..1bff5dc2d83 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/PackageDescription.txt @@ -1,4 +1,4 @@ -/// \defgroup PkgVoronoiDiagram2Ref 2D Voronoi Diagram Adaptor Reference +/// \defgroup PkgVoronoiDiagram2Ref Reference Manual /// \defgroup PkgVoronoiDiagram2Concepts Concepts /// \ingroup PkgVoronoiDiagram2Ref diff --git a/Weights/doc/Weights/PackageDescription.txt b/Weights/doc/Weights/PackageDescription.txt index 95c08a34bb7..d6e161d9163 100644 --- a/Weights/doc/Weights/PackageDescription.txt +++ b/Weights/doc/Weights/PackageDescription.txt @@ -2,7 +2,7 @@ namespace CGAL { namespace Weights { /*! -\defgroup PkgWeightsRef Weight Interface Reference +\defgroup PkgWeightsRef Reference Manual \defgroup PkgWeightsRefConcepts Concepts \ingroup PkgWeightsRef From 0b62da54bbd74c9aa652bc80d317175e46ab61e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Thu, 22 May 2025 18:11:37 +0200 Subject: [PATCH 12/16] update script --- Scripts/developer_scripts/cgal_create_package_dir.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Scripts/developer_scripts/cgal_create_package_dir.py b/Scripts/developer_scripts/cgal_create_package_dir.py index 560e6bf308e..6902af4c87a 100755 --- a/Scripts/developer_scripts/cgal_create_package_dir.py +++ b/Scripts/developer_scripts/cgal_create_package_dir.py @@ -33,7 +33,7 @@ PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - Put title of project here" descrstring = \ r"""// PRETTY PACKAGE NAME should equal the project title in Doxyfile.in -/// \defgroup PkgPACKAGERef PRETTY PACKAGE NAME Reference +/// \defgroup PkgPACKAGERef Reference Manual /// \defgroup PkgPACKAGEConcepts Concepts /// \ingroup PkgPACKAGERef From 6d4dccdcd29765a1a97f164acd6e7eb53c5c3844 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Thu, 22 May 2025 18:29:50 +0200 Subject: [PATCH 13/16] update links --- .../Algebraic_foundations.txt | 2 +- .../Arrangement_on_surface_2.txt | 6 +++--- BGL/doc/BGL/BGL.txt | 2 +- .../CGAL/boost/graph/alpha_expansion_graphcut.h | 2 +- .../Barycentric_coordinates_2.txt | 2 +- Documentation/doc/Documentation/Third_party.txt | 6 +++--- .../doc/Documentation/Tutorials/Tutorial_GIS.txt | 14 +++++++------- .../doc/Number_types/NumberTypeSupport.txt | 2 +- .../Concepts/Periodic_2TriangulationTraits_2.h | 2 +- Point_set_3/doc/Point_set_3/PackageDescription.txt | 2 +- .../Point_set_processing_3.txt | 6 +++--- .../Polygon_mesh_processing.txt | 2 +- 12 files changed, 24 insertions(+), 24 deletions(-) diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt b/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt index 558d702464f..a2aa522df8b 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt +++ b/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt @@ -81,7 +81,7 @@ compatibility all functionality is also accessible through global functions defined within namespace `CGAL`, e.g., \link sqrt `CGAL::sqrt(x)` \endlink. This is realized via function templates using the according functor of the traits class. For an overview see -Section \ref PkgAlgebraicFoundationsRef in the reference manual. +\ref PkgAlgebraicFoundationsRef. \subsection Algebraic_foundationsTagsinAlgebraicStructure Tags in Algebraic Structure Traits diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt index 2498396f920..f7c3e6ef4ce 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt @@ -4196,7 +4196,7 @@ are both parameterized by a geometric kernel and model the concepts `AosTraits_2` and `AosLandmarkTraits_2`. \cgalFootnote{They also model the refined concept \cgalFootnoteCode{AosDirectionalXMonotoneTraits_2}, which enables Boolean set -operations; see Package \ref PkgBooleanSetOperations2Ref.} The class +operations; see Package \ref PkgBooleanSetOperations2.} The class template `Arr_non_caching_segment_traits_2` derives from the instance `Arr_non_caching_segment_basic_traits_2`, which models the `AosLandmarkTraits_2` traits concept but not the @@ -4937,7 +4937,7 @@ template models the concepts `AosTraits_2` and `AosOpenBoundaryTraits_2`, but it does not model the `AosLandmarkTraits_2` concept. It also models the refined concept `AosDirectionalXMonotoneTraits_2`, which enables -Boolean set operations; see Package \ref PkgBooleanSetOperations2Ref. +Boolean set operations; see Package \ref PkgBooleanSetOperations2. Note that it is not a model of `AosLandmarkTraits_2` concept, so it is impossible to use the landmark point-location strategy with this traits class. @@ -5167,7 +5167,7 @@ Every instance of the `Arr_Bezier_curve_traits_2` class templates models the concept `AosTraits_2` (but it does not model the `AosLandmarkTraits_2` concept). It also models the refined concept `AosDirectionalXMonotoneTraits_2`, which enables -Boolean set operations; see Package \ref PkgBooleanSetOperations2Ref. +Boolean set operations; see Package \ref PkgBooleanSetOperations2. \cgalFigureBegin{aos_fig-bezier_curves,bezier_curves.png} diff --git a/BGL/doc/BGL/BGL.txt b/BGL/doc/BGL/BGL.txt index 1f1a3dd1c97..f20f60bf20d 100644 --- a/BGL/doc/BGL/BGL.txt +++ b/BGL/doc/BGL/BGL.txt @@ -698,7 +698,7 @@ using one of the following tags: - `CGAL::Alpha_expansion_boost_adjacency_list_tag` (default) - `CGAL::Alpha_expansion_boost_compressed_sparse_raw_tag` - `CGAL::Alpha_expansion_MaxFlow_tag`, released under GPL - license and provided by the \ref PkgSurfaceMeshSegmentationRef + license and provided by the \ref PkgSurfaceMeshSegmentation package All these implementations produce the exact same result but behave diff --git a/BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h b/BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h index 75014bd9371..8b58fd32543 100644 --- a/BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h +++ b/BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h @@ -509,7 +509,7 @@ class Alpha_expansion_MaxFlow_impl; \cgalParamNEnd \cgalNamedParamsEnd - \note The `MaxFlow` implementation is provided by the \ref PkgSurfaceMeshSegmentationRef + \note The `MaxFlow` implementation is provided by the \ref PkgSurfaceMeshSegmentation under GPL license. The header `` must be included if users want to use this implementation. */ diff --git a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Barycentric_coordinates_2.txt b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Barycentric_coordinates_2.txt index b3f13fcf819..fe1aba2bf91 100644 --- a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Barycentric_coordinates_2.txt +++ b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Barycentric_coordinates_2.txt @@ -53,7 +53,7 @@ All analytic barycentric coordinates for polygons can be computed either by inst or through one of the free functions. Harmonic coordinates can be computed only by instantiating a class that must be parameterized by a model of the concept `DiscretizedDomain_2`. Segment and triangle coordinates can be computed only through the free functions. -For more information see the \ref PkgBarycentricCoordinates2Ref "Reference Manual". +For more information see the \ref PkgBarycentricCoordinates2Ref. Any point in the plane may be taken as a query point. However, we do not recommend using Wachspress and discrete harmonic coordinates with query points outside the closure diff --git a/Documentation/doc/Documentation/Third_party.txt b/Documentation/doc/Documentation/Third_party.txt index cbdd0d5105c..2c0224d7b7f 100644 --- a/Documentation/doc/Documentation/Third_party.txt +++ b/Documentation/doc/Documentation/Third_party.txt @@ -143,7 +143,7 @@ The \eigen web site is `https://github.com/STORM-IRIT/OpenGR`. @@ -152,7 +152,7 @@ The \opengr web site is `https:// \libpointmatcher is a modular library implementing the Iterative Closest Point (ICP) algorithm for aligning point clouds, released under a permissive BSD license. -\cgal provides wrappers for the ICP algorithm of \libpointmatcher in the \ref PkgPointSetProcessing3Ref +\cgal provides wrappers for the ICP algorithm of \libpointmatcher in the \ref PkgPointSetProcessing3 packages. In order to use \libpointmatcher in \cgal programs, the executables should be linked with the CMake imported target `CGAL::pointmatcher_support` provided in @@ -276,7 +276,7 @@ for instance, on Windows, you can download it from `ceres-solver.org` diff --git a/Documentation/doc/Documentation/Tutorials/Tutorial_GIS.txt b/Documentation/doc/Documentation/Tutorials/Tutorial_GIS.txt index 546e53c7cd8..ec7c48e265c 100644 --- a/Documentation/doc/Documentation/Tutorials/Tutorial_GIS.txt +++ b/Documentation/doc/Documentation/Tutorials/Tutorial_GIS.txt @@ -303,14 +303,14 @@ described in this tutorial. This tutorial is based on the following \cgal packages: -- \ref PkgTriangulation2Ref -- \ref PkgPointSet3Ref -- \ref PkgPointSetProcessing3Ref +- \ref PkgTriangulation2 +- \ref PkgPointSet3 +- \ref PkgPointSetProcessing3 - \ref PkgSurface_mesh -- \ref PkgBGLRef -- \ref PkgPolygonMeshProcessingRef -- \ref PkgPolylineSimplification2Ref -- \ref PkgClassificationRef +- \ref PkgBGL +- \ref PkgPolygonMeshProcessing +- \ref PkgPolylineSimplification2 +- \ref PkgClassification The data set used throughout this tutorial comes from the https://www.usgs.gov/ database, licensed under the _US Government diff --git a/Number_types/doc/Number_types/NumberTypeSupport.txt b/Number_types/doc/Number_types/NumberTypeSupport.txt index d22aee9d648..be8e1978c97 100644 --- a/Number_types/doc/Number_types/NumberTypeSupport.txt +++ b/Number_types/doc/Number_types/NumberTypeSupport.txt @@ -16,7 +16,7 @@ requirements, such that they can be successfully used in \cgal code. In general they are expected to be a model of an algebraic structure concepts and in case they model a subring of the real numbers they are also a model of `RealEmbeddable`. For an overview of the algebraic -structure concepts see Section \ref PkgAlgebraicFoundationsRef. +structure concepts see Section \ref PkgAlgebraicFoundations. \section Number_typesBuilt Built-in Number Types diff --git a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/Concepts/Periodic_2TriangulationTraits_2.h b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/Concepts/Periodic_2TriangulationTraits_2.h index deb42512aa3..9819f8fb84a 100644 --- a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/Concepts/Periodic_2TriangulationTraits_2.h +++ b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/Concepts/Periodic_2TriangulationTraits_2.h @@ -11,7 +11,7 @@ the geometric primitives used in the triangulation and some function object types for the required predicates on those primitives. It refines the concept -`TriangulationTraits_2` from the \cgal \ref PkgTriangulation2Ref package. It redefines the +`TriangulationTraits_2` from the \cgal \ref PkgTriangulation2 package. It redefines the geometric objects, predicates and constructions to work with point-offset pairs. In most cases the offsets will be (0,0) and the predicates from `TriangulationTraits_2` can be used diff --git a/Point_set_3/doc/Point_set_3/PackageDescription.txt b/Point_set_3/doc/Point_set_3/PackageDescription.txt index ff2bbcbc02e..8072d6cb02b 100644 --- a/Point_set_3/doc/Point_set_3/PackageDescription.txt +++ b/Point_set_3/doc/Point_set_3/PackageDescription.txt @@ -25,7 +25,7 @@ /// header or by the LAS standard. /// /// For a complete documentation of these functions, please refer to the -/// \ref PkgPointSetProcessing3Ref manual. +/// \ref PkgPointSetProcessing3Ref "Point Set Processing Reference Manual". /// \defgroup PkgPointSet3IOLAS Input/Output (LAS) /// I/O Functions for the \ref IOStreamLAS diff --git a/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt b/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt index 61ea3803803..cce15a08b06 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt @@ -139,7 +139,7 @@ CGAL::jet_estimate_normals normal_map (CGAL::Second_of_pair_property_map())); \endcode -Please refer to the [Reference Manual](@ref PkgPointSetProcessing3Ref) for +Please refer to the @ref PkgPointSetProcessing3Ref for the detailed API of the Point Set Processing functions. @@ -973,7 +973,7 @@ points that are on sharp edges: The function `structure_point_set()` generates a structured version of the input point set assigned to a set of planes. Such an input can be -produced by a shape detection algorithm (see \ref PkgShapeDetectionRef). +produced by a shape detection algorithm (see its \ref PkgShapeDetectionRef). Point set structuring is based on the article \cgalCite{cgal:la-srpss-13}. - __Planes__: inliers of each detected plane are replaced by sets of @@ -1025,7 +1025,7 @@ point set: Several functions of this package provide a callback mechanism that enables the user to track the progress of the algorithms and to interrupt them if needed. A callback, in this package, is an instance of `std::function` that takes the advancement as a parameter (between 0. when the algorithm begins to 1. when the algorithm is completed) and that returns `true` if the algorithm should carry on, `false` otherwise. It is passed as a named parameter with an empty function as default. -Algorithms that support this mechanism are detailed in the [Reference Manual](@ref PkgPointSetProcessing3Ref), along with the effect that an early interruption has on the output. +Algorithms that support this mechanism are detailed in the @ref PkgPointSetProcessing3Ref, along with the effect that an early interruption has on the output. \subsection Point_set_processing_3Example_callbacks Example diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt b/Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt index ff7f3046264..ef3f3c544b8 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt @@ -57,7 +57,7 @@ mesh, which includes point location and self intersection tests. \subsection PMPIO Reading and Writing Polygon Meshes In all functions of this package, the polygon meshes are required to be models -of the graph concepts defined in the package \ref PkgBGLRef. Using common graph concepts +of the graph concepts defined in the package \ref PkgBGL. Using common graph concepts enables having common input/output functions for all the models of these concepts. The page \ref PkgBGLIOFct provides an exhaustive description of the available I/O functions. In addition, this package offers the function `CGAL::Polygon_mesh_processing::IO::read_polygon_mesh()`, From 4d13a4d5094b8ce5bf04bd69d685e4b9461c62f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Thu, 22 May 2025 18:56:23 +0200 Subject: [PATCH 14/16] better links --- .../doc/Algebraic_foundations/Algebraic_foundations.txt | 2 +- BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h | 3 ++- Number_types/doc/Number_types/NumberTypeSupport.txt | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt b/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt index a2aa522df8b..14b825ba300 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt +++ b/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt @@ -80,7 +80,7 @@ using overloaded functions. However, for ease of use and backward compatibility all functionality is also accessible through global functions defined within namespace `CGAL`, e.g., \link sqrt `CGAL::sqrt(x)` \endlink. This is realized via function templates using -the according functor of the traits class. For an overview see +the according functor of the traits class. For an overview see the section "Global Functions" in the \ref PkgAlgebraicFoundationsRef. \subsection Algebraic_foundationsTagsinAlgebraicStructure Tags in Algebraic Structure Traits diff --git a/BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h b/BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h index 8b58fd32543..261caeeb874 100644 --- a/BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h +++ b/BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h @@ -509,7 +509,8 @@ class Alpha_expansion_MaxFlow_impl; \cgalParamNEnd \cgalNamedParamsEnd - \note The `MaxFlow` implementation is provided by the \ref PkgSurfaceMeshSegmentation + + \note The `MaxFlow` implementation is provided by the \ref PkgSurfaceMeshSegmentation package under GPL license. The header `` must be included if users want to use this implementation. */ diff --git a/Number_types/doc/Number_types/NumberTypeSupport.txt b/Number_types/doc/Number_types/NumberTypeSupport.txt index be8e1978c97..6b94dd9fff6 100644 --- a/Number_types/doc/Number_types/NumberTypeSupport.txt +++ b/Number_types/doc/Number_types/NumberTypeSupport.txt @@ -16,7 +16,7 @@ requirements, such that they can be successfully used in \cgal code. In general they are expected to be a model of an algebraic structure concepts and in case they model a subring of the real numbers they are also a model of `RealEmbeddable`. For an overview of the algebraic -structure concepts see Section \ref PkgAlgebraicFoundations. +structure concepts see the \ref PkgAlgebraicFoundationsAlgebraicStructuresConcepts section. \section Number_typesBuilt Built-in Number Types From cfbf5f27652350b163c5440a27a5711355449b51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Mon, 26 May 2025 15:54:01 +0200 Subject: [PATCH 15/16] fix bad variable name --- .../CGAL/Polygon_mesh_processing/remesh_planar_patches.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/remesh_planar_patches.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/remesh_planar_patches.h index 7aafc50950f..b83f82c661c 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/remesh_planar_patches.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/remesh_planar_patches.h @@ -838,7 +838,7 @@ bool decimate_impl(const TriangleMeshIn& tm_in, } std::vector< boost::container::small_vector > faces; - bool remeshing_failed = decimate_impl(tm_in, + bool decimate_success = decimate_impl(tm_in, nb_corners_and_nb_cc, vertex_corner_id, edge_is_constrained, @@ -864,7 +864,7 @@ bool decimate_impl(const TriangleMeshIn& tm_in, parameters::point_to_vertex_map(f_id_tracker.v2v_map()). polygon_to_face_map(f_id_tracker.f2f_map()), parameters::vertex_point_map(vpm_out)); - return remeshing_failed; + return decimate_success; } template Date: Tue, 27 May 2025 20:58:51 +0200 Subject: [PATCH 16/16] add a script to install GF test machines --- .../prepare_GF_Linux_test_machine.sh | 330 ++++++++++++++++++ 1 file changed, 330 insertions(+) create mode 100755 Scripts/developer_scripts/prepare_GF_Linux_test_machine.sh diff --git a/Scripts/developer_scripts/prepare_GF_Linux_test_machine.sh b/Scripts/developer_scripts/prepare_GF_Linux_test_machine.sh new file mode 100755 index 00000000000..179d59ccfd9 --- /dev/null +++ b/Scripts/developer_scripts/prepare_GF_Linux_test_machine.sh @@ -0,0 +1,330 @@ +#!/bin/bash +set -o errexit -o nounset -o pipefail + +# Color output setup +if [ -t 1 ]; then + COLOR_BOLD="\033[1m" + COLOR_GREEN="\033[32m" + COLOR_RESET="\033[0m" +else + COLOR_BOLD="" + COLOR_GREEN="" + COLOR_RESET="" +fi + +color_echo() { + # Print with color unless line starts with two spaces + if [[ "$1" =~ ^\ \ ]]; then + echo "$1" + else + echo -e "${COLOR_BOLD}${COLOR_GREEN}$1${COLOR_RESET}" + fi +} + +color_printf() { + # Print with color unless first arg starts with two spaces + local fmt="$1" + if [[ "$fmt" =~ ^\ \ ]]; then + printf "$@" + else + echo -e "${COLOR_BOLD}${COLOR_GREEN}" + printf "$@" + echo -e "${COLOR_RESET}" + fi +} + +print_command() { + if [ ! -t 0 ]; then + while IFS= read -r line; do + printf ' | %s\n' "$line" >&2 + done + fi + printf ' > %s\n' "$*" >&2 +} + +install_packages() { + local packages=("$@") + if [ "${#packages[@]}" -eq 0 ]; then + return + fi + color_echo "Installing '${packages[*]}' (requires sudo privileges)..." + local package_manager="" + if command -v dnf &>/dev/null; then + package_manager=dnf + elif command -v apt &>/dev/null; then + package_manager=apt + elif command -v pacman &>/dev/null; then + package_manager=pacman + else + echo "Could not find a supported package manager to install '${packages[*]}'." + exit 1 + fi + case "$package_manager" in + dnf) + $SUDO_OR_PRINT dnf install -y "${packages[@]}" + ;; + apt) + $SUDO_OR_PRINT apt update + $SUDO_OR_PRINT apt install -y "${packages[@]}" + ;; + pacman) + $SUDO_OR_PRINT pacman -Sy --noconfirm "${packages[@]}" + ;; + esac +} + +SUDO_OR_PRINT="sudo" +if [ "${1:-}" = "--dry-run" ]; then + SUDO_OR_PRINT=print_command + echo "Running in dry-run mode. No changes will be made." +fi + +# Ensure gh CLI and jq are installed +required_pkgs=() +for pkg in gh jq; do + command -v "$pkg" &>/dev/null || required_pkgs+=("$pkg") +done +install_packages "${required_pkgs[@]}" + +if ! gh auth status &>/dev/null; then + echo "GitHub CLI is not authenticated. Attempting to log in..." + gh auth login || { + echo "Failed to authenticate with GitHub CLI." + exit 1 + } +fi + +# Fetch members and real names using GraphQL +GF_GRAPHQL_QUERY=' +query { + organization(login: "CGAL") { + team(slug: "GeometryFactory") { + members(first: 100) { + edges { + node { + login + name + publicKeys(first: 100) { + edges { + node { + id + key + } + } + } + } + } + } + } + } +}' + +# Fetch team members and their names from GitHub GraphQL API +GRAPH_QL_RESULT=$(gh api graphql -f query="$GF_GRAPHQL_QUERY" --jq '.data.organization.team.members.edges.[].node') +if [ -z "$GRAPH_QL_RESULT" ]; then + echo "Error: No members found in the GeometryFactory team." >&2 + exit 1 +fi + +GF_MEMBERS=() +declare -A GF_REAL_NAMES=() +declare -A GF_SSH_KEYS=() + +# Parse the JSON result for logins, and names +while IFS=$'\t' read -r login name; do + GF_MEMBERS+=("$login") + GF_REAL_NAMES["$login"]="$name" +done < <( + jq -r '[ .login, .name ] | @tsv' <<<"$GRAPH_QL_RESULT" +) + +# Parse the SSH keys and associate them with the respective members +for login in "${GF_MEMBERS[@]}"; do + keys=$(jq -r --arg login "$login" 'select(.login == $login) | (.publicKeys.edges[].node.key // empty)' <<<"$GRAPH_QL_RESULT") + GF_SSH_KEYS["$login"]="" + while IFS=$'\n' read -r key; do + [[ -z "$key" ]] && continue + GF_SSH_KEYS["$login"]+="$key"$'\n' + done <<<"$keys" +done + +# Mapping from GitHub login to local username (if different) +declare -A GF_USERNAMES=( + ["janetournois"]="jtournois" + ["LeoValque"]="lvalque" + ["MaelRL"]="mrouxell" + ["SaillantNicolas"]="nsaillant" +) + +# Correcting the real names for specific users +GF_REAL_NAMES["LeoValque"]="Léo Valque" +GF_REAL_NAMES["MaelRL"]="Maël Rouxel-Labbé" +GF_REAL_NAMES["sloriot"]="Sébastien Loriot" + +# Mapping from GitHub login to extra groups (if any) +declare -A GF_GROUPS=( + ["lrineau"]="wheel,docker" + ["SaillantNicolas"]="wheel,docker" + ["sloriot"]="wheel,docker" +) + +color_echo "Members of the geometryfactory team:" +for m in "${GF_MEMBERS[@]}"; do + keys="${GF_SSH_KEYS[$m]}" + nb_of_keys=$(printf '%s' "$keys" | wc -l) + color_printf " %s (%s) has %d ssh keys in Github\n" "$m" "${GF_REAL_NAMES[$m]:-$m}" "$nb_of_keys" +done + +# Ensure groups exists +for group in geometryfactory docker; do + if ! getent group "$group" >/dev/null; then + $SUDO_OR_PRINT groupadd "$group" + fi +done + +for member in "${GF_MEMBERS[@]}"; do + user="${GF_USERNAMES[$member]:-$member}" + groups="geometryfactory" + if [[ -n "${GF_GROUPS[$member]:-}" ]]; then + groups="geometryfactory,${GF_GROUPS[$member]}" + fi + + if ! getent passwd "$user" >/dev/null; then + color_echo "Creating user $user and adding to group(s) $groups." + $SUDO_OR_PRINT useradd -m -s /bin/bash -c "${GF_REAL_NAMES[$member]:-$user}" "$user" -G "$groups" + else + color_echo "User $user already exists, adding to group(s) $groups." + $SUDO_OR_PRINT usermod -aG "$groups" -c "${GF_REAL_NAMES[$member]:-$user}" "$user" + fi + + $SUDO_OR_PRINT chmod o+rx "/home/$user" + + $SUDO_OR_PRINT mkdir -p "/home/$user/.ssh" + $SUDO_OR_PRINT chown "$user:$user" "/home/$user/.ssh" + $SUDO_OR_PRINT chmod 700 "/home/$user/.ssh" + + # Add SSH keys from GraphQL + color_echo " Adding SSH keys for user $member from Github." + count=0 + auth_keys_file="/home/$user/.ssh/authorized_keys" + if ! sudo test -f "$auth_keys_file"; then + $SUDO_OR_PRINT install -m 600 -o "$user" -g "$user" /dev/null "$auth_keys_file" + fi + if [[ -n "${GF_SSH_KEYS[$member]:-}" ]]; then + while IFS=$'\n' read -r key; do + [[ -z "$key" ]] && continue + if ! $SUDO_OR_PRINT grep -qF -- "$key" "$auth_keys_file" /dev/null + fi + count=$((count + 1)) + fi + done <<<"${GF_SSH_KEYS[$member]}" + fi + color_echo " Added $count SSH keys for user $user." + key_count=$(sudo bash -c "[ -f '$auth_keys_file' ] && wc -l <'$auth_keys_file' || echo 0") + color_echo " User $user has $key_count SSH keys in $auth_keys_file" +done + +# Add cgaltest user if not exists, and create SSH key +if ! getent passwd cgaltest >/dev/null; then + color_echo "Creating user cgaltest." + $SUDO_OR_PRINT useradd -m -s /bin/bash -c "CGAL Test User" cgaltest +fi + +$SUDO_OR_PRINT mkdir -p /home/cgaltest/.ssh +$SUDO_OR_PRINT chown cgaltest:cgaltest /home/cgaltest/.ssh +$SUDO_OR_PRINT chmod 700 /home/cgaltest/.ssh + +keyfile="/home/cgaltest/.ssh/id_ed25519" +if ! $SUDO_OR_PRINT test -f "$keyfile"; then + color_echo "Generating SSH key for cgaltest." + if [ "$SUDO_OR_PRINT" = "sudo" ]; then + sudo -u cgaltest ssh-keygen -t ed25519 -N "" -f "$keyfile" + else + ssh-keygen -t ed25519 -N "" -f "$keyfile" + fi +else + color_echo "SSH key for cgaltest already exists." + $SUDO_OR_PRINT cat "$keyfile.pub" +fi + +color_echo "All users have been processed." + +color_echo "Remove users not in the GeometryFactory team." +current_members=$(getent group geometryfactory | awk -F: '{print $4}' | tr ',' ' ') +for user in $current_members; do + # Map local usernames to GitHub logins if needed + login="$user" + for k in "${!GF_USERNAMES[@]}"; do + if [[ "${GF_USERNAMES[$k]}" == "$user" ]]; then + login="$k" + break + fi + done + found=false + for m in "${GF_MEMBERS[@]}"; do + if [[ "$login" == "$m" ]]; then + found=true + break + fi + done + if ! $found; then + color_echo " Removing user $user but keep its home directory." + read -p " Are you sure you want to remove user $user? [y/N] " confirm + if [[ ! "$confirm" =~ ^[Yy]$ ]]; then + color_echo " Skipping removal of user $user." + continue + fi + $SUDO_OR_PRINT userdel -f "$user" + fi +done + +# Optionally install bat, strace, and podman-docker if not present +need_install=() +for cmd in bat strace; do + command -v "$cmd" &>/dev/null || need_install+=("$cmd") +done + +# Check if docker is missing or not emulated by podman +need_podman_docker=false +if ! command -v docker &>/dev/null; then + need_podman_docker=true +elif docker --version 2>&1 | grep -q "podman"; then + need_podman_docker=true +fi + +if $need_podman_docker; then + if [[ ! " ${need_install[*]} " =~ " podman-docker " ]]; then + need_install+=("podman-docker") + fi +fi + +install_packages "${need_install[@]}" + +color_echo "Update the systemd tmpfiles configuration for podman." + +$SUDO_OR_PRINT touch /etc/containers/nodocker + +$SUDO_OR_PRINT mkdir -p /etc/tmpfiles.d +sed 's|podman 0700 root root|podman 0700 root docker|g' /usr/lib/tmpfiles.d/podman.conf | + $SUDO_OR_PRINT tee /etc/tmpfiles.d/podman.conf >/dev/null + +color_echo "Update the systemd socket configuration for podman." + +$SUDO_OR_PRINT mkdir -p /etc/systemd/system/podman.socket.d +$SUDO_OR_PRINT tee /etc/systemd/system/podman.socket.d/override.conf >/dev/null <