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

use a macro

This commit is contained in:
Sébastien Loriot 2023-08-24 14:56:48 +02:00
parent 0ce82c0bd5
commit 608d0c81c4
16 changed files with 37 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -47,7 +47,7 @@ namespace ArrTraits {}
/// \ingroup PkgArrangementOnSurface2Ref /// \ingroup PkgArrangementOnSurface2Ref
/*! /*!
`#include <CGAL/draw_arrangement_2.h>` \cgalInclude{CGAL/draw_arrangement_2.h}
*/ */
/// \defgroup PkgArrangementOnSurface2Draw Drawing /// \defgroup PkgArrangementOnSurface2Draw Drawing
/// \ingroup PkgArrangementOnSurface2Ref /// \ingroup PkgArrangementOnSurface2Ref

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

@ -7,7 +7,7 @@
namespace ArrDirectionalTraits {} namespace ArrDirectionalTraits {}
/*! /*!
`#include <CGAL/draw_polygon_set_2.h>` \cgalInclude{CGAL/draw_polygon_set_2.h}
*/ */
/// \defgroup PkgDrawPolygonSet2 Draw a 2D Polygon Set /// \defgroup PkgDrawPolygonSet2 Draw a 2D Polygon Set
/// \ingroup PkgBooleanSetOperations2Ref /// \ingroup PkgBooleanSetOperations2Ref

3
Documentation/doc/resources/1.8.13/BaseDoxyfile.in
View File

@ -190,7 +190,8 @@ ALIASES = "cgal=%CGAL" \
"cgalParamSectionEnd=\cgalParamNEnd" \ "cgalParamSectionEnd=\cgalParamNEnd" \
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \ "cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
"cgalBigO{1}=\f$O(\1)\f$" \ "cgalBigO{1}=\f$O(\1)\f$" \
"cgalBigOLarge{1}=\f$O\left(\1\right)\f$" "cgalBigOLarge{1}=\f$O\left(\1\right)\f$" \
"cgalInclude{1}=\#`include<\1>`"
# Doxygen selects the parser to use depending on the extension of the files it # Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given # parses. With this tag you can assign which parser to use for a given

3
Documentation/doc/resources/1.9.6/BaseDoxyfile.in
View File

@ -199,7 +199,8 @@ ALIASES = "cgal=%CGAL" \
"cgalParamSectionEnd=\cgalParamNEnd" \ "cgalParamSectionEnd=\cgalParamNEnd" \
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \ "cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
"cgalBigO{1}=\f$O(\1)\f$" \ "cgalBigO{1}=\f$O(\1)\f$" \
"cgalBigOLarge{1}=\f$O\left(\1\right)\f$" "cgalBigOLarge{1}=\f$O\left(\1\right)\f$" \
"cgalInclude{1}=`#include<\1>`"
# Doxygen selects the parser to use depending on the extension of the files it # Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given # parses. With this tag you can assign which parser to use for a given

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

@ -12,13 +12,13 @@
/// \ingroup PkgLinearCellComplexRef /// \ingroup PkgLinearCellComplexRef
/*! High-level operations. /*! High-level operations.
`#include <CGAL/Linear_cell_complex_operations.h>` \cgalInclude{CGAL/Linear_cell_complex_operations.h}
*/ */
/// \defgroup PkgLinearCellComplexOperations Operations for Linear Cell Complex /// \defgroup PkgLinearCellComplexOperations Operations for Linear Cell Complex
/// \ingroup PkgLinearCellComplexRef /// \ingroup PkgLinearCellComplexRef
/*! /*!
`#include <CGAL/draw_linear_cell_complex.h>` \cgalInclude{CGAL/draw_linear_cell_complex.h}
*/ */
/// \defgroup PkgDrawLinearCellComplex Draw a Linear Cell Complex /// \defgroup PkgDrawLinearCellComplex Draw a Linear Cell Complex
/// \ingroup PkgLinearCellComplexRef /// \ingroup PkgLinearCellComplexRef

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

@ -4,7 +4,7 @@
/// \ingroup PkgNef3Ref /// \ingroup PkgNef3Ref
/*! Draw. /*! Draw.
`#include <CGAL/draw_nef_3.h>` \cgalInclude{CGAL/draw_nef_3.h}
*/ */
/// \defgroup PkgDrawNef3 Draw a Nef Polyhedron /// \defgroup PkgDrawNef3 Draw a Nef Polyhedron
/// \ingroup PkgNef3Ref /// \ingroup PkgNef3Ref

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

