Skip to content

Commit

Permalink
Merge pull request #7804 from afabri/CGAL-ingroup-GF
Browse files Browse the repository at this point in the history
Fix wrong \ingroup statements
  • Loading branch information
lrineau committed Oct 30, 2023
2 parents 7ae6952 + 0acea19 commit 7ce782e
Show file tree
Hide file tree
Showing 13 changed files with 16 additions and 24 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

/*!
\ingroup PkgAlgebraicFoundationsInteroperabilityConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalConcept
Two types `A` and `B` are a model of the `ExplicitInteroperable`
Expand All @@ -27,4 +27,3 @@ class ExplicitInteroperable {
public:

}; /* end ExplicitInteroperable */

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

/*!
\ingroup PkgAlgebraicFoundationsFractionsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalConcept
A type is considered as a `Fraction`, if there is a reasonable way to
Expand All @@ -17,4 +17,3 @@ class Fraction {
public:

}; /* end Fraction */

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalConcept
A model of the concept `FromDoubleConstructible` is required
Expand All @@ -27,4 +27,3 @@ FromDoubleConstructible(const double& d);
/// @}

}; /* end FromDoubleConstructible */

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

/*!
\ingroup PkgAlgebraicFoundationsConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalConcept
A model of the concept `FromIntConstructible` is required
Expand Down Expand Up @@ -28,4 +28,3 @@ FromIntConstructible(int& i);
/// @}

}; /* end FromIntConstructible */

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

/*!
\ingroup PkgAlgebraicFoundationsInteroperabilityConcepts
\ingroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts
\cgalConcept
Two types `A` and `B` are a model of the concept
Expand Down Expand Up @@ -29,4 +29,3 @@ class ImplicitInteroperable {
public:

}; /* end ImplicitInteroperable */

1 change: 0 additions & 1 deletion Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_2.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
namespace CGAL {

/*!
\ingroup kernel_affine
\ingroup kernel_classes2
The class `Aff_transformation_2` represents two-dimensional affine transformations.
Expand Down
1 change: 0 additions & 1 deletion Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_3.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ namespace CGAL {

/*!
\ingroup kernel_classes3
\ingroup kernel_affine
The class `Aff_transformation_3` represents three-dimensional affine transformations.
The general form of an affine transformation is based on a homogeneous
Expand Down
10 changes: 5 additions & 5 deletions Kernel_23/doc/Kernel_23/CGAL/aff_transformation_tags.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
namespace CGAL {

/*!
\ingroup kernel_affine
\ingroup PkgKernel23Ref
Tag class for affine transformations.
Expand All @@ -24,7 +24,7 @@ class Identity_transformation {
namespace CGAL {

/*!
\ingroup kernel_affine
\ingroup PkgKernel23Ref
Tag class for affine transformations.
Expand All @@ -46,7 +46,7 @@ class Reflection {
namespace CGAL {

/*!
\ingroup kernel_affine
\ingroup PkgKernel23Ref
Tag class for affine transformations.
Expand All @@ -68,7 +68,7 @@ class Rotation {
namespace CGAL {

/*!
\ingroup kernel_affine
\ingroup PkgKernel23Ref
Tag class for affine transformations.
Expand All @@ -90,7 +90,7 @@ class Scaling {
namespace CGAL {

/*!
\ingroup kernel_affine
\ingroup PkgKernel23Ref
Tag class for affine transformations.
Expand Down
4 changes: 2 additions & 2 deletions Kernel_23/doc/Kernel_23/CGAL/intersections.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function are available.

/*!
\addtogroup do_intersect_linear_grp
\ingroup do_intersect
\ingroup do_intersect_grp
\sa `do_intersect_circular_grp`
\sa `do_intersect_spherical_grp`
Expand Down Expand Up @@ -79,7 +79,7 @@ function are available.

/*!
\addtogroup intersection_linear_grp
\ingroup intersection
\ingroup intersection_grp
*/
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class Greene_convex_decomposition_2 {
namespace CGAL {

/*!
\ingroup PkgMinkowskiSum2Classes
\ingroup PkgMinkowskiSum2Ref
The `Hertel_Mehlhorn_convex_decomposition_2` class implements the approximation algorithm of Hertel
and Mehlhorn for decomposing a polygon into convex
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
namespace CGAL {

/*!
\ingroup PkgPolygonalSurfaceReconstruction
\ingroup PkgPolygonalSurfaceReconstructionRef
\brief
Expand Down
2 changes: 1 addition & 1 deletion Solver_interface/include/CGAL/Eigen_sparse_matrix.h
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ struct Eigen_sparse_matrix


/*!
\ingroup PkgSolverInterfaceRefLS
\ingroup PkgSolverInterfaceLS
The class `Eigen_sparse_symmetric_matrix` is a wrapper around `Eigen` matrix type
<a href="https://eigen.tuxfamily.org/dox/classEigen_1_1SparseMatrix.html">`Eigen::SparseMatrix` </a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
// Author(s) : Mael Rouxel-Labbé

/**
* \ingroup PkgSurfaceMeshParameterization
* \ingroup PkgSurfaceMeshParameterizationRef
* \file CGAL/surface_mesh_parameterization.h
* Convenience header file including the headers for all
* the free functions of this package.
Expand All @@ -34,4 +34,3 @@
#include <CGAL/Surface_mesh_parameterization/Circular_border_parameterizer_3.h>
#include <CGAL/Surface_mesh_parameterization/Square_border_parameterizer_3.h>
#include <CGAL/Surface_mesh_parameterization/Two_vertices_parameterizer_3.h>

0 comments on commit 7ce782e

Please sign in to comment.