songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename home page of reference manuals to "Reference Manual" (#8904) 

Before: "Pkg Reference"
After: "Reference Manual"

No need to repeat the package name as it is on the line above.

Example output
![Screenshot from 2025-05-22
16-18-54](https://github.com/user-attachments/assets/ed285e12-d95c-4ec2-934d-12f4c7aa014c)
This commit is contained in:
Sebastien Loriot 2025-05-26 11:47:37 +02:00 committed by GitHub
parent 5833ff311c 4d13a4d509
commit 97bd1cf428
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
131 changed files with 146 additions and 165 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
AABB_tree/doc/AABB_tree/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgAABBTreeRef AABB Tree Reference /// \defgroup PkgAABBTreeRef Reference Manual
/// \defgroup PkgAABBTreeConcepts Concepts /// \defgroup PkgAABBTreeConcepts Concepts
/// \ingroup PkgAABBTreeRef /// \ingroup PkgAABBTreeRef

2
Advancing_front_surface_reconstruction/doc/Advancing_front_surface_reconstruction/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgAdvancingFrontSurfaceReconstructionRef Advancing Front Surface Reconstruction Reference /// \defgroup PkgAdvancingFrontSurfaceReconstructionRef Reference Manual
/// \defgroup PkgAdvancingFrontSurfaceReconstructionRefConcepts Concepts /// \defgroup PkgAdvancingFrontSurfaceReconstructionRefConcepts Concepts
/// \ingroup PkgAdvancingFrontSurfaceReconstructionRef /// \ingroup PkgAdvancingFrontSurfaceReconstructionRef

4
Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt
View File

@ -80,8 +80,8 @@ using overloaded functions. However, for ease of use and backward
compatibility all functionality is also compatibility all functionality is also
accessible through global functions defined within namespace `CGAL`, accessible through global functions defined within namespace `CGAL`,
e.g., \link sqrt `CGAL::sqrt(x)` \endlink. This is realized via function templates using 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
Section \ref PkgAlgebraicFoundationsRef in the reference manual. \ref PkgAlgebraicFoundationsRef.
\subsection Algebraic_foundationsTagsinAlgebraicStructure Tags in Algebraic Structure Traits \subsection Algebraic_foundationsTagsinAlgebraicStructure Tags in Algebraic Structure Traits

2
Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgAlgebraicFoundationsRef Algebraic Foundations Reference /// \defgroup PkgAlgebraicFoundationsRef Reference Manual
/// \defgroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts Concepts /// \defgroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts Concepts
/// \ingroup PkgAlgebraicFoundationsRef /// \ingroup PkgAlgebraicFoundationsRef

2
Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgAlgebraicKernelDRef Algebraic Kernel Reference /// \defgroup PkgAlgebraicKernelDRef Reference Manual
/// \defgroup PkgAlgebraicKernelDConcepts Concepts /// \defgroup PkgAlgebraicKernelDConcepts Concepts
/// \ingroup PkgAlgebraicKernelDRef /// \ingroup PkgAlgebraicKernelDRef

2
Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgAlphaShapes2Ref 2D Alpha Shapes Reference /// \defgroup PkgAlphaShapes2Ref Reference Manual
/// \defgroup PkgAlphaShapes2Concepts Concepts /// \defgroup PkgAlphaShapes2Concepts Concepts
/// \ingroup PkgAlphaShapes2Ref /// \ingroup PkgAlphaShapes2Ref

2
Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgAlphaShapes3Ref 3D Alpha Shapes Reference /// \defgroup PkgAlphaShapes3Ref Reference Manual
/// \defgroup PkgAlphaShapes3Concepts Concepts /// \defgroup PkgAlphaShapes3Concepts Concepts
/// \ingroup PkgAlphaShapes3Ref /// \ingroup PkgAlphaShapes3Ref
/*! /*!

2
Alpha_wrap_3/doc/Alpha_wrap_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgAlphaWrap3Ref 3D Alpha Wrapping /// \defgroup PkgAlphaWrap3Ref Reference Manual
/// \defgroup AW3_free_functions_grp Free Functions /// \defgroup AW3_free_functions_grp Free Functions
/// Functions to create a wrap from point clouds, triangle soups, and triangle meshes. /// Functions to create a wrap from point clouds, triangle soups, and triangle meshes.

2
Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgApolloniusGraph2Ref 2D Apollonius Graphs (Delaunay Graphs of Disks) Reference /// \defgroup PkgApolloniusGraph2Ref Reference Manual
/// \defgroup PkgApolloniusGraph2Concepts Concepts /// \defgroup PkgApolloniusGraph2Concepts Concepts
/// \ingroup PkgApolloniusGraph2Ref /// \ingroup PkgApolloniusGraph2Ref
/*! /*!

6
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt
View File

@ -4196,7 +4196,7 @@ are both parameterized by a geometric kernel and model the concepts
`AosTraits_2` and `AosLandmarkTraits_2`. `AosTraits_2` and `AosLandmarkTraits_2`.
\cgalFootnote{They also model the refined concept \cgalFootnote{They also model the refined concept
\cgalFootnoteCode{AosDirectionalXMonotoneTraits_2}, which enables Boolean set \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<Kernel>` derives from the template `Arr_non_caching_segment_traits_2<Kernel>` derives from the
instance `Arr_non_caching_segment_basic_traits_2<Kernel>`, which instance `Arr_non_caching_segment_basic_traits_2<Kernel>`, which
models the `AosLandmarkTraits_2` traits concept but not the 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 `AosOpenBoundaryTraits_2`, but it does not model the
`AosLandmarkTraits_2` concept. It also models the refined `AosLandmarkTraits_2` concept. It also models the refined
concept `AosDirectionalXMonotoneTraits_2`, which enables 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, Note that it is not a model of `AosLandmarkTraits_2` concept,
so it is impossible to use the landmark point-location strategy with so it is impossible to use the landmark point-location strategy with
this traits class. 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 models the concept `AosTraits_2` (but it does not model the
`AosLandmarkTraits_2` concept). It also models the refined `AosLandmarkTraits_2` concept). It also models the refined
concept `AosDirectionalXMonotoneTraits_2`, which enables 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} \cgalFigureBegin{aos_fig-bezier_curves,bezier_curves.png}

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgArrangementOnSurface2Ref 2D Arrangement Reference /// \defgroup PkgArrangementOnSurface2Ref Reference Manual
/// \defgroup PkgArrangementOnSurface2Concepts Concepts /// \defgroup PkgArrangementOnSurface2Concepts Concepts
/// \ingroup PkgArrangementOnSurface2Ref /// \ingroup PkgArrangementOnSurface2Ref

2
BGL/doc/BGL/BGL.txt
View File

@ -698,7 +698,7 @@ using one of the following tags:
- `CGAL::Alpha_expansion_boost_adjacency_list_tag` (default) - `CGAL::Alpha_expansion_boost_adjacency_list_tag` (default)
- `CGAL::Alpha_expansion_boost_compressed_sparse_raw_tag` - `CGAL::Alpha_expansion_boost_compressed_sparse_raw_tag`
- `CGAL::Alpha_expansion_MaxFlow_tag`, released under GPL - `CGAL::Alpha_expansion_MaxFlow_tag`, released under GPL
license and provided by the \ref PkgSurfaceMeshSegmentationRef license and provided by the \ref PkgSurfaceMeshSegmentation
package package
All these implementations produce the exact same result but behave All these implementations produce the exact same result but behave

2
BGL/doc/BGL/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgBGLRef CGAL and the Boost Graph Library Reference /// \defgroup PkgBGLRef Reference Manual
/*! \defgroup PkgBGLConcepts Concepts /*! \defgroup PkgBGLConcepts Concepts
\ingroup PkgBGLRef \ingroup PkgBGLRef

3
BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h
View File

@ -509,7 +509,8 @@ class Alpha_expansion_MaxFlow_impl;
\cgalParamNEnd \cgalParamNEnd
\cgalNamedParamsEnd \cgalNamedParamsEnd
\note The `MaxFlow` implementation is provided by the \ref PkgSurfaceMeshSegmentationRef
\note The `MaxFlow` implementation is provided by the \ref PkgSurfaceMeshSegmentation package
under GPL license. The header `<CGAL/boost/graph/Alpha_expansion_MaxFlow_tag.h>` under GPL license. The header `<CGAL/boost/graph/Alpha_expansion_MaxFlow_tag.h>`
must be included if users want to use this implementation. must be included if users want to use this implementation.
*/ */

2
Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Barycentric_coordinates_2.txt
View File

@ -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 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`. 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. 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 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 Wachspress and discrete harmonic coordinates with query points outside the closure

8
Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt
View File

@ -1,8 +1,5 @@
namespace CGAL {
namespace Barycentric_coordinates {
/*! /*!
\defgroup PkgBarycentricCoordinates2Ref 2D Generalized Barycentric Coordinates Reference \defgroup PkgBarycentricCoordinates2Ref Reference Manual
\defgroup PkgBarycentricCoordinates2RefConcepts Concepts \defgroup PkgBarycentricCoordinates2RefConcepts Concepts
\ingroup PkgBarycentricCoordinates2Ref \ingroup PkgBarycentricCoordinates2Ref
@ -77,6 +74,3 @@ coordinates from the Package \ref PkgInterpolation2.}
- `discrete_harmonic_coordinates_2()` - `discrete_harmonic_coordinates_2()`
- `boundary_coordinates_2()` - `boundary_coordinates_2()`
*/ */
} /* namespace Barycentric_coordinates */
} /* namespace CGAL */

2
Basic_viewer/doc/Basic_viewer/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgBasicViewerRef Basic Viewer Reference /// \defgroup PkgBasicViewerRef Reference Manual
/// \defgroup PkgBasicViewerConcepts Concepts /// \defgroup PkgBasicViewerConcepts Concepts
/// \ingroup PkgBasicViewerRef /// \ingroup PkgBasicViewerRef

2
Boolean_set_operations_2/doc/Boolean_set_operations_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgBooleanSetOperations2Ref 2D Regularized Boolean Set-Operations Reference /// \defgroup PkgBooleanSetOperations2Ref Reference Manual
/// \defgroup PkgBooleanSetOperations2Concepts Concepts /// \defgroup PkgBooleanSetOperations2Concepts Concepts
/// \ingroup PkgBooleanSetOperations2Ref /// \ingroup PkgBooleanSetOperations2Ref

2
Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgBoundingVolumesRef Bounding Volumes Reference /// \defgroup PkgBoundingVolumesRef Reference Manual
/// \defgroup PkgBoundingVolumesConcepts Concepts /// \defgroup PkgBoundingVolumesConcepts Concepts
/// \ingroup PkgBoundingVolumesRef /// \ingroup PkgBoundingVolumesRef
/*! /*!

2
Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgBoxIntersectionDRef Intersecting Sequences of dD Iso-oriented Boxes Reference /// \defgroup PkgBoxIntersectionDRef Reference Manual
/// \defgroup PkgBoxIntersectionDConcepts Concepts /// \defgroup PkgBoxIntersectionDConcepts Concepts
/// \ingroup PkgBoxIntersectionDRef /// \ingroup PkgBoxIntersectionDRef

2
CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgCGALIpeletsRef CGAL Ipelets Reference /// \defgroup PkgCGALIpeletsRef Reference Manual
/*! /*!
\addtogroup PkgCGALIpeletsRef \addtogroup PkgCGALIpeletsRef
\cgalPkgDescriptionBegin{CGAL Ipelets,PkgCGALIpelets} \cgalPkgDescriptionBegin{CGAL Ipelets,PkgCGALIpelets}

2
Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgCircularKernel2Ref 2D Circular Geometry Kernel Reference /// \defgroup PkgCircularKernel2Ref Reference Manual
/// \defgroup PkgCircularKernel2GeometricConcepts Geometric Concepts /// \defgroup PkgCircularKernel2GeometricConcepts Geometric Concepts
/// \ingroup PkgCircularKernel2Ref /// \ingroup PkgCircularKernel2Ref

2
Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgCircularKernel3Ref 3D Spherical Geometry Kernel Reference /// \defgroup PkgCircularKernel3Ref Reference Manual
/// \defgroup PkgCircularKernel3GeometricConcepts Geometric Concepts /// \defgroup PkgCircularKernel3GeometricConcepts Geometric Concepts
/// \ingroup PkgCircularKernel3Ref /// \ingroup PkgCircularKernel3Ref

2
Circulator/doc/Circulator/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgHandlesAndCirculatorsRef Handles and Circulators Reference /// \defgroup PkgHandlesAndCirculatorsRef Reference Manual
/// \defgroup PkgHandlesAndCirculatorsConcepts Concepts /// \defgroup PkgHandlesAndCirculatorsConcepts Concepts
/// \ingroup PkgHandlesAndCirculatorsRef /// \ingroup PkgHandlesAndCirculatorsRef

2
Classification/doc/Classification/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgClassificationRef Classification Reference /// \defgroup PkgClassificationRef Reference Manual
/*! /*!
\defgroup PkgClassificationConcepts Concepts \defgroup PkgClassificationConcepts Concepts

2
Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgCombinatorialMapsRef Combinatorial Maps Reference /// \defgroup PkgCombinatorialMapsRef Reference Manual
/// \defgroup PkgCombinatorialMapsConcepts Concepts /// \defgroup PkgCombinatorialMapsConcepts Concepts
/// \ingroup PkgCombinatorialMapsRef /// \ingroup PkgCombinatorialMapsRef

2
Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgConeSpanners2Ref Cone-Based Spanners Reference /// \defgroup PkgConeSpanners2Ref Reference Manual
/*! /*!
\addtogroup PkgConeSpanners2Ref \addtogroup PkgConeSpanners2Ref

2
Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgConvexDecomposition3Ref Convex Decomposition of Polyhedra Reference /// \defgroup PkgConvexDecomposition3Ref Reference Manual
/*! /*!
\addtogroup PkgConvexDecomposition3Ref \addtogroup PkgConvexDecomposition3Ref

2
Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgConvexHull2Ref 2D Convex Hulls and Extreme Points Reference /// \defgroup PkgConvexHull2Ref Reference Manual
/// \defgroup PkgConvexHull2Concepts Concepts /// \defgroup PkgConvexHull2Concepts Concepts
/// \ingroup PkgConvexHull2Ref /// \ingroup PkgConvexHull2Ref

2
Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgConvexHull3Ref 3D Convex Hulls Reference /// \defgroup PkgConvexHull3Ref Reference Manual
/// \defgroup PkgConvexHull3Concepts Concepts /// \defgroup PkgConvexHull3Concepts Concepts
/// \ingroup PkgConvexHull3Ref /// \ingroup PkgConvexHull3Ref

2
Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgConvexHullDRef dD Convex Hulls and Delaunay Triangulations Reference /// \defgroup PkgConvexHullDRef Reference Manual
/// \defgroup PkgConvexHullDConcepts Concepts /// \defgroup PkgConvexHullDConcepts Concepts
/// \ingroup PkgConvexHullDRef /// \ingroup PkgConvexHullDRef
/*! /*!

6
Documentation/doc/Documentation/Third_party.txt
View File

@ -143,7 +143,7 @@ The \eigen web site is <A HREF="https://eigen.tuxfamily.org/index.php?title=Main
\opengr is a set C++ libraries for 3D Global Registration released under the terms of the APACHE V2 license. \opengr is a set C++ libraries for 3D Global Registration released under the terms of the APACHE V2 license.
\cgal provides wrappers for the Super4PCS algorithm of \opengr in the \ref PkgPointSetProcessing3Ref \cgal provides wrappers for the Super4PCS algorithm of \opengr in the \ref PkgPointSetProcessing3
packages. In order to use \opengr in \cgal programs, the executables should be linked with the CMake imported target `CGAL::OpenGR_support` provided in `CGAL_OpenGR_support.cmake`. packages. In order to use \opengr in \cgal programs, the executables should be linked with the CMake imported target `CGAL::OpenGR_support` provided in `CGAL_OpenGR_support.cmake`.
The \opengr web site is <A HREF="https://github.com/STORM-IRIT/OpenGR">`https://github.com/STORM-IRIT/OpenGR`</A>. The \opengr web site is <A HREF="https://github.com/STORM-IRIT/OpenGR">`https://github.com/STORM-IRIT/OpenGR`</A>.
@ -152,7 +152,7 @@ The \opengr web site is <A HREF="https://github.com/STORM-IRIT/OpenGR">`https://
\libpointmatcher is a modular library implementing the Iterative Closest Point (ICP) algorithm for aligning point clouds, released under a permissive BSD license. \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 packages. In order to use \libpointmatcher in \cgal programs, the
executables should be linked with the CMake imported target executables should be linked with the CMake imported target
`CGAL::pointmatcher_support` provided in `CGAL::pointmatcher_support` provided in
@ -276,7 +276,7 @@ for instance, on Windows, you can download it from <A HREF="https://www.zlib.net
\ceres is an open source C++ library for modeling and solving large, complicated optimization problems. \ceres is an open source C++ library for modeling and solving large, complicated optimization problems.
In \cgal, \ceres is used by the \ref PkgPolygonMeshProcessingRef package for mesh smoothing, which In \cgal, \ceres is used by the \ref PkgPolygonMeshProcessing package for mesh smoothing, which
requires solving complex non-linear least squares problems. requires solving complex non-linear least squares problems.
Visit the official website of the library at <A HREF="http://ceres-solver.org/index.html">`ceres-solver.org`</A> Visit the official website of the library at <A HREF="http://ceres-solver.org/index.html">`ceres-solver.org`</A>

14
Documentation/doc/Documentation/Tutorials/Tutorial_GIS.txt
View File

@ -303,14 +303,14 @@ described in this tutorial.
This tutorial is based on the following \cgal packages: This tutorial is based on the following \cgal packages:
- \ref PkgTriangulation2Ref - \ref PkgTriangulation2
- \ref PkgPointSet3Ref - \ref PkgPointSet3
- \ref PkgPointSetProcessing3Ref - \ref PkgPointSetProcessing3
- \ref PkgSurface_mesh - \ref PkgSurface_mesh
- \ref PkgBGLRef - \ref PkgBGL
- \ref PkgPolygonMeshProcessingRef - \ref PkgPolygonMeshProcessing
- \ref PkgPolylineSimplification2Ref - \ref PkgPolylineSimplification2
- \ref PkgClassificationRef - \ref PkgClassification
The data set used throughout this tutorial comes from the The data set used throughout this tutorial comes from the
https://www.usgs.gov/ database, licensed under the _US Government https://www.usgs.gov/ database, licensed under the _US Government

2
Envelope_2/doc/Envelope_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgEnvelope2Ref 2D Envelopes Reference /// \defgroup PkgEnvelope2Ref Reference Manual
/// \defgroup PkgEnvelope2Concepts Concepts /// \defgroup PkgEnvelope2Concepts Concepts
/// \ingroup PkgEnvelope2Ref /// \ingroup PkgEnvelope2Ref
/*! /*!

2
Envelope_3/doc/Envelope_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgEnvelope3Ref 3D Envelopes Reference /// \defgroup PkgEnvelope3Ref Reference Manual
/// \defgroup PkgEnvelope3Concepts Concepts /// \defgroup PkgEnvelope3Concepts Concepts
/// \ingroup PkgEnvelope3Ref /// \ingroup PkgEnvelope3Ref
/*! /*!

2
Generalized_map/doc/Generalized_map/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgGeneralizedMapsRef Generalized Maps Reference /// \defgroup PkgGeneralizedMapsRef Reference Manual
/// \defgroup PkgGeneralizedMapsConcepts Concepts /// \defgroup PkgGeneralizedMapsConcepts Concepts
/// \ingroup PkgGeneralizedMapsRef /// \ingroup PkgGeneralizedMapsRef

2
Generator/doc/Generator/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgGeneratorsRef Geometric Object Generators Reference /// \defgroup PkgGeneratorsRef Reference Manual
/// \defgroup PkgGeneratorsConcepts Concepts /// \defgroup PkgGeneratorsConcepts Concepts
/// \ingroup PkgGeneratorsRef /// \ingroup PkgGeneratorsRef
/*! /*!

2
GraphicsView/doc/GraphicsView/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgGraphicsViewRef CGAL and the Qt Graphics View Framework Reference /// \defgroup PkgGraphicsViewRef Reference Manual
/// \defgroup PkgGraphicsViewGraphicsItemClasses Graphics Item Classes /// \defgroup PkgGraphicsViewGraphicsItemClasses Graphics Item Classes
/// \ingroup PkgGraphicsViewRef /// \ingroup PkgGraphicsViewRef
/// \defgroup PkgGraphicsViewInputClasses Input Classes /// \defgroup PkgGraphicsViewInputClasses Input Classes

2
HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgHalfedgeDSRef Halfedge Data Structures Reference /// \defgroup PkgHalfedgeDSRef Reference Manual
/// \defgroup PkgHalfedgeDSConcepts Concepts /// \defgroup PkgHalfedgeDSConcepts Concepts
/// \ingroup PkgHalfedgeDSRef /// \ingroup PkgHalfedgeDSRef

4
Heat_method_3/doc/Heat_method_3/PackageDescription.txt
View File

@ -1,6 +1,4 @@
// The Heat Method /// \defgroup PkgHeatMethodRef Reference Manual
/// \defgroup PkgHeatMethodRef Heat Method Reference
/// \defgroup PkgHeatMethodConcepts Concepts /// \defgroup PkgHeatMethodConcepts Concepts
/// \ingroup PkgHeatMethodRef /// \ingroup PkgHeatMethodRef

2
Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgHyperbolicTriangulation2Ref 2D Hyperbolic Delaunay Triangulations Reference /// \defgroup PkgHyperbolicTriangulation2Ref Reference Manual
/// \defgroup PkgHyperbolicTriangulation2Concepts Concepts /// \defgroup PkgHyperbolicTriangulation2Concepts Concepts
/// \ingroup PkgHyperbolicTriangulation2Ref /// \ingroup PkgHyperbolicTriangulation2Ref

2
Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgInscribedAreasRef Inscribed Areas Reference /// \defgroup PkgInscribedAreasRef Reference Manual
/// \defgroup PkgInscribedAreasConcepts Concepts /// \defgroup PkgInscribedAreasConcepts Concepts
/// \ingroup PkgInscribedAreasRef /// \ingroup PkgInscribedAreasRef

2
Interpolation/doc/Interpolation/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgInterpolation2Ref 2D and Surface Function Interpolation Reference /// \defgroup PkgInterpolation2Ref Reference Manual
/// \defgroup PkgInterpolation2Concepts Concepts /// \defgroup PkgInterpolation2Concepts Concepts
/// \ingroup PkgInterpolation2Ref /// \ingroup PkgInterpolation2Ref

2
Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgIntervalSkipListRef Interval Skip List Reference /// \defgroup PkgIntervalSkipListRef Reference Manual
/// \defgroup PkgIntervalSkipListConcepts Concepts /// \defgroup PkgIntervalSkipListConcepts Concepts
/// \ingroup PkgIntervalSkipListRef /// \ingroup PkgIntervalSkipListRef
/*! /*!

2
Isosurfacing_3/doc/Isosurfacing_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgIsosurfacing3Ref 3D Isosurfacing Reference /// \defgroup PkgIsosurfacing3Ref Reference Manual
/// \defgroup PkgIsosurfacing3Concepts Concepts /// \defgroup PkgIsosurfacing3Concepts Concepts
/// \ingroup PkgIsosurfacing3Ref /// \ingroup PkgIsosurfacing3Ref

2
Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgJetFitting3Ref Estimation of Local Differential Properties of Point-Sampled Surfaces Reference /// \defgroup PkgJetFitting3Ref Reference Manual
/// \defgroup PkgJetFitting3Concepts Concepts /// \defgroup PkgJetFitting3Concepts Concepts
/// \ingroup PkgJetFitting3Ref /// \ingroup PkgJetFitting3Ref
/*! /*!

2
Kernel_23/doc/Kernel_23/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgKernel23Ref 2D and 3D Linear Geometry Kernel Reference /// \defgroup PkgKernel23Ref Reference Manual
/// \defgroup PkgKernel23Concepts Concepts /// \defgroup PkgKernel23Concepts Concepts
/// \ingroup PkgKernel23Ref /// \ingroup PkgKernel23Ref

2
Kernel_d/doc/Kernel_d/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgKernelDRef dD Geometry Kernel Reference /// \defgroup PkgKernelDRef Reference Manual
/// \defgroup PkgKernelDLinAlgConcepts Linear Algebra Concepts /// \defgroup PkgKernelDLinAlgConcepts Linear Algebra Concepts
/// \ingroup PkgKernelDRef /// \ingroup PkgKernelDRef

2
Kinetic_space_partition/doc/Kinetic_space_partition/PackageDescription.txt
View File

@ -1,5 +1,5 @@
/*! /*!
\defgroup PkgKineticSpacePartitionRef Kinetic Space Partition Reference \defgroup PkgKineticSpacePartitionRef Reference Manual
\defgroup PkgKineticSpacePartitionConcepts Concepts \defgroup PkgKineticSpacePartitionConcepts Concepts
\ingroup PkgKineticSpacePartitionRef \ingroup PkgKineticSpacePartitionRef

2
Kinetic_surface_reconstruction/doc/Kinetic_surface_reconstruction/PackageDescription.txt
View File

@ -1,5 +1,5 @@
/*! /*!
\defgroup PkgKineticSurfaceReconstructionRef Kinetic Surface Reconstruction Reference \defgroup PkgKineticSurfaceReconstructionRef Reference Manual
\addtogroup PkgKineticSurfaceReconstructionRef \addtogroup PkgKineticSurfaceReconstructionRef
\cgalPkgDescriptionBegin{Kinetic Surface Reconstruction, PkgKineticSurfaceReconstruction} \cgalPkgDescriptionBegin{Kinetic Surface Reconstruction, PkgKineticSurfaceReconstruction}

2
Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgLinearCellComplexRef Linear Cell Complex Reference /// \defgroup PkgLinearCellComplexRef Reference Manual
/// \defgroup PkgLinearCellComplexConcepts Concepts /// \defgroup PkgLinearCellComplexConcepts Concepts
/// \ingroup PkgLinearCellComplexRef /// \ingroup PkgLinearCellComplexRef

2
Matrix_search/doc/Matrix_search/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgMatrixSearchRef Monotone and Sorted Matrix Search Reference /// \defgroup PkgMatrixSearchRef Reference Manual
/// \defgroup PkgMatrixSearchConcepts Concepts /// \defgroup PkgMatrixSearchConcepts Concepts
/// \ingroup PkgMatrixSearchRef /// \ingroup PkgMatrixSearchRef

2
Mesh_2/doc/Mesh_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgMesh2Ref 2D Conforming Triangulations and Meshes Reference /// \defgroup PkgMesh2Ref Reference Manual
/// \defgroup PkgMesh2Concepts Concepts /// \defgroup PkgMesh2Concepts Concepts
/// \ingroup PkgMesh2Ref /// \ingroup PkgMesh2Ref

2
Mesh_3/doc/Mesh_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgMesh3Ref 3D Mesh Generation Reference /// \defgroup PkgMesh3Ref Reference Manual
/// \defgroup PkgMesh3Concepts Main Concepts /// \defgroup PkgMesh3Concepts Main Concepts
/// \ingroup PkgMesh3Ref /// \ingroup PkgMesh3Ref

2
Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgMinkowskiSum2Ref 2D Minkowski Sums Reference /// \defgroup PkgMinkowskiSum2Ref Reference Manual
/// \defgroup PkgMinkowskiSum2Concepts Concepts /// \defgroup PkgMinkowskiSum2Concepts Concepts
/// \ingroup PkgMinkowskiSum2Ref /// \ingroup PkgMinkowskiSum2Ref

2
Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgMinkowskiSum3Ref 3D Minkowski Sum of Polyhedra Reference /// \defgroup PkgMinkowskiSum3Ref Reference Manual
/*! /*!
\addtogroup PkgMinkowskiSum3Ref \addtogroup PkgMinkowskiSum3Ref

2
Miscellany/doc/Miscellany/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup MiscellanyRef Profiling Tools, Hash Map, Union-find, Modifiers Reference /// \defgroup MiscellanyRef Reference Manual
/// \defgroup MiscellanyConcepts Concepts /// \defgroup MiscellanyConcepts Concepts
/// \ingroup MiscellanyRef /// \ingroup MiscellanyRef
/*! /*!

2
Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgModularArithmeticRef Modular Arithmetic Reference /// \defgroup PkgModularArithmeticRef Reference Manual
/// \defgroup PkgModularArithmeticConcepts Concepts /// \defgroup PkgModularArithmeticConcepts Concepts
/// \ingroup PkgModularArithmeticRef /// \ingroup PkgModularArithmeticRef
/*! /*!

2
Nef_2/doc/Nef_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgNef2Ref 2D Boolean Operations on Nef Polygons Reference /// \defgroup PkgNef2Ref Reference Manual
/// \defgroup PkgNef2Concepts Concepts /// \defgroup PkgNef2Concepts Concepts
/// \ingroup PkgNef2Ref /// \ingroup PkgNef2Ref
/*! /*!

2
Nef_3/doc/Nef_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgNef3Ref 3D Boolean Operations on Nef Polyhedra Reference /// \defgroup PkgNef3Ref Reference Manual
/// ///
/// \defgroup PkgNef3IOFunctions I/O Functions /// \defgroup PkgNef3IOFunctions I/O Functions
/// \ingroup PkgNef3Ref /// \ingroup PkgNef3Ref

2
Nef_S2/doc/Nef_S2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgNefS2Ref 2D Boolean Operations on Nef Polygons Embedded on the Sphere Reference /// \defgroup PkgNefS2Ref Reference Manual
/*! /*!
\addtogroup PkgNefS2Ref \addtogroup PkgNefS2Ref

2
Number_types/doc/Number_types/NumberTypeSupport.txt
View File

@ -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 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 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 also a model of `RealEmbeddable`. For an overview of the algebraic
structure concepts see Section \ref PkgAlgebraicFoundationsRef. structure concepts see the \ref PkgAlgebraicFoundationsAlgebraicStructuresConcepts section.
\section Number_typesBuilt Built-in Number Types \section Number_typesBuilt Built-in Number Types

2
Number_types/doc/Number_types/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgNumberTypesRef Number Types Reference /// \defgroup PkgNumberTypesRef Reference Manual
/// \defgroup PkgNumberTypesConcepts Concepts /// \defgroup PkgNumberTypesConcepts Concepts
/// \ingroup PkgNumberTypesRef /// \ingroup PkgNumberTypesRef

2
Optimal_bounding_box/doc/Optimal_bounding_box/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgOptimalBoundingBoxRef Optimal Bounding Box Reference /// \defgroup PkgOptimalBoundingBoxRef Reference Manual
/// \defgroup PkgOptimalBoundingBoxConcepts Concepts /// \defgroup PkgOptimalBoundingBoxConcepts Concepts
/// \ingroup PkgOptimalBoundingBoxRef /// \ingroup PkgOptimalBoundingBoxRef

2
Optimal_transportation_reconstruction_2/doc/Optimal_transportation_reconstruction_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgOptimalTransportationReconstruction2Ref Optimal Transportation Curve Reconstruction Reference /// \defgroup PkgOptimalTransportationReconstruction2Ref Reference Manual
/// \defgroup PkgOptimalTransportationReconstruction2Concepts Concepts /// \defgroup PkgOptimalTransportationReconstruction2Concepts Concepts
/// \ingroup PkgOptimalTransportationReconstruction2Ref /// \ingroup PkgOptimalTransportationReconstruction2Ref

2
Orthtree/doc/Orthtree/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgOrthtreeRef Quadtrees, Octrees and Orthtrees Reference /// \defgroup PkgOrthtreeRef Reference Manual
Quadtree, Octree and Orthtree Reference Quadtree, Octree and Orthtree Reference
/// \defgroup PkgOrthtreeConcepts Concepts /// \defgroup PkgOrthtreeConcepts Concepts

2
Partition_2/doc/Partition_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPartition2Ref 2D Polygon Partitioning Reference /// \defgroup PkgPartition2Ref Reference Manual
/// \defgroup PkgPartition2Concepts Concepts /// \defgroup PkgPartition2Concepts Concepts
/// \ingroup PkgPartition2Ref /// \ingroup PkgPartition2Ref
/// \defgroup PkgPartition2FunctionObjectConcepts Function Object Concepts /// \defgroup PkgPartition2FunctionObjectConcepts Function Object Concepts

2
Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/Concepts/Periodic_2TriangulationTraits_2.h
View File

@ -11,7 +11,7 @@ the geometric primitives used in the triangulation and some function
object types for the required predicates on those primitives. object types for the required predicates on those primitives.
It refines the concept 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 geometric objects, predicates and constructions to work with
point-offset pairs. In most cases the offsets will be (0,0) and the point-offset pairs. In most cases the offsets will be (0,0) and the
predicates from `TriangulationTraits_2` can be used predicates from `TriangulationTraits_2` can be used

2
Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPeriodic2Triangulation2Ref 2D Periodic Triangulations Reference /// \defgroup PkgPeriodic2Triangulation2Ref Reference Manual
/// \defgroup PkgPeriodic2Triangulation2Concepts Concepts /// \defgroup PkgPeriodic2Triangulation2Concepts Concepts
/// \ingroup PkgPeriodic2Triangulation2Ref /// \ingroup PkgPeriodic2Triangulation2Ref

2
Periodic_3_mesh_3/doc/Periodic_3_mesh_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPeriodic3Mesh3Ref 3D Periodic Mesh Generation Reference /// \defgroup PkgPeriodic3Mesh3Ref Reference Manual
/// \defgroup PkgPeriodic3Mesh3Concepts Concepts /// \defgroup PkgPeriodic3Mesh3Concepts Concepts
/// \ingroup PkgPeriodic3Mesh3Ref /// \ingroup PkgPeriodic3Mesh3Ref

2
Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPeriodic3Triangulation3Ref 3D Periodic Triangulations Reference /// \defgroup PkgPeriodic3Triangulation3Ref Reference Manual
/// \defgroup PkgPeriodic3Triangulation3Concepts Concepts /// \defgroup PkgPeriodic3Triangulation3Concepts Concepts
/// \ingroup PkgPeriodic3Triangulation3Ref /// \ingroup PkgPeriodic3Triangulation3Ref

2
Periodic_4_hyperbolic_triangulation_2/doc/Periodic_4_hyperbolic_triangulation_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPeriodic4HyperbolicTriangulation2Ref 2D Periodic Hyperbolic Triangulations Reference /// \defgroup PkgPeriodic4HyperbolicTriangulation2Ref Reference Manual
/// \defgroup PkgPeriodic4HyperbolicTriangulation2Concepts Concepts /// \defgroup PkgPeriodic4HyperbolicTriangulation2Concepts Concepts
/// \ingroup PkgPeriodic4HyperbolicTriangulation2Ref /// \ingroup PkgPeriodic4HyperbolicTriangulation2Ref

2
Point_set_2/doc/Point_set_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPointSet2Ref 2D Range and Neighbor Search Reference /// \defgroup PkgPointSet2Ref Reference Manual
/// \defgroup PkgPointSet2Concepts Concepts /// \defgroup PkgPointSet2Concepts Concepts
/// \ingroup PkgPointSet2Ref /// \ingroup PkgPointSet2Ref

4
Point_set_3/doc/Point_set_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPointSet3Ref 3D Point Set Reference /// \defgroup PkgPointSet3Ref Reference Manual
/*! /*!
\cgalInclude{CGAL/draw_point_set_3.h} \cgalInclude{CGAL/draw_point_set_3.h}
@ -25,7 +25,7 @@
/// header or by the LAS standard. /// header or by the LAS standard.
/// ///
/// For a complete documentation of these functions, please refer to the /// 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) /// \defgroup PkgPointSet3IOLAS Input/Output (LAS)
/// I/O Functions for the \ref IOStreamLAS /// I/O Functions for the \ref IOStreamLAS

2
Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPointSetProcessing3Ref Point Set Processing Reference /// \defgroup PkgPointSetProcessing3Ref Reference Manual
/*! /*!
\defgroup PkgPointSetProcessing3Algorithms Algorithms \defgroup PkgPointSetProcessing3Algorithms Algorithms

6
Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt
View File

@ -139,7 +139,7 @@ CGAL::jet_estimate_normals<Concurrency_tag>
normal_map (CGAL::Second_of_pair_property_map<PointVectorPair>())); normal_map (CGAL::Second_of_pair_property_map<PointVectorPair>()));
\endcode \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. 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 function `structure_point_set()` generates a structured version of
the input point set assigned to a set of planes. Such an input can be 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}. Point set structuring is based on the article \cgalCite{cgal:la-srpss-13}.
- __Planes__: inliers of each detected plane are replaced by sets of - __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<bool(double)>` 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. 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<bool(double)>` 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 \subsection Point_set_processing_3Example_callbacks Example

2
Poisson_surface_reconstruction_3/doc/Poisson_surface_reconstruction_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPoissonSurfaceReconstruction3Ref Poisson Surface Reconstruction Reference /// \defgroup PkgPoissonSurfaceReconstruction3Ref Reference Manual
/*! /*!
\addtogroup PkgPoissonSurfaceReconstruction3Ref \addtogroup PkgPoissonSurfaceReconstruction3Ref
\cgalPkgDescriptionBegin{Poisson Surface Reconstruction,PkgPoissonSurfaceReconstruction3} \cgalPkgDescriptionBegin{Poisson Surface Reconstruction,PkgPoissonSurfaceReconstruction3}

2
Polygon/doc/Polygon/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPolygon2Ref 2D Polygon Reference /// \defgroup PkgPolygon2Ref Reference Manual
/// \defgroup PkgPolygon2Concepts Concepts /// \defgroup PkgPolygon2Concepts Concepts
/// \ingroup PkgPolygon2Ref /// \ingroup PkgPolygon2Ref

2
Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPolygonMeshProcessingRef Polygon Mesh Processing Reference /// \defgroup PkgPolygonMeshProcessingRef Reference Manual
/// \defgroup PkgPolygonMeshProcessingConcepts Concepts /// \defgroup PkgPolygonMeshProcessingConcepts Concepts
/// \ingroup PkgPolygonMeshProcessingRef /// \ingroup PkgPolygonMeshProcessingRef

2
Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt
View File

@ -57,7 +57,7 @@ mesh, which includes point location and self intersection tests.
\subsection PMPIO Reading and Writing Polygon Meshes \subsection PMPIO Reading and Writing Polygon Meshes
In all functions of this package, the polygon meshes are required to be models 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. 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. 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()`, In addition, this package offers the function `CGAL::Polygon_mesh_processing::IO::read_polygon_mesh()`,

2
Polygon_repair/doc/Polygon_repair/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPolygonRepairRef 2D Polygon Repair Reference /// \defgroup PkgPolygonRepairRef Reference Manual
/// \defgroup PkgPolygonRepairFunctions Functions /// \defgroup PkgPolygonRepairFunctions Functions
/// \ingroup PkgPolygonRepairRef /// \ingroup PkgPolygonRepairRef

4
Polygonal_surface_reconstruction/doc/Polygonal_surface_reconstruction/PackageDescription.txt
View File

@ -1,6 +1,4 @@
// Polygonal Surface Reconstruction should equal the project title in Doxyfile.in /// \defgroup PkgPolygonalSurfaceReconstructionRef Reference Manual
/// \defgroup PkgPolygonalSurfaceReconstructionRef Polygonal Surface Reconstruction Reference
/*! /*!
\addtogroup PkgPolygonalSurfaceReconstructionRef \addtogroup PkgPolygonalSurfaceReconstructionRef

2
Polyhedron/doc/Polyhedron/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPolyhedronRef 3D Polyhedral Surface Reference /// \defgroup PkgPolyhedronRef Reference Manual
/// \defgroup PkgPolyhedronConcepts Concepts /// \defgroup PkgPolyhedronConcepts Concepts
/// \ingroup PkgPolyhedronRef /// \ingroup PkgPolyhedronRef

2
Polyline_simplification_2/doc/Polyline_simplification_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPolylineSimplification2Ref 2D Polyline Simplification Reference /// \defgroup PkgPolylineSimplification2Ref Reference Manual
/// \defgroup PkgPolylineSimplification2Concepts Concepts /// \defgroup PkgPolylineSimplification2Concepts Concepts
/// \ingroup PkgPolylineSimplification2Ref /// \ingroup PkgPolylineSimplification2Ref

2
Polynomial/doc/Polynomial/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPolynomialRef Polynomial Reference /// \defgroup PkgPolynomialRef Reference Manual
/// \defgroup PkgPolynomialConcepts Concepts /// \defgroup PkgPolynomialConcepts Concepts
/// \ingroup PkgPolynomialRef /// \ingroup PkgPolynomialRef

2
Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPolytopeDistanceDRef Optimal Distances Reference /// \defgroup PkgPolytopeDistanceDRef Reference Manual
/// \defgroup PkgPolytopeDistanceDConcepts Concepts /// \defgroup PkgPolytopeDistanceDConcepts Concepts
/// \ingroup PkgPolytopeDistanceDRef /// \ingroup PkgPolytopeDistanceDRef

2
Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPrincipalComponentAnalysisDRef Principal Component Analysis Reference /// \defgroup PkgPrincipalComponentAnalysisDRef Reference Manual
/// \defgroup PkgPrincipalComponentAnalysisDBary CGAL::barycenter() /// \defgroup PkgPrincipalComponentAnalysisDBary CGAL::barycenter()
/// \ingroup PkgPrincipalComponentAnalysisDRef /// \ingroup PkgPrincipalComponentAnalysisDRef

2
Property_map/doc/Property_map/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgPropertyMapRef CGAL and Boost Property Maps Reference /// \defgroup PkgPropertyMapRef Reference Manual
/*! /*!
\addtogroup PkgPropertyMapRef \addtogroup PkgPropertyMapRef

2
QP_solver/doc/QP_solver/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgQPSolverRef Linear and Quadratic Programming Solver Reference /// \defgroup PkgQPSolverRef Reference Manual
/*! \defgroup PkgQPSolverConcepts Concepts /*! \defgroup PkgQPSolverConcepts Concepts
\ingroup PkgQPSolverRef \ingroup PkgQPSolverRef

2
Ridges_3/doc/Ridges_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgRidges3Ref Approximation of Ridges and Umbilics on Triangulated Surface Meshes Reference /// \defgroup PkgRidges3Ref Reference Manual
/// \defgroup PkgRidges3Enums Enums /// \defgroup PkgRidges3Enums Enums
/// \ingroup PkgRidges3Ref /// \ingroup PkgRidges3Ref

2
SMDS_3/doc/SMDS_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgSMDS3Ref 3D Simplicial Mesh Data Structures Reference /// \defgroup PkgSMDS3Ref Reference Manual
/// \defgroup PkgSMDS3Concepts Concepts /// \defgroup PkgSMDS3Concepts Concepts
/// \ingroup PkgSMDS3Ref /// \ingroup PkgSMDS3Ref

2
STL_Extension/doc/STL_Extension/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgSTLExtensionRef STL Extensions for CGAL Reference /// \defgroup PkgSTLExtensionRef Reference Manual
/// \defgroup PkgSTLExtensionConcepts Concepts /// \defgroup PkgSTLExtensionConcepts Concepts
/// \ingroup PkgSTLExtensionRef /// \ingroup PkgSTLExtensionRef

2
Scale_space_reconstruction_3/doc/Scale_space_reconstruction_3/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgScaleSpaceReconstruction3Ref Scale-Space Surface Reconstruction Reference /// \defgroup PkgScaleSpaceReconstruction3Ref Reference Manual
/// \defgroup PkgScaleSpaceReconstruction3Concepts Concepts /// \defgroup PkgScaleSpaceReconstruction3Concepts Concepts
/// \ingroup PkgScaleSpaceReconstruction3Ref /// \ingroup PkgScaleSpaceReconstruction3Ref

2
Scripts/developer_scripts/cgal_create_package_dir.py
View File

@ -33,7 +33,7 @@ PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - Put title of project here"
descrstring = \ descrstring = \
r"""// PRETTY PACKAGE NAME should equal the project title in Doxyfile.in 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 /// \defgroup PkgPACKAGEConcepts Concepts
/// \ingroup PkgPACKAGERef /// \ingroup PkgPACKAGERef

2
SearchStructures/doc/SearchStructures/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgSearchStructuresRef dD Range and Segment Trees Reference /// \defgroup PkgSearchStructuresRef Reference Manual
/// \defgroup PkgSearchStructuresConcepts Concepts /// \defgroup PkgSearchStructuresConcepts Concepts
/// \ingroup PkgSearchStructuresRef /// \ingroup PkgSearchStructuresRef

2
Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgSegmentDelaunayGraph2Ref 2D Segment Delaunay Graphs Reference /// \defgroup PkgSegmentDelaunayGraph2Ref Reference Manual
/// \defgroup PkgSegmentDelaunayGraph2Concepts Concepts /// \defgroup PkgSegmentDelaunayGraph2Concepts Concepts
/// \ingroup PkgSegmentDelaunayGraph2Ref /// \ingroup PkgSegmentDelaunayGraph2Ref
/*! /*!

2
Segment_Delaunay_graph_Linf_2/doc/Segment_Delaunay_graph_Linf_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgSegmentDelaunayGraphLinf2Ref L Infinity Segment Delaunay Graphs Reference /// \defgroup PkgSegmentDelaunayGraphLinf2Ref Reference Manual
/// \defgroup PkgSegmentDelaunayGraphLinf2Concepts Concepts /// \defgroup PkgSegmentDelaunayGraphLinf2Concepts Concepts
/// \ingroup PkgSegmentDelaunayGraphLinf2Ref /// \ingroup PkgSegmentDelaunayGraphLinf2Ref

2
Set_movable_separability_2/doc/Set_movable_separability_2/PackageDescription.txt
View File

@ -1,4 +1,4 @@
/// \defgroup PkgSetMovableSeparability2Ref 2D Movable Separability of Sets Reference /// \defgroup PkgSetMovableSeparability2Ref Reference Manual
/// \defgroup top_edges_grp Top Edges /// \defgroup top_edges_grp Top Edges
/// These function determine whether a cavity (of a mold in the plane) /// These function determine whether a cavity (of a mold in the plane)

4
Shape_detection/doc/Shape_detection/PackageDescription.txt
View File

@ -1,7 +1,5 @@
// RANSAC
/*! /*!
\defgroup PkgShapeDetectionRef Shape Detection Reference \defgroup PkgShapeDetectionRef Reference Manual
\defgroup PkgShapeDetectionRANSAC Efficient RANSAC \defgroup PkgShapeDetectionRANSAC Efficient RANSAC
\ingroup PkgShapeDetectionRef \ingroup PkgShapeDetectionRef

8
Shape_regularization/doc/Shape_regularization/PackageDescription.txt
View File

@ -1,8 +1,5 @@
namespace CGAL {
namespace Shape_regularization {
/*! /*!
\defgroup PkgShapeRegularizationRef Shape Regularization Reference \defgroup PkgShapeRegularizationRef Reference Manual
\defgroup PkgShapeRegularizationRefConcepts Concepts \defgroup PkgShapeRegularizationRefConcepts Concepts
\ingroup PkgShapeRegularizationRef \ingroup PkgShapeRegularizationRef
@ -100,6 +97,3 @@ to the user-specified conditions.}
### QP Regularization ### ### QP Regularization ###
- `QP_regularization<GeomTraits, InputRange, NeighQuery, RegType, QPSolver>` - `QP_regularization<GeomTraits, InputRange, NeighQuery, RegType, QPSolver>`
*/ */
} /* namespace Shape_regularization */
} /* namespace CGAL */

Some files were not shown because too many files have changed in this diff Show More