@ -16,7 +16,7 @@
/// \ingroup PkgPeriodic2Triangulation2Ref /// \ingroup PkgPeriodic2Triangulation2Ref
/*! Draw. /*! Draw.
`#include <CGAL/draw_periodic_2_triangulation_2.h>` \cgalInclude{CGAL/draw_periodic_2_triangulation_2.h}
*/ */
/// \defgroup PkgDrawPeriodic2Triangulation2 Draw a 2D Periodic Triangulation /// \defgroup PkgDrawPeriodic2Triangulation2 Draw a 2D Periodic Triangulation
/// \ingroup PkgPeriodic2Triangulation2Ref /// \ingroup PkgPeriodic2Triangulation2Ref

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

@ -1,7 +1,7 @@
/// \defgroup PkgPointSet3Ref 3D Point Set Reference /// \defgroup PkgPointSet3Ref 3D Point Set Reference
/*! /*!
`#include <CGAL/draw_point_set_3.h>` \cgalInclude{CGAL/draw_point_set_3.h}
*/ */
/// \defgroup PkgDrawPointSet3D Draw a 3D Point Set /// \defgroup PkgDrawPointSet3D Draw a 3D Point Set
/// \ingroup PkgPointSet3Ref /// \ingroup PkgPointSet3Ref

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

@ -7,13 +7,13 @@
/// \ingroup PkgPolygon2Ref /// \ingroup PkgPolygon2Ref
/*! /*!
`#include <CGAL/draw_polygon_2.h>` \cgalInclude{CGAL/draw_polygon_2.h}
*/ */
/// \defgroup PkgDrawPolygon2 Draw a 2D Polygon /// \defgroup PkgDrawPolygon2 Draw a 2D Polygon
/// \ingroup PkgPolygon2Ref /// \ingroup PkgPolygon2Ref
/*! /*!
`#include <CGAL/draw_polygon_with_holes_2.h>` \cgalInclude{CGAL/draw_polygon_with_holes_2.h}
*/ */
/// \defgroup PkgDrawPolygonWithHoles2 Draw a 2D Polygon with Holes /// \defgroup PkgDrawPolygonWithHoles2 Draw a 2D Polygon with Holes
/// \ingroup PkgPolygon2Ref /// \ingroup PkgPolygon2Ref

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

@ -6,7 +6,7 @@
/// \ingroup PkgPolyhedronRef /// \ingroup PkgPolyhedronRef
/*! /*!
`#include <CGAL/draw_polyhedron.h>` \cgalInclude{CGAL/draw_polyhedron.h}
*/ */
/// \defgroup PkgDrawPolyhedron Draw a Polyhedron 3 /// \defgroup PkgDrawPolyhedron Draw a Polyhedron 3
/// \ingroup PkgPolyhedronRef /// \ingroup PkgPolyhedronRef

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

@ -1,7 +1,7 @@
/// \defgroup PkgSurface_mesh Surface Mesh Reference /// \defgroup PkgSurface_mesh Surface Mesh Reference
/*! /*!
`#include <CGAL/draw_surface_mesh.h>` \cgalInclude{CGAL/draw_surface_mesh.h}
*/ */
/// \defgroup PkgDrawSurfaceMesh Draw a Surface Mesh /// \defgroup PkgDrawSurfaceMesh Draw a Surface Mesh
/// \ingroup PkgSurface_mesh /// \ingroup PkgSurface_mesh

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

@ -7,7 +7,7 @@
/// \ingroup PkgSurfaceMeshTopologyRef /// \ingroup PkgSurfaceMeshTopologyRef
/*! /*!
`#include <CGAL/draw_face_graph_with_paths.h>` \cgalInclude{CGAL/draw_face_graph_with_paths.h}
*/ */
/// \defgroup PkgDrawFaceGraphWithPaths Draw a Mesh with Paths /// \defgroup PkgDrawFaceGraphWithPaths Draw a Mesh with Paths
/// \ingroup PkgSurfaceMeshTopologyRef /// \ingroup PkgSurfaceMeshTopologyRef

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

@ -14,7 +14,7 @@
/// \ingroup PkgTriangulation2Ref /// \ingroup PkgTriangulation2Ref
/*! /*!
`#include <CGAL/draw_triangulation_2.h>` \cgalInclude{CGAL/draw_triangulation_2.h}
*/ */
/// \defgroup PkgDrawTriangulation2 Draw a Triangulation 2 /// \defgroup PkgDrawTriangulation2 Draw a Triangulation 2
/// \ingroup PkgTriangulation2Ref /// \ingroup PkgTriangulation2Ref

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

@ -13,7 +13,7 @@
/// \ingroup PkgTriangulation3Ref /// \ingroup PkgTriangulation3Ref
/*! /*!
`#include <CGAL/draw_triangulation_3.h>` \cgalInclude{CGAL/draw_triangulation_3.h}
*/ */
/// \defgroup PkgDrawTriangulation3 Draw a Triangulation 3 /// \defgroup PkgDrawTriangulation3 Draw a Triangulation 3
/// \ingroup PkgTriangulation3Ref /// \ingroup PkgTriangulation3Ref

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

@ -13,7 +13,7 @@
/// \ingroup PkgVoronoiDiagram2Ref /// \ingroup PkgVoronoiDiagram2Ref
/*! /*!
`#include <CGAL/draw_voronoi_diagram_2.h>` \cgalInclude{CGAL/draw_voronoi_diagram_2.h}
*/ */
/// \defgroup PkgDrawVoronoiDiagram2 Draw a 2D Voronoi Diagram /// \defgroup PkgDrawVoronoiDiagram2 Draw a 2D Voronoi Diagram
/// \ingroup PkgVoronoiDiagram2Ref /// \ingroup PkgVoronoiDiagram2Ref

36
Weights/doc/Weights/PackageDescription.txt
View File

@ -19,7 +19,7 @@ Models and functions that can be used to compute weights which have a simple ana
\defgroup PkgWeightsRefUniformWeights Uniform Weight \defgroup PkgWeightsRefUniformWeights Uniform Weight
\ingroup PkgWeightsRefAnalytic \ingroup PkgWeightsRefAnalytic
`#include <CGAL/Weights/uniform_weights.h>` \cgalInclude{CGAL/Weights/uniform_weights.h}
This weight is always equal to 1. This weight is always equal to 1.
@ -33,7 +33,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefShepardWeights Shepard Weight \defgroup PkgWeightsRefShepardWeights Shepard Weight
\ingroup PkgWeightsRefAnalytic \ingroup PkgWeightsRefAnalytic
`#include <CGAL/Weights/shepard_weights.h>` \cgalInclude{CGAL/Weights/shepard_weights.h}
This weight is computed as This weight is computed as
\f$w = \frac{1}{d^a}\f$ \f$w = \frac{1}{d^a}\f$
@ -61,7 +61,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefInverseDistanceWeights Inverse Distance Weight \defgroup PkgWeightsRefInverseDistanceWeights Inverse Distance Weight
\ingroup PkgWeightsRefAnalytic \ingroup PkgWeightsRefAnalytic
`#include <CGAL/Weights/inverse_distance_weights.h>` \cgalInclude{CGAL/Weights/inverse_distance_weights.h}
This weight is computed as This weight is computed as
\f$w = \frac{1}{d}\f$ \f$w = \frac{1}{d}\f$
@ -90,7 +90,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefThreePointFamilyWeights Three Point Family Weight \defgroup PkgWeightsRefThreePointFamilyWeights Three Point Family Weight
\ingroup PkgWeightsRefAnalytic \ingroup PkgWeightsRefAnalytic
`#include <CGAL/Weights/three_point_family_weights.h>` \cgalInclude{CGAL/Weights/three_point_family_weights.h}
This weight is computed as This weight is computed as
\f$w = \frac{d_2^a A_0 - d^a B + d_0^a A_2}{A_0 A_2}\f$ \f$w = \frac{d_2^a A_0 - d^a B + d_0^a A_2}{A_0 A_2}\f$
@ -129,7 +129,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefWachspressWeights Wachspress Weight \defgroup PkgWeightsRefWachspressWeights Wachspress Weight
\ingroup PkgWeightsRefAnalytic \ingroup PkgWeightsRefAnalytic
`#include <CGAL/Weights/wachspress_weights.h>` \cgalInclude{CGAL/Weights/wachspress_weights.h}
This weight is computed as This weight is computed as
\f$w = \frac{C}{A_0 A_2}\f$ \f$w = \frac{C}{A_0 A_2}\f$
@ -160,7 +160,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefAuthalicWeights Authalic Weight \defgroup PkgWeightsRefAuthalicWeights Authalic Weight
\ingroup PkgWeightsRefAnalytic \ingroup PkgWeightsRefAnalytic
`#include <CGAL/Weights/authalic_weights.h>` \cgalInclude{CGAL/Weights/authalic_weights.h}
This weight is computed as This weight is computed as
\f$w = 2 \frac{\cot\beta + \cot\gamma}{d^2}\f$ \f$w = 2 \frac{\cot\beta + \cot\gamma}{d^2}\f$
@ -190,7 +190,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefMeanValueWeights Mean Value Weight \defgroup PkgWeightsRefMeanValueWeights Mean Value Weight
\ingroup PkgWeightsRefAnalytic \ingroup PkgWeightsRefAnalytic
`#include <CGAL/Weights/mean_value_weights.h>` \cgalInclude{CGAL/Weights/mean_value_weights.h}
This weight is computed as This weight is computed as
\f$w = \pm 2 \sqrt{\frac{2 (d_0 d_2 - D)}{(d d_0 + D_0)(d d_2 + D_2)}}\f$ \f$w = \pm 2 \sqrt{\frac{2 (d_0 d_2 - D)}{(d d_0 + D_0)(d d_2 + D_2)}}\f$
@ -227,7 +227,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefTangentWeights Tangent Weight \defgroup PkgWeightsRefTangentWeights Tangent Weight
\ingroup PkgWeightsRefAnalytic \ingroup PkgWeightsRefAnalytic
`#include <CGAL/Weights/tangent_weights.h>` \cgalInclude{CGAL/Weights/tangent_weights.h}
This weight is computed as This weight is computed as
\f$w = 2 \frac{t_1 + t_2}{d}\f$, where \f$w = 2 \frac{t_1 + t_2}{d}\f$, where
@ -262,7 +262,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefDiscreteHarmonicWeights Discrete Harmonic Weight \defgroup PkgWeightsRefDiscreteHarmonicWeights Discrete Harmonic Weight
\ingroup PkgWeightsRefAnalytic \ingroup PkgWeightsRefAnalytic
`#include <CGAL/Weights/discrete_harmonic_weights.h>` \cgalInclude{CGAL/Weights/discrete_harmonic_weights.h}
This weight is computed as This weight is computed as
\f$w = \frac{d_2^2 A_0 - d^2 B + d_0^2 A_2}{A_0 A_2}\f$ \f$w = \frac{d_2^2 A_0 - d^2 B + d_0^2 A_2}{A_0 A_2}\f$
@ -293,7 +293,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefCotangentWeights Cotangent Weight \defgroup PkgWeightsRefCotangentWeights Cotangent Weight
\ingroup PkgWeightsRefAnalytic \ingroup PkgWeightsRefAnalytic
`#include <CGAL/Weights/cotangent_weights.h>` \cgalInclude{CGAL/Weights/cotangent_weights.h}
This weight is computed as This weight is computed as
\f$w = 2 (\cot\beta + \cot\gamma)\f$ \f$w = 2 (\cot\beta + \cot\gamma)\f$
@ -328,7 +328,7 @@ to polygons. These weights are then normalized in order to obtain barycentric co
\defgroup PkgWeightsRefBarycentricWachspressWeights Wachspress Weights \defgroup PkgWeightsRefBarycentricWachspressWeights Wachspress Weights
\ingroup PkgWeightsRefBarycentric \ingroup PkgWeightsRefBarycentric
`#include <CGAL/Weights/wachspress_weights.h>` \cgalInclude{CGAL/Weights/wachspress_weights.h}
Wachspress weights which can be computed for a query point with respect to the Wachspress weights which can be computed for a query point with respect to the
vertices of a strictly convex polygon. vertices of a strictly convex polygon.
@ -339,7 +339,7 @@ vertices of a strictly convex polygon.
\defgroup PkgWeightsRefBarycentricMeanValueWeights Mean Value Weights \defgroup PkgWeightsRefBarycentricMeanValueWeights Mean Value Weights
\ingroup PkgWeightsRefBarycentric \ingroup PkgWeightsRefBarycentric
`#include <CGAL/Weights/mean_value_weights.h>` \cgalInclude{CGAL/Weights/mean_value_weights.h}
Mean value weights which can be computed for a query point with respect to the Mean value weights which can be computed for a query point with respect to the
vertices of a simple polygon. vertices of a simple polygon.
@ -350,7 +350,7 @@ vertices of a simple polygon.
\defgroup PkgWeightsRefBarycentricDiscreteHarmonicWeights Discrete Harmonic Weights \defgroup PkgWeightsRefBarycentricDiscreteHarmonicWeights Discrete Harmonic Weights
\ingroup PkgWeightsRefBarycentric \ingroup PkgWeightsRefBarycentric
`#include <CGAL/Weights/discrete_harmonic_weights.h>` \cgalInclude{CGAL/Weights/discrete_harmonic_weights.h}
Discrete Harmonic weights which can be computed for a query point with respect to the Discrete Harmonic weights which can be computed for a query point with respect to the
vertices of a strictly convex polygon. vertices of a strictly convex polygon.
@ -368,7 +368,7 @@ used to balance other weights.
\defgroup PkgWeightsRefUniformRegionWeights Uniform Region Weight \defgroup PkgWeightsRefUniformRegionWeights Uniform Region Weight
\ingroup PkgWeightsRefRegions \ingroup PkgWeightsRefRegions
`#include <CGAL/Weights/uniform_region_weights.h>` \cgalInclude{CGAL/Weights/uniform_region_weights.h}
This weight is always equal to 1. This weight is always equal to 1.
@ -382,7 +382,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefTriangularRegionWeights Triangular Region Weight \defgroup PkgWeightsRefTriangularRegionWeights Triangular Region Weight
\ingroup PkgWeightsRefRegions \ingroup PkgWeightsRefRegions
`#include <CGAL/Weights/triangular_region_weights.h>` \cgalInclude{CGAL/Weights/triangular_region_weights.h}
This weight is the area of the shaded region in the figure below. The region is This weight is the area of the shaded region in the figure below. The region is
the triangle `[p, q, r]`. the triangle `[p, q, r]`.
@ -401,7 +401,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefBarycentricRegionWeights Barycentric Region Weight \defgroup PkgWeightsRefBarycentricRegionWeights Barycentric Region Weight
\ingroup PkgWeightsRefRegions \ingroup PkgWeightsRefRegions
`#include <CGAL/Weights/barycentric_region_weights.h>` \cgalInclude{CGAL/Weights/barycentric_region_weights.h}
This weight is the area of the shaded region in the figure below. The region This weight is the area of the shaded region in the figure below. The region
is formed by the two midpoints of the edges incident to `q` and the barycenter of is formed by the two midpoints of the edges incident to `q` and the barycenter of
@ -421,7 +421,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefVoronoiRegionWeights Voronoi Region Weight \defgroup PkgWeightsRefVoronoiRegionWeights Voronoi Region Weight
\ingroup PkgWeightsRefRegions \ingroup PkgWeightsRefRegions
`#include <CGAL/Weights/voronoi_region_weights.h>` \cgalInclude{CGAL/Weights/voronoi_region_weights.h}
This weight is the area of the shaded region in the figure below. The region This weight is the area of the shaded region in the figure below. The region
is formed by the two midpoints of the edges incident to `q` and the circumcenter of is formed by the two midpoints of the edges incident to `q` and the circumcenter of
@ -443,7 +443,7 @@ a model of `AnalyticWeightTraits_3` for 3D points
\defgroup PkgWeightsRefMixedVoronoiRegionWeights Mixed Voronoi Region Weight \defgroup PkgWeightsRefMixedVoronoiRegionWeights Mixed Voronoi Region Weight
\ingroup PkgWeightsRefRegions \ingroup PkgWeightsRefRegions
`#include <CGAL/Weights/mixed_voronoi_region_weights.h>` \cgalInclude{CGAL/Weights/mixed_voronoi_region_weights.h}
This weight is the area of the shaded region in the figure below. The region This weight is the area of the shaded region in the figure below. The region
is formed by the two midpoints of the edges incident to `q` and the circumcenter of is formed by the two midpoints of the edges incident to `q` and the circumcenter of