diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h b/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h index ec017f1efe3..c5b4eb97f1b 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAABB_treeConcepts +\ingroup PkgAABBTreeConcepts \cgalConcept The concept `AABBGeomTraits` defines the requirements for the first template parameter of the class `CGAL::AABB_traits`. It provides predicates and constructors to detect and compute intersections between query objects and the primitives stored in the AABB tree. In addition, it contains predicates and constructors to compute distances between a point query and the primitives stored in the AABB tree. diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h index 93a4b42efee..64962d12741 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAABB_treeConcepts +\ingroup PkgAABBTreeConcepts \cgalConcept The concept `AABBPrimitive` describes the requirements for the primitives stored in the AABB tree data structure. The concept encapsulates a type for the input datum (a geometric object) and an identifier (id) type through which those primitives are referred to. The concept `AABBPrimitive` also refines the concepts DefaultConstructible and Assignable. diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitiveWithSharedData.h b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitiveWithSharedData.h index 406c581c415..fb740edf212 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitiveWithSharedData.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitiveWithSharedData.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgAABB_treeConcepts +\ingroup PkgAABBTreeConcepts \cgalConcept The concept `AABBPrimitiveWithSharedData` describes the requirements for the primitives diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionGeomTraits.h b/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionGeomTraits.h index 9cbf77a1183..22ce34118d3 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionGeomTraits.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionGeomTraits.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgAABB_treeConcepts +\ingroup PkgAABBTreeConcepts \cgalConcept The concept `AABBRayIntersectionGeomTraits` is a refinement of the diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionTraits.h b/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionTraits.h index 68d3d4d3a68..dfe82f27d01 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionTraits.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionTraits.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgAABB_treeConcepts +\ingroup PkgAABBTreeConcepts \cgalConcept The concept `AABBRayIntersectionTraits` is a refinement of the concept diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h b/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h index 123bda80c47..635c2a4d27a 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAABB_treeConcepts +\ingroup PkgAABBTreeConcepts \cgalConcept The concept `AABBTraits` provides the geometric primitive types and methods for the class `CGAL::AABB_tree`. diff --git a/AABB_tree/doc/AABB_tree/PackageDescription.txt b/AABB_tree/doc/AABB_tree/PackageDescription.txt index e94a561f00a..7df50a91fd1 100644 --- a/AABB_tree/doc/AABB_tree/PackageDescription.txt +++ b/AABB_tree/doc/AABB_tree/PackageDescription.txt @@ -1,16 +1,16 @@ -/// \defgroup PkgAABB_tree AABB Tree Reference +/// \defgroup PkgAABBTreeRef AABB Tree Reference -/// \defgroup PkgAABB_treeConcepts Concepts -/// \ingroup PkgAABB_tree +/// \defgroup PkgAABBTreeConcepts Concepts +/// \ingroup PkgAABBTreeRef /*! -\addtogroup PkgAABB_tree -\cgalPkgDescriptionBegin{3D Fast Intersection and Distance Computation,PkgAABB_treeSummary} +\addtogroup PkgAABBTreeRef +\cgalPkgDescriptionBegin{3D Fast Intersection and Distance Computation,PkgAABBTree} \cgalPkgPicture{aabb-teaser-thumb.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Pierre Alliez, Stéphane Tayeb, Camille Wormser} \cgalPkgDesc{The AABB (axis-aligned bounding box) tree component offers a static data structure and algorithms to perform efficient intersection and distance queries on sets of finite 3D geometric objects.} -\cgalPkgManuals{Chapter_3D_Fast_Intersection_and_Distance_Computation,PkgAABB_tree} +\cgalPkgManuals{Chapter_3D_Fast_Intersection_and_Distance_Computation,PkgAABBTreeRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} diff --git a/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h b/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h index 83e01c72d6c..ebb695c485e 100644 --- a/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h +++ b/AABB_tree/include/CGAL/AABB_face_graph_triangle_primitive.h @@ -34,7 +34,7 @@ namespace CGAL { /*! - * \ingroup PkgAABB_tree + * \ingroup PkgAABBTreeRef * Primitive type for a facet of a polyhedral surface. * It wraps a handle to a facet of a polyhedron to a 3D triangle. * The polyhedron from which the primitive is built should not be deleted diff --git a/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h b/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h index 1a0dc4eb616..99d1795d2c3 100644 --- a/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h +++ b/AABB_tree/include/CGAL/AABB_halfedge_graph_segment_primitive.h @@ -42,7 +42,7 @@ namespace CGAL { /*! - * \ingroup PkgAABB_tree + * \ingroup PkgAABBTreeRef * Primitive type for a edge of a polyhedral surface. * It wraps an `edge_descriptor` into a 3D segment. * The class model of `HalfedgeGraph` from which the primitive is built should not be deleted diff --git a/AABB_tree/include/CGAL/AABB_polyhedron_segment_primitive.h b/AABB_tree/include/CGAL/AABB_polyhedron_segment_primitive.h index 85798d83374..4db0f6eae75 100644 --- a/AABB_tree/include/CGAL/AABB_polyhedron_segment_primitive.h +++ b/AABB_tree/include/CGAL/AABB_polyhedron_segment_primitive.h @@ -40,7 +40,7 @@ namespace CGAL { -/// \addtogroup PkgAABB_tree +/// \addtogroup PkgAABBTreeRef /// @{ /// \deprecated This class is deprecated since \cgal 4.3, the class /// `AABB_halfedge_graph_segment_primitive` should be used instead. diff --git a/AABB_tree/include/CGAL/AABB_polyhedron_triangle_primitive.h b/AABB_tree/include/CGAL/AABB_polyhedron_triangle_primitive.h index 363a718c03f..92cc3e165ab 100644 --- a/AABB_tree/include/CGAL/AABB_polyhedron_triangle_primitive.h +++ b/AABB_tree/include/CGAL/AABB_polyhedron_triangle_primitive.h @@ -35,7 +35,7 @@ #include namespace CGAL { - /// \ingroup PkgAABB_tree + /// \ingroup PkgAABBTreeRef /// \deprecated This class is deprecated since \cgal 4.3, the class /// `AABB_face_graph_triangle_primitive` should be used instead. /// diff --git a/AABB_tree/include/CGAL/AABB_primitive.h b/AABB_tree/include/CGAL/AABB_primitive.h index 205dad36754..6e08c8800a2 100644 --- a/AABB_tree/include/CGAL/AABB_primitive.h +++ b/AABB_tree/include/CGAL/AABB_primitive.h @@ -57,7 +57,7 @@ public: #ifdef DOXYGEN_RUNNING /*! - * \ingroup PkgAABB_tree + * \ingroup PkgAABBTreeRef * Generic primitive type. * The two property maps which are template parameters of the class enable to get the datum and the reference point of * the primitive from the identifier. The last template parameter controls whether the primitive class holds a copy of the datum. diff --git a/AABB_tree/include/CGAL/AABB_segment_primitive.h b/AABB_tree/include/CGAL/AABB_segment_primitive.h index 00618eafd34..872fa2f5b46 100644 --- a/AABB_tree/include/CGAL/AABB_segment_primitive.h +++ b/AABB_tree/include/CGAL/AABB_segment_primitive.h @@ -56,7 +56,7 @@ namespace internal { /*! - * \ingroup PkgAABB_tree + * \ingroup PkgAABBTreeRef * Primitive type that uses as identifier an iterator with a 3D segment as `value_type`. * The iterator from which the primitive is built should not be invalided * while the AABB tree holding the primitive is in use. diff --git a/AABB_tree/include/CGAL/AABB_traits.h b/AABB_tree/include/CGAL/AABB_traits.h index 632f2256d4b..9b5f3c43ea9 100644 --- a/AABB_tree/include/CGAL/AABB_traits.h +++ b/AABB_tree/include/CGAL/AABB_traits.h @@ -173,7 +173,7 @@ struct AABB_traits_base_2{ } } //end of namespace internal::AABB_tree -/// \addtogroup PkgAABB_tree +/// \addtogroup PkgAABBTreeRef /// @{ /// This traits class handles any type of 3D geometric diff --git a/AABB_tree/include/CGAL/AABB_tree.h b/AABB_tree/include/CGAL/AABB_tree.h index d4275852147..2463a822191 100644 --- a/AABB_tree/include/CGAL/AABB_tree.h +++ b/AABB_tree/include/CGAL/AABB_tree.h @@ -44,7 +44,7 @@ namespace CGAL { -/// \addtogroup PkgAABB_tree +/// \addtogroup PkgAABBTreeRef /// @{ /** diff --git a/AABB_tree/include/CGAL/AABB_triangle_primitive.h b/AABB_tree/include/CGAL/AABB_triangle_primitive.h index 4b2035e00f4..639a7dab307 100644 --- a/AABB_tree/include/CGAL/AABB_triangle_primitive.h +++ b/AABB_tree/include/CGAL/AABB_triangle_primitive.h @@ -56,7 +56,7 @@ namespace internal { /*! - * \ingroup PkgAABB_tree + * \ingroup PkgAABBTreeRef * Primitive type that uses as identifier an iterator with a 3D triangle as `value_type`. * The iterator from which the primitive is built should not be invalided * while the AABB tree holding the primitive is in use. diff --git a/AABB_tree/include/CGAL/AABB_triangulation_3_triangle_primitive.h b/AABB_tree/include/CGAL/AABB_triangulation_3_triangle_primitive.h index 96f4b305f28..6cd04d5aca8 100644 --- a/AABB_tree/include/CGAL/AABB_triangulation_3_triangle_primitive.h +++ b/AABB_tree/include/CGAL/AABB_triangulation_3_triangle_primitive.h @@ -31,7 +31,7 @@ #include namespace CGAL { - // \ingroup PkgAABB_tree + // \ingroup PkgAABBTreeRef // Primitive type that wraps a facet handle of a CGAL::Triangulation_3, // which is used as id, and allows the construction of the datum on // the fly. Since only the facet handle is stored in this primitive, 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 8e104c34c35..d944d7fbbbf 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,9 +1,9 @@ -/// \defgroup PkgAdvancingFrontSurfaceReconstruction Advancing Front Surface Reconstruction Reference +/// \defgroup PkgAdvancingFrontSurfaceReconstructionRef Advancing Front Surface Reconstruction Reference /*! -\addtogroup PkgAdvancingFrontSurfaceReconstruction +\addtogroup PkgAdvancingFrontSurfaceReconstructionRef -\cgalPkgDescriptionBegin{Advancing Front Surface Reconstruction,PkgAdvancingFrontSurfaceReconstructionSummary} +\cgalPkgDescriptionBegin{Advancing Front Surface Reconstruction,PkgAdvancingFrontSurfaceReconstruction} \cgalPkgPicture{afsr-detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Tran Kai Frank Da, David Cohen-Steiner} @@ -12,11 +12,11 @@ unorganized point set. Starting from a seed facet, a piecewise linear surface is grown by adding Delaunay triangles one by one. The most plausible triangles are added first, in a way that avoids the appearance of topological singularities. } -\cgalPkgManuals{Chapter_Advancing_Front_Surface_Reconstruction,PkgAdvancingFrontSurfaceReconstruction} +\cgalPkgManuals{Chapter_Advancing_Front_Surface_Reconstruction,PkgAdvancingFrontSurfaceReconstructionRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.7} -\cgalPkgDependsOn{\ref PkgTriangulation3Summary} +\cgalPkgDependsOn{\ref PkgTriangulation3} \cgalPkgBib{cgal:dc-afsr} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgShortInfoEnd 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 6fc6e33b4d8..f97c3bca853 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 @@ -175,7 +175,7 @@ namespace CGAL { /*! - \ingroup PkgAdvancingFrontSurfaceReconstruction + \ingroup PkgAdvancingFrontSurfaceReconstructionRef The class `Advancing_front_surface_reconstruction` enables advanced users to provide the unstructured point cloud in a 3D Delaunay triangulation. The reconstruction algorithm then marks vertices and faces @@ -2480,7 +2480,7 @@ namespace CGAL { } /*! - \ingroup PkgAdvancingFrontSurfaceReconstruction + \ingroup PkgAdvancingFrontSurfaceReconstructionRef For a sequence of points computes a sequence of index triples describing the faces of the reconstructed surface. @@ -2532,7 +2532,7 @@ namespace CGAL { } /*! - \ingroup PkgAdvancingFrontSurfaceReconstruction + \ingroup PkgAdvancingFrontSurfaceReconstructionRef For a sequence of points computes a sequence of index triples describing the faces of the reconstructed surface. diff --git a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_cell_base_3.h b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_cell_base_3.h index 99cfa924cdf..eac9e519d77 100644 --- a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_cell_base_3.h +++ b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_cell_base_3.h @@ -28,7 +28,7 @@ namespace CGAL { /*! - \ingroup PkgAdvancingFrontSurfaceReconstruction + \ingroup PkgAdvancingFrontSurfaceReconstructionRef The class `Advancing_front_surface_reconstruction_cell_base_3` is the default cell type for the class `Advancing_front_surface_reconstruction`. diff --git a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_vertex_base_3.h b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_vertex_base_3.h index 1d381ccc89c..050e14036fd 100644 --- a/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_vertex_base_3.h +++ b/Advancing_front_surface_reconstruction/include/CGAL/Advancing_front_surface_reconstruction_vertex_base_3.h @@ -38,7 +38,7 @@ namespace CGAL { template class Advancing_front_surface_reconstruction; /*! - \ingroup PkgAdvancingFrontSurfaceReconstruction + \ingroup PkgAdvancingFrontSurfaceReconstructionRef The class `Advancing_front_surface_reconstruction_vertex_base_3` is the default vertex type for the class `Advancing_front_surface_reconstruction`. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt b/Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt index 7e6c7d0039d..6e08371d24e 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 PkgAlgebraicFoundations in the reference manual. +Section \ref PkgAlgebraicFoundationsRef in the reference manual. \subsection Algebraic_foundationsTagsinAlgebraicStructure Tags in Algebraic Structure Traits diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h index 38d35c6cf27..fee8e9b1daa 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An instance of `Algebraic_structure_traits` is a model of `AlgebraicStructureTraits`, where T is the associated type. @@ -17,7 +17,7 @@ class Algebraic_structure_traits { namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `EuclideanRing` concept. @@ -34,7 +34,7 @@ struct Euclidean_ring_tag : public Unique_factorization_domain_tag { }; /* end Euclidean_ring_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `Field` concept. @@ -50,7 +50,7 @@ struct Field_tag : public Integral_domain_tag { }; /* end Field_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `FieldWithKthRoot` concept. @@ -66,7 +66,7 @@ struct Field_with_kth_root_tag : public Field_with_sqrt_tag { }; /* end Field_with_kth_root_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `FieldWithRootOf` concept. @@ -82,7 +82,7 @@ struct Field_with_root_of_tag : public Field_with_kth_root_tag { }; /* end Field_with_root_of_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `FieldWithSqrt` concept. @@ -98,7 +98,7 @@ struct Field_with_sqrt_tag : public Field_tag { }; /* end Field_with_sqrt_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `IntegralDomain` concept. @@ -114,7 +114,7 @@ struct Integral_domain_tag : public Integral_domain_without_division_tag { }; /* end Integral_domain_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `IntegralDomainWithoutDivision` concept. @@ -129,7 +129,7 @@ struct Integral_domain_without_division_tag { }; /* end Integral_domain_without_division_tag */ /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef Tag indicating that a type is a model of the `UniqueFactorizationDomain` concept. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h index 7c1bbf3fbcb..51241f2fec2 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An instance of `Coercion_traits` reflects the type coercion of the types A and B, it is symmetric in the two template arguments. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h index 0e2575ec3cf..5888f705f3f 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An instance of `Fraction_traits` is a model of `FractionTraits`, where `T` is the associated type. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h index d4f7b67e6b8..fa61be8f8df 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An instance of `Real_embeddable_traits` is a model of `RealEmbeddableTraits`, where T is the associated type. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h index 28fe692ade1..153988e6d93 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/number_utils.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `abs()` returns the absolute value of a number. @@ -19,7 +19,7 @@ template NT abs(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `compare()` compares the first argument with respect to the second, i.e.\ it returns `CGAL::LARGER` if \f$ x\f$ is larger then \f$ y\f$. @@ -43,7 +43,7 @@ result_type compare(const NT &x, const NT &y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `div()` computes the integral quotient of division with remainder. @@ -74,7 +74,7 @@ div(const NT1& x, const NT2& y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef computes the quotient \f$ q\f$ and remainder \f$ r\f$, such that \f$ x = q*y + r\f$ and \f$ r\f$ minimal with respect to the Euclidean Norm of the @@ -109,7 +109,7 @@ div_mod(const NT1& x, const NT2& y, result_type& q, result_type& r); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `gcd()` computes the greatest common divisor of two values. @@ -136,7 +136,7 @@ gcd(const NT1& x, const NT2& y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `integral_division()` (a.k.a.\ exact division or division without remainder) maps ring elements \f$ (x,y)\f$ to ring element \f$ z\f$ such that \f$ x = yz\f$ if such a \f$ z\f$ @@ -167,7 +167,7 @@ integral_division(const NT1& x, const NT2& y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `inverse()` returns the inverse element with respect to multiplication. @@ -187,7 +187,7 @@ template NT inverse(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `is_negative()` determines if a value is negative or not. The function is defined if the argument type @@ -206,7 +206,7 @@ result_type is_negative(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `is_one()` determines if a value is equal to 1 or not. @@ -226,7 +226,7 @@ template result_type is_one(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `is_positive()` determines if a value is positive or not. The function is defined if the argument type @@ -245,7 +245,7 @@ result_type is_positive(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An ring element \f$ x\f$ is said to be a square iff there exists a ring element \f$ y\f$ such @@ -264,7 +264,7 @@ The `result_type` is convertible to `bool`. template result_type is_square(const NT& x); /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef An ring element \f$ x\f$ is said to be a square iff there exists a ring element \f$ y\f$ such @@ -287,7 +287,7 @@ template result_type is_square(const NT& x, NT& y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `is_zero()` determines if a value is equal to 0 or not. @@ -309,7 +309,7 @@ template result_type is_zero(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `kth_root()` returns the k-th root of a value. @@ -327,7 +327,7 @@ template NT kth_root(int k, const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `mod()` computes the remainder of division with remainder. @@ -357,7 +357,7 @@ mod(const NT1& x, const NT2& y); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef returns the k-th real root of the univariate polynomial, which is defined by the iterator range, where begin refers to the constant @@ -383,7 +383,7 @@ root_of(int k, InputIterator begin, InputIterator end); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `sign()` returns the sign of its argument. @@ -403,7 +403,7 @@ template result_type sign(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `simplify()` may simplify a given object. @@ -421,7 +421,7 @@ template void simplify(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `sqrt()` returns the square root of a value. @@ -439,7 +439,7 @@ template NT sqrt(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `square()` returns the square of a number. @@ -457,7 +457,7 @@ template NT square(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `to_double()` returns a double approximation of a number. Note that in general, the value returned is not guaranteed to be the same @@ -482,7 +482,7 @@ template double to_double(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The template function `to_interval()` computes for a given real embeddable number \f$ x\f$ a double interval containing \f$ x\f$. @@ -502,7 +502,7 @@ std::pair to_interval(const NT& x); namespace CGAL { /*! -\ingroup PkgAlgebraicFoundations +\ingroup PkgAlgebraicFoundationsRef The function `unit_part()` computes the unit part of a given ring element. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt index 9a5d49ffebf..cbf66ce5727 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt +++ b/Algebraic_foundations/doc/Algebraic_foundations/PackageDescription.txt @@ -1,18 +1,18 @@ -/// \defgroup PkgAlgebraicFoundations Algebraic Foundations Reference +/// \defgroup PkgAlgebraicFoundationsRef Algebraic Foundations Reference /// \defgroup PkgAlgebraicFoundationsAlgebraicStructuresConcepts Concepts -/// \ingroup PkgAlgebraicFoundations +/// \ingroup PkgAlgebraicFoundationsRef /*! -\addtogroup PkgAlgebraicFoundations +\addtogroup PkgAlgebraicFoundationsRef \todo check generated documentation -\cgalPkgDescriptionBegin{Algebraic Foundations,PkgAlgebraicFoundationsSummary} +\cgalPkgDescriptionBegin{Algebraic Foundations,PkgAlgebraicFoundations} \cgalPkgPicture{Algebraic_foundations2.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Michael Hemmer} \cgalPkgDesc{This package defines what algebra means for \cgal, in terms of concepts, classes and functions. The main features are: (i) explicit concepts for interoperability of types (ii) separation between algebraic types (not necessarily embeddable into the reals), and number types (embeddable into the reals).} -\cgalPkgManuals{Chapter_Algebraic_Foundations,PkgAlgebraicFoundations} +\cgalPkgManuals{Chapter_Algebraic_Foundations,PkgAlgebraicFoundationsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h index 99aee7837cc..632bd0c756b 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicKerneldModels +\ingroup PkgAlgebraicKernelDModels The class represents an algebraic real root by a square free polynomial and an isolating interval that uniquely defines the root. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h index a499a94861d..7e8cbc60291 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicKerneldModels +\ingroup PkgAlgebraicKernelDModels This class gathers necessary tools for solving and handling bivariate polynomial systems of general degree \f$ d\f$. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h index 653c7f56cb3..3498dcb2ab8 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicKerneldModels +\ingroup PkgAlgebraicKernelDModels \anchor Algebraic_kernel_rs_gmpq_d_1 diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h index 70fdccc2963..665aa563e40 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlgebraicKerneldModels +\ingroup PkgAlgebraicKernelDModels \anchor Algebraic_kernel_rs_gmpz_d_1 diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h index 2896acf2af3..9c142688f05 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept A model of `AlgebraicKernel_d_1::ApproximateAbsolute_1` is an `AdaptableBinaryFunction` that computes an diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h index 3a2cf52c468..977c3eb0510 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept A model of `AlgebraicKernel_d_1::ApproximateRelative_1` is an `AdaptableBinaryFunction` that computes an diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h index 5af5cb25f25..532708bbc66 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Computes a number of type diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h index 5d7e8b3c53f..93a3245ccb8 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Compares `AlgebraicKernel_d_1::Algebraic_real_1` values. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h index afc9fea9e3b..29fc14de953 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Computes a square free univariate polynomial \f$ p\f$, such that the given diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h index ec36d8c0991..82ccd3d56f1 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Constructs `AlgebraicKernel_d_1::Algebraic_real_1`. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h index 25e71199630..e8d8ddd1d20 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Determines whether a given pair of univariate polynomials \f$ p_1, p_2\f$ is coprime, diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h index ca73f908aa3..b6cfbaac082 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Computes whether the given univariate polynomial is square free. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h index d9ab0797c85..7c43c21ba54 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Computes whether an `AlgebraicKernel_d_1::Polynomial_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h index 6ddac9ad06a..9613ee51637 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Computes an open isolating interval for an `AlgebraicKernel_d_1::Algebraic_real_1` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h index fa95de42270..3ac3797a706 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Computes for a given pair of univariate polynomials \f$ p_1\f$, \f$ p_2\f$ their diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h index 2b60ca4d321..8b71414d61f 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Returns a square free part of a univariate polynomial. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h index 8dd23b95d6d..52bf33c0067 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Computes the number of real solutions of the given univariate polynomial. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h index c79e3136e8a..565ce13b992 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Computes the sign of a univariate polynomial diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h index 18e71de141c..b7f976f0486 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Computes the real roots of a univariate polynomial. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h index d50560b29a9..91971c4f575 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept Computes a square free factorization of an diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h index 70660d6abc1..7d7cd3b4289 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsUni +\ingroup PkgAlgebraicKernelDConceptsUni \cgalConcept A model of the `AlgebraicKernel_d_1` concept is meant to provide the diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h index dfbd40c5c29..8fb754c7cc2 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept A model of `AlgebraicKernel_d_2::ApproximateAbsoluteX_2` is an `AdaptableBinaryFunction` that computes an diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h index 9d4a8b94834..298cf2ea7a2 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept A model of `AlgebraicKernel_d_2::ApproximateAbsoluteY_2` is an `AdaptableBinaryFunction` that computes an diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h index 965db4cb55c..0b07fdbdf84 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept A model of `AlgebraicKernel_d_2::ApproximateRelativeX_2` is an `AdaptableBinaryFunction` that computes an diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h index fcec3b5cb92..00676a98ded 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept A model of `AlgebraicKernel_d_2::ApproximateRelativeY_2` is an `AdaptableBinaryFunction` that computes an diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h index bf11f493b57..ccaac45c12b 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes a number of type diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h index 3f6709c4455..901c3162d97 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes a number of type diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h index cfdefc0a995..c8bb07c059d 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Compares `AlgebraicKernel_d_2::Algebraic_real_2`s lexicographically. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h index 620bb133b08..380aded006c 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Compares the first coordinates of `AlgebraicKernel_d_2::Algebraic_real_2`s. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h index 9d6b3483103..6c58335c8a8 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Compares the second coordinated of `AlgebraicKernel_d_2::Algebraic_real_2`s. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h index e972739323b..c412d6fce76 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes a univariate square free polynomial \f$ p\f$, such that the first coordinate of diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h index 8625e4c0ae5..7a9e46a4cbb 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes a univariate square free polynomial \f$ p\f$, such that the second coordinate of diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h index d23478e27ee..3f3b19583ec 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes the first coordinate of an diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h index de9c9f0556b..5edc195f8a6 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes the second coordinate of an diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h index c43f2f0664a..4eaaeda2f26 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Constructs an `AlgebraicKernel_d_2::Algebraic_real_2`. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h index 70d7cabfeb6..70e920f5abc 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes whether a given pair of bivariate polynomials is coprime. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h index a73d574680e..bd8fb58f588 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes whether the given bivariate polynomial is square free. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h index 7add7a0ba30..bd7871600c6 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes whether an `AlgebraicKernel_d_2::Polynomial_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h index 1c8d09dbaad..5574fa4db2d 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes an isolating interval for the first coordinate of an `AlgebraicKernel_d_2::Algebraic_real_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h index 09d35efb5db..0d5e978d941 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes an isolating interval for the second coordinate of an `AlgebraicKernel_d_2::Algebraic_real_2` diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Isolate_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Isolate_2.h index e3dcef25a28..5c8d68973d5 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Isolate_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Isolate_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes an isolating box for a given `AlgebraicKernel_d_2::Algebraic_real_2`. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h index d5ac00efc69..155bdbf65d5 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes for a given pair of bivariate polynomials \f$ p_1\f$, \f$ p_2\f$ their diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h index f9175866e5d..acf5ec20cf7 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Returns a square free part of a bivariate polynomial. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h index be42927f55e..9d89a8a885f 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes the number of real solutions of the given bivariate polynomial system. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h index 1848718d807..c63604b2d38 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes the sign of a bivariate polynomial diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h index 50541524b2d..fefefd5b322 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes the real zero-dimensional solutions of a bivariate polynomial system. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h index e0e754c0adb..48a73376c7c 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept Computes a square free factorization of an diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h index 758d153c06f..53d701efa69 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlgebraicKerneldConceptsBi +\ingroup PkgAlgebraicKernelDConceptsBi \cgalConcept A model of the `AlgebraicKernel_d_2` concept gathers necessary tools diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt b/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt index c47391fc374..1aeab366c90 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/PackageDescription.txt @@ -1,28 +1,28 @@ -/// \defgroup PkgAlgebraicKerneld Algebraic Kernel Reference +/// \defgroup PkgAlgebraicKernelDRef Algebraic Kernel Reference -/// \defgroup PkgAlgebraicKerneldConcepts Concepts -/// \ingroup PkgAlgebraicKerneld +/// \defgroup PkgAlgebraicKernelDConcepts Concepts +/// \ingroup PkgAlgebraicKernelDRef -/// \defgroup PkgAlgebraicKerneldConceptsUni Univariate Algebraic Kernel -/// \ingroup PkgAlgebraicKerneldConcepts +/// \defgroup PkgAlgebraicKernelDConceptsUni Univariate Algebraic Kernel +/// \ingroup PkgAlgebraicKernelDConcepts -/// \defgroup PkgAlgebraicKerneldConceptsBi Bivariate Algebraic Kernel -/// \ingroup PkgAlgebraicKerneldConcepts +/// \defgroup PkgAlgebraicKernelDConceptsBi Bivariate Algebraic Kernel +/// \ingroup PkgAlgebraicKernelDConcepts -/// \defgroup PkgAlgebraicKerneldModels Models -/// \ingroup PkgAlgebraicKerneld +/// \defgroup PkgAlgebraicKernelDModels Models +/// \ingroup PkgAlgebraicKernelDRef /*! -\addtogroup PkgAlgebraicKerneld +\addtogroup PkgAlgebraicKernelDRef \todo check generated documentation -\cgalPkgDescriptionBegin{Algebraic Kernel,PkgAlgebraicKerneldSummary} +\cgalPkgDescriptionBegin{Algebraic Kernel,PkgAlgebraicKernelD} \cgalPkgPicture{Algebraic_kernel_d.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Eric Berberich, Michael Hemmer, Michael Kerber, Sylvain Lazard, Luis Peñaranda, and Monique Teillaud} \cgalPkgDesc{Real solving of polynomials is a fundamental problem with a wide application range. This package is targeted to provide black-box implementations of state-of-the-art algorithms to determine, compare and approximate real roots of univariate polynomials and bivariate polynomial systems. Such a black-box is called an *Algebraic %Kernel*. So far the package only provides models for the univariate kernel. Nevertheless, it already defines concepts for the bivariate kernel, since this settles the interface for upcoming implementations.} -\cgalPkgManuals{Chapter_Algebraic_Kernel,PkgAlgebraicKerneld} +\cgalPkgManuals{Chapter_Algebraic_Kernel,PkgAlgebraicKernelDRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.6} diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h index fd3f480a7fb..cf655264ac4 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShape2 +\ingroup PkgAlphaShapes2Ref The class `Alpha_shape_2` represents the family of \f$ \alpha\f$-shapes of points in a plane for all positive diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h index b6a5a330ae5..7b94e488aeb 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShape2 +\ingroup PkgAlphaShapes2Ref The class `Alpha_shape_face_base_2` is the default model for the concept `AlphaShapeFace_2`. diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h index f20b2dfe563..755c8af5fb4 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShape2 +\ingroup PkgAlphaShapes2Ref The class `Alpha_shape_vertex_base_2` is the default model for the concept `AlphaShapeVertex_2`. diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h index 93852d99a12..b182ba9e388 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Weighted_alpha_shape_euclidean_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShape2 +\ingroup PkgAlphaShapes2Ref \deprecated The class is deprecated since \cgal 4.10, as the weighted point and the function objects for weighted points are part of the concept `Kernel`. The class is kept for backward diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h index 4edbc836b4f..330f343719b 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlphaShape2Concepts +\ingroup PkgAlphaShapes2Concepts \cgalConcept The concept `AlphaShapeFace_2` describes the requirements for the base face of an alpha shape. diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h index bcac27ecb44..be6e2389a11 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlphaShape2Concepts +\ingroup PkgAlphaShapes2Concepts \cgalConcept The concept `AlphaShapeTraits_2` describes the requirements for the geometric traits diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h index e0224242fc9..a9287eb5aff 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlphaShape2Concepts +\ingroup PkgAlphaShapes2Concepts \cgalConcept The concept `AlphaShapeVertex_2` describes the requirements for the base vertex of an alpha shape. diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/WeightedAlphaShapeTraits_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/WeightedAlphaShapeTraits_2.h index b39e85a728f..09c7597b39b 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/WeightedAlphaShapeTraits_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/WeightedAlphaShapeTraits_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgAlphaShape2Concepts +\ingroup PkgAlphaShapes2Concepts \cgalConcept The concept `WeightedAlphaShapeTraits_2` describes the requirements diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt b/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt index 89f592fe677..1f982595424 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/PackageDescription.txt @@ -1,20 +1,20 @@ -/// \defgroup PkgAlphaShape2 2D Alpha Shapes Reference -/// \defgroup PkgAlphaShape2Concepts Concepts -/// \ingroup PkgAlphaShape2 +/// \defgroup PkgAlphaShapes2Ref 2D Alpha Shapes Reference +/// \defgroup PkgAlphaShapes2Concepts Concepts +/// \ingroup PkgAlphaShapes2Ref /*! -\addtogroup PkgAlphaShape2 +\addtogroup PkgAlphaShapes2Ref -\cgalPkgDescriptionBegin{2D Alpha Shapes,PkgAlphaShape2Summary} +\cgalPkgDescriptionBegin{2D Alpha Shapes,PkgAlphaShapes2} \cgalPkgPicture{alpha-detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Tran Kai Frank Da} \cgalPkgDesc{This package offers a data structure encoding the whole family of alpha-complexes related to a given 2D Delaunay or regular triangulation. In particular, the data structure allows to retrieve the alpha-complex for any alpha value, the whole spectrum of critical alpha values and a filtration on the triangulation faces (this filtration is based on the first alpha value for which each face is included on the alpha-complex).} -\cgalPkgManuals{Chapter_2D_Alpha_Shapes,PkgAlphaShape2} +\cgalPkgManuals{Chapter_2D_Alpha_Shapes,PkgAlphaShapes2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.1} -\cgalPkgDependsOn{\ref PkgTriangulation2Summary} +\cgalPkgDependsOn{\ref PkgTriangulation2} \cgalPkgBib{cgal:d-as2} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{2D Alpha Shapes,alpha_shapes_2.zip} diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h index 52f081ba007..e1e14111ed0 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Alpha_shape_3` represents the family of alpha shapes of points in the 3D space for all real diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h index f733d1a9a8c..b57d44fe618 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Alpha_shape_cell_base_3` is the default model for the concept `AlphaShapeCell_3`. @@ -37,7 +37,7 @@ public: namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Alpha_status` is a small data structure to store the critical alpha values of faces of an alpha shape. diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h index 48a900c3234..146a941e218 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Alpha_shape_vertex_base_3` is the default model for the concept `AlphaShapeVertex_3`. diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h index 71b7394b4ef..d7bad466690 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Fixed_alpha_shape_3` represents one (fixed) alpha shape of points in the 3D space for a real diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h index 776e787b20c..ab50625bfd5 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Fixed_alpha_shape_cell_base_3` is the default model for the concept `FixedAlphaShapeCell_3`. diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h index d512a99e4a0..5c132505980 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgAlphaShapes3 +\ingroup PkgAlphaShapes3Ref The class `Fixed_alpha_shape_vertex_base_3` is the default model for the concept `FixedAlphaShapeVertex_3`. diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt b/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt index 279faf91035..cd6d40f3d30 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/PackageDescription.txt @@ -1,18 +1,18 @@ -/// \defgroup PkgAlphaShapes3 3D Alpha Shapes Reference +/// \defgroup PkgAlphaShapes3Ref 3D Alpha Shapes Reference /// \defgroup PkgAlphaShapes3Concepts Concepts -/// \ingroup PkgAlphaShapes3 +/// \ingroup PkgAlphaShapes3Ref /*! -\addtogroup PkgAlphaShapes3 -\cgalPkgDescriptionBegin{3D Alpha Shapes,PkgAlphaShapes3Summary} +\addtogroup PkgAlphaShapes3Ref +\cgalPkgDescriptionBegin{3D Alpha Shapes,PkgAlphaShapes3} \cgalPkgPicture{alpha_shapes_3_small.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Tran Kai Frank Da, Sébastien Loriot, and Mariette Yvinec} \cgalPkgDesc{This package offers a data structure encoding either one alpha-complex or the whole family of alpha-complexes related to a given 3D Delaunay or regular triangulation. In the latter case, the data structure allows to retrieve the alpha-complex for any alpha value, the whole spectrum of critical alpha values and a filtration on the triangulation faces (this filtration is based on the first alpha value for which each face is included on the alpha-complex). } -\cgalPkgManuals{Chapter_3D_Alpha_Shapes,PkgAlphaShapes3} +\cgalPkgManuals{Chapter_3D_Alpha_Shapes,PkgAlphaShapes3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.3} -\cgalPkgDependsOn{\ref PkgTriangulation3Summary} +\cgalPkgDependsOn{\ref PkgTriangulation3} \cgalPkgBib{cgal:dy-as3} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{3D Alpha Shapes,alpha_shape_3.zip} diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h index 27bb8401c69..6716e9095da 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_graph_2` represents the Apollonius graph. It supports insertions and deletions of sites. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h index 8f972d24d33..a1b4a8003d5 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_graph_filtered_traits_2` provides a model for the `ApolloniusGraphTraits_2` concept. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h index 863167f6e3b..6456ef59549 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref We provide an alternative to the class `Apollonius_graph_2` for the dynamic diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h index d04be3c9250..5dd5bf06793 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_graph_hierarchy_vertex_base_2` provides a model for the `ApolloniusGraphHierarchyVertexBase_2` concept, which is the diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h index bdd1cc2b503..6f3d11a7517 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_graph_traits_2` provides a model for the `ApolloniusGraphTraits_2` concept. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h index a1ab5ac7b74..c86d80b0b1a 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_graph_vertex_base_2` provides a model for the `ApolloniusGraphVertexBase_2` concept which is the vertex base diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h index fe4ddc0de0d..a77be4d6fe1 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgApolloniusGraph2 +\ingroup PkgApolloniusGraph2Ref The class `Apollonius_site_2` is a model for the concept `ApolloniusSite_2`. It is parametrized by a template parameter diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt b/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt index a8b8e8c267c..c35cbc53915 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/PackageDescription.txt @@ -1,19 +1,19 @@ -/// \defgroup PkgApolloniusGraph2 2D Apollonius Graphs (Delaunay Graphs of Disks) Reference +/// \defgroup PkgApolloniusGraph2Ref 2D Apollonius Graphs (Delaunay Graphs of Disks) Reference /// \defgroup PkgApolloniusGraph2Concepts Concepts -/// \ingroup PkgApolloniusGraph2 +/// \ingroup PkgApolloniusGraph2Ref /*! -\addtogroup PkgApolloniusGraph2 +\addtogroup PkgApolloniusGraph2Ref \todo check generated documentation -\cgalPkgDescriptionBegin{2D Apollonius Graphs (Delaunay Graphs of Disks),PkgApolloniusGraph2Summary} +\cgalPkgDescriptionBegin{2D Apollonius Graphs (Delaunay Graphs of Disks),PkgApolloniusGraph2} \cgalPkgPicture{CircleVoronoi.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Menelaos Karavelas and Mariette Yvinec} \cgalPkgDesc{Algorithms for computing the Apollonius graph in two dimensions. The Apollonius graph is the dual of the Apollonius diagram, also known as the additively weighted Voronoi diagram. The latter can be thought of as the Voronoi diagram of a set of disks under the Euclidean metric, and it is a generalization of the standard Voronoi diagram for points. The algorithms provided are dynamic.} -\cgalPkgManuals{Chapter_2D_Apollonius_Graphs,PkgApolloniusGraph2} +\cgalPkgManuals{Chapter_2D_Apollonius_Graphs,PkgApolloniusGraph2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.0} -\cgalPkgDependsOn{\ref PkgTDS2Summary} +\cgalPkgDependsOn{\ref PkgTDS2} \cgalPkgBib{cgal:ky-ag2} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{2D Apollonius Graph,apollonius_graph_2.zip} diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h index a98df8df253..cc347e4ecc1 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses The traits class `Arr_Bezier_curve_traits_2` is a model of the `ArrangementTraits_2` concept that handles planar Bézier curves. A planar Bézier curve @@ -85,7 +85,7 @@ typedef unspecified_type Algebraic; The `Curve_2` class nested within the Bézier traits class is used to represent a Bézier curve of arbitrary degree, which is defined by a sequence of rational control points. In addition to the methods listed -below, the I/O operators \link PkgArrangement2op_left_shift `operator<<` \endlink and \link PkgArrangement2op_right_shift `operator>>` \endlink for +below, the I/O operators \link PkgArrangementOnSurface2op_left_shift `operator<<` \endlink and \link PkgArrangementOnSurface2op_right_shift `operator>>` \endlink for standard output-streams are also supported. The copy constructor and assignment operator are supported as well. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h index 68be885d043..29d6417b375 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2 +\ingroup PkgArrangementOnSurface2Ref \anchor arr_refarr_access diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h index 125252aebcc..0b7f00df91a 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses The traits class `Arr_algebraic_segment_traits_2` is a model of the `ArrangementTraits_2` concept that handles planar algebraic curves of arbitrary degree, diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_batched_point_location.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_batched_point_location.h index 858b8f69486..2609eae0af3 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_batched_point_location.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_batched_point_location.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2PointLocation +\ingroup PkgArrangementOnSurface2PointLocation Performs a batched point-location operation on a given arrangement. It accepts a range of query points, and locates each diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h index 886655a04b1..f375029fbca 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses The class `Arr_circle_segment_traits_2` is a model of the `ArrangementTraits_2` concept and can be used to construct and maintain arrangements of circular arcs diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_arc_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_arc_traits_2.h index 75378bab3bf..d09dacf22b0 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_arc_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_arc_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses This class is a traits class for \cgal arrangements, built on top of a model of concept `CircularKernel`. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_line_arc_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_line_arc_traits_2.h index 417304ca2b0..6230d15e4c7 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_line_arc_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_line_arc_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses This class is a traits class for \cgal arrangements, built on top of a model of concept `CircularKernel`. It provides curves that can be diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h index 92ba50dbb41..28803e7f8d5 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses The class `Arr_conic_traits_2` is a model of the `ArrangementTraits_2` concept and can be used to construct and maintain arrangements of bounded segments of diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h index 4c939f85c5d..ab71d28ecc9 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses The class `Arr_consolidated_curve_data_traits_2` is a model of the concept `ArrangementTraits_2`, and serves as a decorator class that enables the extension of the curve diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h index 8199dd7d2de..eb94a838578 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses The class `Arr_curve_data_traits_2` is a model of the `ArrangementTraits_2` concept and serves as a decorator class that allows the extension of the curves diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_dcel_base.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_dcel_base.h index a95d96de7e2..da8b6d0e672 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_dcel_base.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_dcel_base.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2DCEL +\ingroup PkgArrangementOnSurface2DCEL \anchor arr_refarr_dcel_base diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_dcel.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_dcel.h index 7de13a1b9f4..937f9961de5 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_dcel.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_dcel.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2DCEL +\ingroup PkgArrangementOnSurface2DCEL The default Dcel class used by the `Arrangement_2` class-template is parameterized by a traits class, which is a model of the diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_overlay_traits.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_overlay_traits.h index 3f1dbdcddd2..e18a545236c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_overlay_traits.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_overlay_traits.h @@ -2,8 +2,8 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses -\ingroup PkgArrangement2Overlay +\ingroup PkgArrangementOnSurface2TraitsClasses +\ingroup PkgArrangementOnSurface2Overlay An instance of `Arr_default_overlay_traits` should be used for overlaying two arrangements of type `Arrangement` that store no auxiliary data with their Dcel records, where the resulting overlaid arrangement stores no auxiliary @@ -27,8 +27,8 @@ public: namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses -\ingroup PkgArrangement2Overlay +\ingroup PkgArrangementOnSurface2TraitsClasses +\ingroup PkgArrangementOnSurface2Overlay An instance of `Arr_face_overlay_traits` should be used for overlaying two arrangements of types `Arr_A` and `Arr_B`, which are instantiated using the same diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_enums.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_enums.h index d7f2b535dc4..21fd0d44af6 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_enums.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_enums.h @@ -1,7 +1,7 @@ namespace CGAL { /*! - \ingroup PkgArrangement2Enums + \ingroup PkgArrangementOnSurface2Enums The enumeration `Arr_curve_end` is used to indicate one of the two ends of an \f$ x\f$-monotone curve. It is used by models of the `ArrangementOpenBoundaryTraits_2` concept. @@ -11,7 +11,7 @@ namespace CGAL { enum Arr_curve_end { ARR_MIN_END, ARR_MAX_END }; /*! - \ingroup PkgArrangement2Enums + \ingroup PkgArrangementOnSurface2Enums The enumeration `Arr_halfedge_direction` is defined by `CGAL::Arrangement_2::Halfedge` to specify @@ -22,32 +22,32 @@ enum Arr_curve_end { ARR_MIN_END, ARR_MAX_END }; enum Arr_halfedge_direction { ARR_LEFT_TO_RIGHT, ARR_RIGHT_TO_LEFT }; /*! - \ingroup PkgArrangement2Enums + \ingroup PkgArrangementOnSurface2Enums */ typedef Box_parameter_space_2 Arr_parameter_space; /*! - \ingroup PkgArrangement2Enums + \ingroup PkgArrangementOnSurface2Enums */ const Arr_parameter_space ARR_LEFT_BOUNDARY = LEFT_BOUNDARY; /*! - \ingroup PkgArrangement2Enums + \ingroup PkgArrangementOnSurface2Enums */ const Arr_parameter_space ARR_RIGHT_BOUNDARY = RIGHT_BOUNDARY; /*! - \ingroup PkgArrangement2Enums + \ingroup PkgArrangementOnSurface2Enums */ const Arr_parameter_space ARR_BOTTOM_BOUNDARY = BOTTOM_BOUNDARY; /*! - \ingroup PkgArrangement2Enums + \ingroup PkgArrangementOnSurface2Enums */ const Arr_parameter_space ARR_TOP_BOUNDARY = TOP_BOUNDARY; /*! - \ingroup PkgArrangement2Enums + \ingroup PkgArrangementOnSurface2Enums */ const Arr_parameter_space ARR_INTERIOR = INTERIOR; diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h index 6fb986d3c09..8a948545117 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2DCEL +\ingroup PkgArrangementOnSurface2DCEL The `Arr_extended_dcel` class-template extends the topological-features of the Dcel namely the vertex, halfedge, and face types. While it is possible to maintain @@ -51,7 +51,7 @@ class Arr_extended_dcel namespace CGAL { /*! -\ingroup PkgArrangement2DCEL +\ingroup PkgArrangementOnSurface2DCEL The `Arr_extended_face` class-template extends the face topological-features of the Dcel. It is parameterized by a face base-type `FaceBase` and a data type @@ -103,7 +103,7 @@ void set_data (const FData & data); namespace CGAL { /*! -\ingroup PkgArrangement2DCEL +\ingroup PkgArrangementOnSurface2DCEL The `Arr_extended_halfedge` class-template extends the halfedge topological-features of the Dcel. It is parameterized by a halfedge base-type `HalfedgeBase` @@ -155,7 +155,7 @@ void set_data (const HData & data); namespace CGAL { /*! -\ingroup PkgArrangement2DCEL +\ingroup PkgArrangementOnSurface2DCEL The `Arr_extended_vertex` class-template extends the vertex topological-features of the Dcel. It is parameterized by a @@ -208,7 +208,7 @@ void set_data (const VData & data); namespace CGAL { /*! -\ingroup PkgArrangement2DCEL +\ingroup PkgArrangementOnSurface2DCEL The `Arr_face_extended_dcel` class-template extends the Dcel face-records, making it possible to store extra (non-geometric) data with the arrangement faces. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h index c816ecd0a52..cf9c1573702 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2 +\ingroup PkgArrangementOnSurface2Ref `Arr_face_index_map` maintains a mapping of face handles of an attached arrangement object to indices (of type `unsigned int`). diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_landmarks_point_location.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_landmarks_point_location.h index e97890e2da3..95c33d975ab 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_landmarks_point_location.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_landmarks_point_location.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2PointLocation +\ingroup PkgArrangementOnSurface2PointLocation \anchor arr_reflm_pl diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_line_arc_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_line_arc_traits_2.h index 9bab6950c32..8dbf2b4fac5 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_line_arc_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_line_arc_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses This class is a traits class for \cgal arrangements, built on top of a model of concept `CircularKernel`. It provides curves of type diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h index b996a3cd03b..4b6227ec31b 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! - \ingroup PkgArrangement2TraitsClasses + \ingroup PkgArrangementOnSurface2TraitsClasses The traits class `Arr_linear_traits_2` is a model of the `ArrangementTraits_2` concept, which enables the construction and maintenance of arrangements of @@ -35,7 +35,7 @@ public: The `Curve_2` (and the `X_monotone_curve_2`) class nested within the linear-traits can represent all types of linear objects. The class supports the copy and default constructor and the assignment operator. - In addition, the \link PkgArrangement2op_left_shift `operator<<` \endlink and \link PkgArrangement2op_right_shift `operator>>` \endlink for linear objects + In addition, the \link PkgArrangementOnSurface2op_left_shift `operator<<` \endlink and \link PkgArrangementOnSurface2op_right_shift `operator>>` \endlink for linear objects are defined for standard output and input streams. */ class Curve_2 { diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_naive_point_location.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_naive_point_location.h index 490b967a9ca..4cb06ddf4a6 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_naive_point_location.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_naive_point_location.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2PointLocation +\ingroup PkgArrangementOnSurface2PointLocation \anchor arr_refnaive_pl diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_basic_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_basic_traits_2.h index 2e46a442dcd..64dc43330f2 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_basic_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_basic_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses The traits class `Arr_non_caching_segment_basic_traits_2` is a model of the `ArrangementTraits_2` concept that allow the construction and maintenance of arrangements of diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h index 8fee24bbcf7..2262120d70c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses The traits class `Arr_non_caching_segment_traits_2` is a model of the `ArrangementTraits_2` concept that allows the construction and maintenance of arrangements of diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h index 20c9cfbecb7..cc860dbf95b 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2 +\ingroup PkgArrangementOnSurface2Ref \anchor arr_refarr_obs diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_overlay_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_overlay_2.h index 540867ed058..80c4a062c1c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_overlay_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_overlay_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2Funcs +\ingroup PkgArrangementOnSurface2Funcs \brief Computes the overlay of two arrangements `arr1` and `arr2`, and sets the output arrangement `res` to represent the overlaid arrangement. @@ -35,7 +35,7 @@ void overlay (const Arrangement_2& arr1, OverlayTraits& ovl_tr); /*! -\ingroup PkgArrangement2Funcs +\ingroup PkgArrangementOnSurface2Funcs \brief Computes the overlay of two arrangements with history `arr1` and `arr2`, and sets the output arrangement with history `res` to represent the overlaid arrangement. The function also constructs a diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_point_location_result.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_point_location_result.h index 4990a399fa3..20a6787d7e5 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_point_location_result.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_point_location_result.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgArrangement2PointLocation +\ingroup PkgArrangementOnSurface2PointLocation The macro `CGAL_ARR_POINT_LOCATION_VERSION` can be used to configure the point-location query API. In particular, it determines which version @@ -24,7 +24,7 @@ is included. namespace CGAL { /*! -\ingroup PkgArrangement2PointLocation +\ingroup PkgArrangementOnSurface2PointLocation A unary metafunction to determine the return type of a point-location or vertical ray-shoot query. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polycurve_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polycurve_traits_2.h index 5fb8b3fb479..f53f8db1978 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polycurve_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polycurve_traits_2.h @@ -1,4 +1,4 @@ -/// \ingroup PkgArrangement2Macros +/// \ingroup PkgArrangementOnSurface2Macros /// @{ /*! * If the macro is set to one, then \f$x\f$-monotone curves are always @@ -8,7 +8,7 @@ /// @} namespace CGAL { - /*! \ingroup PkgArrangement2TraitsClasses + /*! \ingroup PkgArrangementOnSurface2TraitsClasses * * Note: The `SubcurveTraits_2` can comprise of Line_segments, Conic_arcs, * Circular_arc, Bezier_curves, or Linear_curves. A portion or a part @@ -280,9 +280,9 @@ namespace CGAL { * * The copy and default constructor as well as the assignment operator are * provided for polycurve subcurves. In addition, an \link - * PkgArrangement2op_left_shift `operator<<` \endlink for the subcurves is + * PkgArrangementOnSurface2op_left_shift `operator<<` \endlink for the subcurves is * defined for standard output streams, and an \link - * PkgArrangement2op_right_shift `operator>>` \endlink for the subcurves is + * PkgArrangementOnSurface2op_right_shift `operator>>` \endlink for the subcurves is * defined for standard input streams. */ template diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h index c4d3e697598..02116bc74e8 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h @@ -1,4 +1,4 @@ -/// \ingroup PkgArrangement2Macros +/// \ingroup PkgArrangementOnSurface2Macros /// @{ /*! * If the macro is set to one, then \f$x\f$-monotone curves are always @@ -8,7 +8,7 @@ /// @} namespace CGAL { - /*! \ingroup PkgArrangement2TraitsClasses + /*! \ingroup PkgArrangementOnSurface2TraitsClasses * * The traits class `Arr_polyline_traits_2` handles piecewise linear * curves, commonly referred to as polylines. Each polyline is a diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h index db330187157..5979b9b07c0 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! - \ingroup PkgArrangement2TraitsClasses + \ingroup PkgArrangementOnSurface2TraitsClasses The traits class `Arr_rational_function_traits_2` is a model of the `ArrangementTraits_2` concept. It handles bounded and unbounded arcs of rational functions, diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_segment_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_segment_traits_2.h index ca23407fcb3..f085e4da39c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_segment_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_segment_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2TraitsClasses +\ingroup PkgArrangementOnSurface2TraitsClasses The traits class `Arr_segment_traits_2` is a model of the `ArrangementTraits_2` concept, which allows the construction and maintenance of arrangements of diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_tags.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_tags.h index a70bc00be76..302a0fc6109 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_tags.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_tags.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2Tags +\ingroup PkgArrangementOnSurface2Tags The categories `Left_side_category`, `Right_side_category`, `Bottom_side_category`, and `Top_side_category`, @@ -26,7 +26,7 @@ struct Arr_oblivious_side_tag { namespace CGAL { /*! -\ingroup PkgArrangement2Tags +\ingroup PkgArrangementOnSurface2Tags All the four types `Left_side_category`, `Right_side_category`, `Bottom_side_category`, diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h index d80fdf954fe..1e018c044df 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2PointLocation +\ingroup PkgArrangementOnSurface2PointLocation \anchor arr_reftrap_pl diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h index c00dd12499a..0320001321b 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2 +\ingroup PkgArrangementOnSurface2Ref `Arr_vertex_index_map` maintains a mapping of vertex handles of an attached arrangement object to indices (of type `unsigned int`). diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertical_decomposition_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertical_decomposition_2.h index e9fa5a62091..e0f4dbb918c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertical_decomposition_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertical_decomposition_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2Funcs +\ingroup PkgArrangementOnSurface2Funcs Produces the symbolic vertical decomposition of a given arrangement, performing a batched vertical ray-shooting query from diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_walk_along_line_point_location.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_walk_along_line_point_location.h index 4037b4030ec..7add7e4718f 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_walk_along_line_point_location.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_walk_along_line_point_location.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2PointLocation +\ingroup PkgArrangementOnSurface2PointLocation \anchor arr_refwalk_pl diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h index 277ddf71eca..11e3bdf9159 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! - \ingroup PkgArrangement2 + \ingroup PkgArrangementOnSurface2Ref \anchor arr_refarr @@ -36,7 +36,7 @@ namespace CGAL { Insertion Functions - \sa `PkgArrangement2Insert` + \sa `PkgArrangementOnSurface2Insert` \sa `CGAL::insert_non_intersecting_curve()` \sa `CGAL::insert_non_intersecting_curves()` \sa `CGAL::insert_point()` @@ -48,8 +48,8 @@ namespace CGAL { Input/output functions - \sa `PkgArrangement2Read` - \sa `PkgArrangement2Write` + \sa `PkgArrangementOnSurface2Read` + \sa `PkgArrangementOnSurface2Write` */ template< typename Traits, typename Dcel > @@ -91,7 +91,7 @@ public: typedef typename Dcel::Size Size; /*! - \ingroup PkgArrangement2DCEL + \ingroup PkgArrangementOnSurface2DCEL An object \f$ v\f$ of the class `Vertex` represents an arrangement vertex, that is - a \f$ 0\f$-dimensional cell, associated with a point on the plane. */ @@ -168,7 +168,7 @@ public: }; /* end Vertex */ /*! - \ingroup PkgArrangement2DCEL + \ingroup PkgArrangementOnSurface2DCEL An object \f$ e\f$ of the class `Halfedge` represents a halfedge in the arrangement. A halfedge is directed from its source vertex to its target vertex, and has an incident face lying to @@ -263,7 +263,7 @@ public: }; /* end Halfedge */ /*! - \ingroup PkgArrangement2DCEL + \ingroup PkgArrangementOnSurface2DCEL An object of the class `Face` represents an arrangement face, namely, a \f$ 2\f$-dimensional arrangement cell. An arrangement that supports @@ -994,7 +994,7 @@ edge, we first need to cast away its "constness". namespace CGAL { /*! - \ingroup PkgArrangement2Insert insert + \ingroup PkgArrangementOnSurface2Insert insert The function `%insert` inserts one or more curves or \f$ x\f$-monotone curves into a given arrangement, where no restrictions are imposed on the inserted curves. If an inserted curve is not \f$ x\f$-monotone curve, it is subdivided @@ -1065,7 +1065,7 @@ void insert (Arrangement_2& arr, /// @} /*! - \ingroup PkgArrangement2Funcs + \ingroup PkgArrangementOnSurface2Funcs Checks if a given curve or \f$ x\f$-monotone curve intersects an existing arrangement's edges or vertices. @@ -1111,7 +1111,7 @@ bool do_intersect ( /*! - \ingroup PkgArrangement2Funcs + \ingroup PkgArrangementOnSurface2Funcs Inserts a given \f$ x\f$-monotone curve into a given arrangement, where the interior of the given curve is disjoint from all @@ -1149,7 +1149,7 @@ insert_non_intersecting_curve (Arrangement_2& arr, /*! - \ingroup PkgArrangement2Funcs + \ingroup PkgArrangementOnSurface2Funcs Inserts a set of \f$ x\f$-monotone curves in a given range into a given arrangement. The insertion is performed in an aggregated @@ -1172,7 +1172,7 @@ void insert_non_intersecting_curves(Arrangement_2& arr, /*! - \ingroup PkgArrangement2Funcs + \ingroup PkgArrangementOnSurface2Funcs Inserts a given point into a given arrangement. It uses a given point-location object to locate the given @@ -1210,7 +1210,7 @@ insert_point (Arrangement_2& arr, /*! - \ingroup PkgArrangement2Funcs + \ingroup PkgArrangementOnSurface2Funcs Checks the validity of a given arrangement. @@ -1234,7 +1234,7 @@ bool is_valid (const Arrangement_2& arr); /*! - \ingroup PkgArrangement2Funcs + \ingroup PkgArrangementOnSurface2Funcs Removes an edge given by one of the twin halfedges that forms it, from a given arrangement. Once the edge is removed, if the @@ -1266,7 +1266,7 @@ remove_edge (Arrangement_2& arr, /*! - \ingroup PkgArrangement2Funcs + \ingroup PkgArrangementOnSurface2Funcs Attempts to removed a given vertex from a given arrangement. The vertex can be removed if it is either an isolated vertex, @@ -1291,7 +1291,7 @@ bool remove_vertex (Arrangement_2& arr, typename Arrangement_2::Vertex_handle v); /*! - \ingroup PkgArrangement2Funcs + \ingroup PkgArrangementOnSurface2Funcs Compute the zone of the given \f$ x\f$-monotone curve in the existing arrangement. Meaning, it output the diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h index 7afef234acc..7c05c5c9ddc 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2 +\ingroup PkgArrangementOnSurface2Ref \anchor arr_refarr_with_hist @@ -274,7 +274,7 @@ bool remove_target = true); }; /* end Arrangement_with_history_2 */ /*! -\ingroup PkgArrangement2Insert +\ingroup PkgArrangementOnSurface2Insert Inserts the given curve `c` into the arrangement with history `arr`, and returns a handle to the inserted curve. `c` is subdivided into @@ -297,7 +297,7 @@ insert (Arrangement_with_history_2& arr, const PointLocation& pl = walk_pl); /*! -\ingroup PkgArrangement2Insert +\ingroup PkgArrangementOnSurface2Insert Aggregately inserts the curves in the range `[first,last)` into the arrangement with history `arr` using the sweep-line framework. @@ -308,7 +308,7 @@ void insert(Arrangement_with_history_2& arr, /*! -\ingroup PkgArrangement2Funcs +\ingroup PkgArrangementOnSurface2Funcs Removes a given curve from a given arrangement. @@ -323,7 +323,7 @@ Size remove_curve (Arrangement_with_history_2& arr, /*! -\addtogroup PkgArrangement2Overlay +\addtogroup PkgArrangementOnSurface2Overlay Computes the overlay of two arrangements with history `arr1` and `arr2`, and sets the output arrangement with history `res` to @@ -340,7 +340,7 @@ void overlay (const Arrangement_with_history_2& arr1, /*! -\addtogroup PkgArrangement2Overlay +\addtogroup PkgArrangementOnSurface2Overlay Computes the (simple) overlay of two arrangements with history `arr1` and `arr2`, and sets the output arrangement with history `res` to diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_iostream.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_iostream.h index 672245e5d6c..413b1cd5c3f 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_iostream.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_iostream.h @@ -1,7 +1,7 @@ namespace CGAL { /*! - \defgroup PkgArrangement2Read CGAL::read() - \ingroup PkgArrangement2IO + \defgroup PkgArrangementOnSurface2Read CGAL::read() + \ingroup PkgArrangementOnSurface2IO Reads a given arrangement from a given input stream using a specific input format. @@ -16,11 +16,11 @@ using a specific input format. -\sa `PkgArrangement2Write` +\sa `PkgArrangementOnSurface2Write` -\sa `PkgArrangement2op_left_shift` -\sa `PkgArrangement2op_right_shift` +\sa `PkgArrangementOnSurface2op_left_shift` +\sa `PkgArrangementOnSurface2op_right_shift` */ /// @{ @@ -37,8 +37,8 @@ std::istream& read (Arrangement_2& arr, /// @} /*! - \defgroup PkgArrangement2Write CGAL::write() - \ingroup PkgArrangement2IO + \defgroup PkgArrangementOnSurface2Write CGAL::write() + \ingroup PkgArrangementOnSurface2IO Writes a given arrangement into a given output stream using a specific output format. @@ -52,9 +52,9 @@ using a specific output format. `ArrangementWithHistoryOutputFormatter` concept. -\sa `PkgArrangement2Read` -\sa `PkgArrangement2op_left_shift` -\sa `PkgArrangement2op_right_shift` +\sa `PkgArrangementOnSurface2Read` +\sa `PkgArrangementOnSurface2op_left_shift` +\sa `PkgArrangementOnSurface2op_right_shift` */ /// @{ @@ -70,7 +70,7 @@ std::ostream& write (const Arrangement_2& arr, /// @} /*! -\ingroup PkgArrangement2op_left_shift +\ingroup PkgArrangementOnSurface2op_left_shift Inserts the arrangement object `arr` into the output stream `os` using the output format defined by the `Arr_text_formatter` class. Only the basic geometric and @@ -83,7 +83,7 @@ std::ostream& operator<< (std::ostream& os, /*! -\ingroup PkgArrangement2op_right_shift +\ingroup PkgArrangementOnSurface2op_right_shift Extracts an arrangement from a given input stream using the input format defined by the `Arr_text_formatter` class - that is, only the basic geometric and topological features of the arrangement are read diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h index d3dadb9330d..28dd3ecb888 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2IO +\ingroup PkgArrangementOnSurface2IO `Arr_extended_dcel_text_formatter` defines the format of an arrangement in an input or output stream (typically a file stream), thus enabling reading and writing an `Arrangement` @@ -21,8 +21,8 @@ the `<<` operator and read from an input stream using the `>>` operator. \cgalModels `ArrangementInputFormatter` \cgalModels `ArrangementOutputFormatter` -\sa `PkgArrangement2Read` -\sa `PkgArrangement2Write` +\sa `PkgArrangementOnSurface2Read` +\sa `PkgArrangementOnSurface2Write` \sa `Arr_extended_dcel` */ @@ -38,7 +38,7 @@ public: namespace CGAL { /*! -\ingroup PkgArrangement2IO +\ingroup PkgArrangementOnSurface2IO `Arr_face_extended_text_formatter` defines the format of an arrangement in an input or output stream (typically a file stream), thus enabling reading and writing an `Arrangement` @@ -55,8 +55,8 @@ can all be written to an input stream using the `<<` operator and read from an i \cgalModels `ArrangementInputFormatter` \cgalModels `ArrangementOutputFormatter` -\sa `PkgArrangement2Read` -\sa `PkgArrangement2Write` +\sa `PkgArrangementOnSurface2Read` +\sa `PkgArrangementOnSurface2Write` \sa `Arr_face_extended_dcel` */ @@ -72,7 +72,7 @@ public: namespace CGAL { /*! -\ingroup PkgArrangement2IO +\ingroup PkgArrangementOnSurface2IO `Arr_text_formatter` defines the format of an arrangement in an input or output stream (typically a file stream), thus enabling reading and writing an `Arrangement` @@ -88,8 +88,8 @@ operator. \cgalModels `ArrangementInputFormatter` \cgalModels `ArrangementOutputFormatter` -\sa `PkgArrangement2Read` -\sa `PkgArrangement2Write` +\sa `PkgArrangementOnSurface2Read` +\sa `PkgArrangementOnSurface2Write` */ template< typename Arrangement > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_iostream.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_iostream.h index 9732ee484c9..4f6deac2550 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_iostream.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_iostream.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2Read +\ingroup PkgArrangementOnSurface2Read Reads the arrangement-with-history object `arr` from the given input stream `is` using a specific input format defined by @@ -15,7 +15,7 @@ std::istream& read (Arrangement_with_history_2& arr, WithHistoryFormatter& formatter); /*! -\ingroup PkgArrangement2Write +\ingroup PkgArrangementOnSurface2Write Writes the arrangement-with-history object `arr` into the given output stream `os` using a specific output format defined by `formatter`. @@ -27,7 +27,7 @@ std::ostream& write (const Arrangement_with_history_2& arr, WithHistoryFormatter& formatter); /*! -\ingroup PkgArrangement2op_left_shift +\ingroup PkgArrangementOnSurface2op_left_shift Inserts the arrangement-with-history object `arr` into the output stream `os` using the output format defined by the `Arr_with_history_text_formatter` class. Only the basic geometric @@ -39,7 +39,7 @@ std::ostream& operator<< (std::ostream& os, const Arrangement_with_history_2& arr); /*! -\ingroup PkgArrangement2op_right_shift +\ingroup PkgArrangementOnSurface2op_right_shift Extracts an arrangement-with-history from a given input stream using the default input format. */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h index 3af4fa40bd9..8d6bef1eb55 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgArrangement2IO +\ingroup PkgArrangementOnSurface2IO `Arr_with_history_text_formatter` defines the format of an arrangement in an input or output stream (typically a file stream), thus enabling reading and writing an @@ -18,8 +18,8 @@ relations between these curves and the edges they induce. \cgalModels `ArrangementWithHistoryInputFormatter` \cgalModels `ArrangementWithHistoryOutputFormatter` -\sa `PkgArrangement2Read` -\sa `PkgArrangement2Write` +\sa `PkgArrangementOnSurface2Read` +\sa `PkgArrangementOnSurface2Write` */ template< typename ArrFormatter > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h index 99a57c2cf9b..febcd691b52 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines Functor diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h index 64a975b195a..4cc4209c9ee 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines Functor diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h index b5c727aee88..f0ee218e830 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableFunctor diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h index e3c56fbeadb..d31605b4134 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableTernaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h index 1cf927c57c5..42b5df88346 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableBinaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h index bd348bc85fb..cd8d99eb7b1 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableBinaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h index 5d06d07c143..345a6ca3321 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableTernaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h index fb3d4fa9596..07f072fc259 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableTernaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h index a2cb53b38ef..408e62f4a96 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableBinaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h index dd7f31a06c7..cea0b16d712 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableTernaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h index b145d3c9163..629396f9563 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableUnaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h index caef26fe71e..7bd2ddee785 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableUnaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h index 0c0597fd01a..0ba63096c36 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines Functor diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Curve_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Curve_2.h index 8681b27b9a9..5677896e1d9 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Curve_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Curve_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsGeometricObjects +\ingroup PkgArrangementOnSurface2ConceptsGeometricObjects \cgalConcept represents a general planar curve. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h index dcdcda5577e..6c3362ddc53 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableBinaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h index f97f43d645b..0c73d061273 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines Functor diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h index 84ffa9194af..31f0655630e 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableUnaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h index 24b8fb60472..508d65ba14e 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines Functor diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h index a48b8132e17..88ad38a680d 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines Functor diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h index 58934f055f2..6655ac19aab 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableBinaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h index 71343fe93b3..f80e3738499 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines AdaptableBinaryFunction diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Point_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Point_2.h index 3e443059d80..1da395e23fa 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Point_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Point_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsGeometricObjects +\ingroup PkgArrangementOnSurface2ConceptsGeometricObjects \cgalConcept Represents a point in the plane. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h index 50e6850ca7a..f6ba2f33ce7 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsFunctionObjects +\ingroup PkgArrangementOnSurface2ConceptsFunctionObjects \cgalConcept \cgalRefines Functor diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--XMonotoneCurve_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--XMonotoneCurve_2.h index 78f421f2761..c2d1919c061 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--XMonotoneCurve_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--XMonotoneCurve_2.h @@ -1,6 +1,6 @@ namespace ArrTraits { /*! -\ingroup PkgArrangement2ConceptsGeometricObjects +\ingroup PkgArrangementOnSurface2ConceptsGeometricObjects \cgalConcept Represents a planar (weakly) \f$ x\f$-monotone curve. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementApproximateTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementApproximateTraits_2.h index 589bc03c6f7..080f03082e9 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementApproximateTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementApproximateTraits_2.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgArrangement2ConceptsTraits +\ingroup PkgArrangementOnSurface2ConceptsTraits \cgalConcept The concept `ArrangementApproximateTraits_2` refines the basic traits concept diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h index d65c174a8d0..fc7a2064e0c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2ConceptsTraits +\ingroup PkgArrangementOnSurface2ConceptsTraits \cgalConcept The concept `ArrangementBasicTraits_2` defines the minimal set of geometric diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementConstructXMonotoneCurveTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementConstructXMonotoneCurveTraits_2.h index 7d68ce1da70..2a88611de6c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementConstructXMonotoneCurveTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementConstructXMonotoneCurveTraits_2.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgArrangement2ConceptsTraits +\ingroup PkgArrangementOnSurface2ConceptsTraits \cgalConcept The concept `ArrangementConstructXMonotoneCurveTraits_2` refines the basic diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h index e6871287595..63c36749172 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2ConceptsDCEL +\ingroup PkgArrangementOnSurface2ConceptsDCEL \cgalConcept A doubly-connected edge-list (Dcel for short) data-structure. It consists diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h index 697dce33463..c8a8b03197b 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2ConceptsDCEL +\ingroup PkgArrangementOnSurface2ConceptsDCEL \cgalConcept A face record in a Dcel data structure. A face may either be unbounded, diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h index d5e581284bc..87d84acd8e9 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2ConceptsDCEL +\ingroup PkgArrangementOnSurface2ConceptsDCEL \cgalConcept A halfedge record in a Dcel data structure. Two halfedges with opposite diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h index c20aaf0e1ea..9e629686a6c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2ConceptsDCEL +\ingroup PkgArrangementOnSurface2ConceptsDCEL \cgalConcept A hole record in a Dcel data structure, which stores the face that contains diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h index 045be05776a..8d0a84e227d 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2ConceptsDCEL +\ingroup PkgArrangementOnSurface2ConceptsDCEL \cgalConcept An isolated vertex-information record in a Dcel data structure, which stores diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h index 1dfbfcfe5df..a78a11eb1a2 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2ConceptsDCEL +\ingroup PkgArrangementOnSurface2ConceptsDCEL \cgalConcept A vertex record in a Dcel data structure. A vertex is always associated diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h index 392bc80c412..fa8b7abdae5 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2ConceptsDCEL +\ingroup PkgArrangementOnSurface2ConceptsDCEL \cgalConcept The concept `ArrangementDcelWithRebind` refines the `ArrangementDcel` concept by adding diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h index fac833d4a6c..5ca8cb4460c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2Concepts +\ingroup PkgArrangementOnSurface2Concepts \cgalConcept A model for the `ArrangementInputFormatter` concept supports a set of functions that enable diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h index 65141423bc5..6aa8a1457cc 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgArrangement2ConceptsTraits +\ingroup PkgArrangementOnSurface2ConceptsTraits \cgalConcept The concept `ArrangementLandmarkTraits_2` refines the traits concepts diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h index cfe6553ece6..a1366fb094f 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2ConceptsTraits +\ingroup PkgArrangementOnSurface2ConceptsTraits \cgalConcept Several predicates are required to handle \f$ x\f$-monotone curves that diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h index 92649fbb1a1..03206537718 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2Concepts +\ingroup PkgArrangementOnSurface2Concepts \cgalConcept A model for the `ArrangementOutputFormatter` concept supports a set of functions that enable diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h index 0f65bb06b1d..1dbaba871b8 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2Concepts +\ingroup PkgArrangementOnSurface2Concepts \cgalConcept A model of the `ArrangementPointLocation_2` concept can answer point-location queries on diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h index 1c13c6a227b..0a2db816543 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h @@ -1,11 +1,11 @@ /*! -\ingroup PkgArrangement2ConceptsTraits +\ingroup PkgArrangementOnSurface2ConceptsTraits \cgalConcept The concept `ArrangementTraits_2` allows the construction of arrangement of general planar curves. Models of this concept are used -by the free \link PkgArrangement2Insert `CGAL::insert()` \endlink functions of the arrangement package and +by the free \link PkgArrangementOnSurface2Insert `CGAL::insert()` \endlink functions of the arrangement package and by the `CGAL::Arrangement_with_history_2` class. A model of this concept must define the nested `Curve_2` type, which diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h index 27d65a12c7f..b7cc4a71ab2 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2Concepts +\ingroup PkgArrangementOnSurface2Concepts \cgalConcept A model of the `ArrangementVerticalRayShoot_2` concept can answer vertical ray-shooting diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h index aae65845714..b2fdf82fe33 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2Concepts +\ingroup PkgArrangementOnSurface2Concepts \cgalConcept A model for the `ArrangementWithHistoryInputFormatter` concept supports a set of functions that enable diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h index ab2de7d7468..f917b232cd4 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2Concepts +\ingroup PkgArrangementOnSurface2Concepts \cgalConcept A model for the `ArrangementWithHistoryOutputFormatter` concept supports a set of functions that enable diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h index 10997c95a5f..e8a6830b700 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2ConceptsTraits +\ingroup PkgArrangementOnSurface2ConceptsTraits \cgalConcept The concept `ArrangementXMonotoneTraits_2` refines the basic arrangement-traits concept. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h index ae1ebbfded0..d727df92ac0 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgArrangement2ConceptsTraits +\ingroup PkgArrangementOnSurface2ConceptsTraits \cgalConcept A model for the `OverlayTraits` should be able to operate on records (namely, 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 844048f8e23..25e587778b7 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,69 +1,69 @@ -/// \defgroup PkgArrangement2 2D Arrangement Reference +/// \defgroup PkgArrangementOnSurface2Ref 2D Arrangement Reference -/// \defgroup PkgArrangement2Concepts Concepts -/// \ingroup PkgArrangement2 +/// \defgroup PkgArrangementOnSurface2Concepts Concepts +/// \ingroup PkgArrangementOnSurface2Ref /// \cgalConceptNamespace /// The namespace containing concepts specific to Arrangements. namespace ArrTraits {} -/// \defgroup PkgArrangement2ConceptsDCEL DCEL Concepts -/// \ingroup PkgArrangement2Concepts +/// \defgroup PkgArrangementOnSurface2ConceptsDCEL DCEL Concepts +/// \ingroup PkgArrangementOnSurface2Concepts -/// \defgroup PkgArrangement2ConceptsGeometricObjects Geometric Object Concepts -/// \ingroup PkgArrangement2Concepts +/// \defgroup PkgArrangementOnSurface2ConceptsGeometricObjects Geometric Object Concepts +/// \ingroup PkgArrangementOnSurface2Concepts -/// \defgroup PkgArrangement2ConceptsFunctionObjects Function Object Concepts -/// \ingroup PkgArrangement2Concepts +/// \defgroup PkgArrangementOnSurface2ConceptsFunctionObjects Function Object Concepts +/// \ingroup PkgArrangementOnSurface2Concepts -/// \defgroup PkgArrangement2ConceptsTraits Traits Concepts -/// \ingroup PkgArrangement2Concepts +/// \defgroup PkgArrangementOnSurface2ConceptsTraits Traits Concepts +/// \ingroup PkgArrangementOnSurface2Concepts -/// \defgroup PkgArrangement2TraitsClasses Traits Classes -/// \ingroup PkgArrangement2 +/// \defgroup PkgArrangementOnSurface2TraitsClasses Traits Classes +/// \ingroup PkgArrangementOnSurface2Ref -/// \defgroup PkgArrangement2DCEL DCEL -/// \ingroup PkgArrangement2 +/// \defgroup PkgArrangementOnSurface2DCEL DCEL +/// \ingroup PkgArrangementOnSurface2Ref -/// \defgroup PkgArrangement2IO I/O -/// \ingroup PkgArrangement2 +/// \defgroup PkgArrangementOnSurface2IO I/O +/// \ingroup PkgArrangementOnSurface2Ref -/// \defgroup PkgArrangement2op_left_shift operator<< -/// \ingroup PkgArrangement2IO +/// \defgroup PkgArrangementOnSurface2op_left_shift operator<< +/// \ingroup PkgArrangementOnSurface2IO -/// \defgroup PkgArrangement2op_right_shift operator>> -/// \ingroup PkgArrangement2IO +/// \defgroup PkgArrangementOnSurface2op_right_shift operator>> +/// \ingroup PkgArrangementOnSurface2IO -/// \defgroup PkgArrangement2PointLocation Point Location -/// \ingroup PkgArrangement2 +/// \defgroup PkgArrangementOnSurface2PointLocation Point Location +/// \ingroup PkgArrangementOnSurface2Ref -/// \defgroup PkgArrangement2Overlay Overlay -/// \ingroup PkgArrangement2 +/// \defgroup PkgArrangementOnSurface2Overlay Overlay +/// \ingroup PkgArrangementOnSurface2Ref -/// \defgroup PkgArrangement2Funcs Free Functions -/// \ingroup PkgArrangement2 +/// \defgroup PkgArrangementOnSurface2Funcs Free Functions +/// \ingroup PkgArrangementOnSurface2Ref -/// \defgroup PkgArrangement2Insert CGAL::insert() -/// \ingroup PkgArrangement2Funcs +/// \defgroup PkgArrangementOnSurface2Insert CGAL::insert() +/// \ingroup PkgArrangementOnSurface2Funcs -/// \defgroup PkgArrangement2Tags Tags -/// \ingroup PkgArrangement2 +/// \defgroup PkgArrangementOnSurface2Tags Tags +/// \ingroup PkgArrangementOnSurface2Ref -/// \defgroup PkgArrangement2Macros Macros -/// \ingroup PkgArrangement2 +/// \defgroup PkgArrangementOnSurface2Macros Macros +/// \ingroup PkgArrangementOnSurface2Ref -/// \defgroup PkgArrangement2Enums Enumerations -/// \ingroup PkgArrangement2 +/// \defgroup PkgArrangementOnSurface2Enums Enumerations +/// \ingroup PkgArrangementOnSurface2Ref /*! -\addtogroup PkgArrangement2 +\addtogroup PkgArrangementOnSurface2Ref \todo check generated documentation -\cgalPkgDescriptionBegin{2D Arrangements,PkgArrangement2Summary} +\cgalPkgDescriptionBegin{2D Arrangements,PkgArrangementOnSurface2} \cgalPkgPicture{Arrangement_2.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Ron Wein, Eric Berberich, Efi Fogel, Dan Halperin, Michael Hemmer, Oren Salzman, and Baruch Zukerman} \cgalPkgDesc{This package can be used to construct, maintain, alter, and display arrangements in the plane. Once an arrangement is constructed, the package can be used to obtain results of various queries on the arrangement, such as point location. The package also includes generic implementations of two algorithmic frameworks, that are, computing the zone of an arrangement, and line-sweeping the plane, the arrangements is embedded on. These frameworks are used in turn in the implementations of other operations on arrangements. Computing the overlay of two arrangements, for example, is based on the sweep-line framework. Arrangements and arrangement components can also be extended to store additional data. An important extension stores the construction history of the arrangement, such that it is possible to obtain the originating curve of an arrangement subcurve.} -\cgalPkgManuals{Chapter_2D_Arrangements,PkgArrangement2} +\cgalPkgManuals{Chapter_2D_Arrangements,PkgArrangementOnSurface2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.1} @@ -206,7 +206,7 @@ implemented as peripheral classes or as free (global) functions. - `CGAL::read()` - `CGAL::write()` - `CGAL::remove_curve()` -- \link PkgArrangement2op_left_shift `CGAL::operator<<` \endlink -- \link PkgArrangement2op_right_shift `CGAL::operator<<` \endlink +- \link PkgArrangementOnSurface2op_left_shift `CGAL::operator<<` \endlink +- \link PkgArrangementOnSurface2op_right_shift `CGAL::operator<<` \endlink */ diff --git a/BGL/doc/BGL/BGL.txt b/BGL/doc/BGL/BGL.txt index b5deb9702b6..6a319650062 100644 --- a/BGL/doc/BGL/BGL.txt +++ b/BGL/doc/BGL/BGL.txt @@ -22,7 +22,7 @@ Furthermore, this package extends the \sc{Bgl} by introducing concepts such as `HalfedgeGraph` and `FaceGraph` allowing to handle *halfedges* and *faces*. These concepts reflect the design of the halfedge data structure described -in Chapter \ref PkgHDSSummary, with opposite halfedges and circular +in Chapter \ref PkgHalfedgeDS, with opposite halfedges and circular sequences of halfedges around vertices and around faces. This chapter is organized as follows: @@ -31,10 +31,10 @@ This chapter is organized as follows: different libraries. - The four following sections give examples on how to use CGAL graph and mesh data structures such as -\link PkgSurfaceMeshSummary Surface_mesh \endlink, -\link PkgPolyhedronSummary Polyhedron \endlink, -\link PkgArrangement2Summary Arrangement_2 \endlink, and the -\link PkgTriangulation2Summary 2D triangulation \endlink classes as models of the \sc{Bgl} concepts. +\link PkgSurfaceMesh Surface_mesh \endlink, +\link PkgPolyhedron Polyhedron \endlink, +\link PkgArrangementOnSurface2 Arrangement_2 \endlink, and the +\link PkgTriangulation2 2D triangulation \endlink classes as models of the \sc{Bgl} concepts. - Starting with Section \ref BGLExtensions, we introduce new graph concepts, classes, and functions that extend the functionalities of the \sc{Bgl}. @@ -127,7 +127,7 @@ The data itself may be stored in the vertex or the edge, or it may be stored in an external data structure, or it may be computed on the fly. This is an implementation detail of a particular property map. -See also Chapter \ref PkgProperty_mapSummary. +See also Chapter \ref PkgPropertyMap. \subsection BGLVisitors Visitors @@ -218,7 +218,7 @@ the concepts provided by \cgal to implement a simple algorithm. The following example program computes the minimum spanning tree on a surface mesh. More examples can be found in Chapters -\ref PkgSurfaceMeshSimplificationSummary, \ref PkgSurfaceSegmentationSummary, and \ref PkgSurfaceMeshDeformationSummary. +\ref PkgSurfaceMeshSimplification, \ref PkgSurfaceMeshSegmentation, and \ref PkgSurfaceMeshDeformation. The surface mesh class uses integer indices to address vertices and edges, and it comes with a built-in property mechanism that maps nicely on the \sc{Bgl}. @@ -237,7 +237,7 @@ the concepts provided by \cgal to implement a simple algorithm. The following example program computes the minimum spanning tree on a polyhedral surface. More examples can be found in the Chapter -\ref PkgSurfaceMeshSimplificationSummary. +\ref PkgSurfaceMeshSimplification. \cgalExample{BGL_polyhedron_3/kruskal.cpp} @@ -423,7 +423,7 @@ by the functionalities of the \sc{Bgl}. \subsection BGLExtensionsGraphConcepts Graph concepts -In order to match \ref PkgHDSSummary more closely and to enable writing generic algorithms +In order to match \ref PkgHalfedgeDS more closely and to enable writing generic algorithms which operate on data structures that have faces and halfedges, we define a set of new concepts to extend the graph concepts of the BGL: @@ -636,7 +636,7 @@ Vertices of the seam mesh that are linked by a green dashed segment correspond to the same vertex in the underlying mesh. \cgalFigureEnd -Seam meshes are for example used in Chapter \ref PkgSurfaceParameterizationSummary +Seam meshes are for example used in Chapter \ref PkgSurfaceMeshParameterization to parameterize a topological sphere by first virtually cutting it into a topological disk. diff --git a/BGL/doc/BGL/NamedParameters.txt b/BGL/doc/BGL/NamedParameters.txt index 9100d01d6fd..f775e26ce48 100644 --- a/BGL/doc/BGL/NamedParameters.txt +++ b/BGL/doc/BGL/NamedParameters.txt @@ -1,6 +1,6 @@ /*! \defgroup bgl_namedparameters BGL Named Parameters -\ingroup PkgBGL +\ingroup PkgBGLRef The algorithms of the \sc{Bgl} often have many parameters with default values that are appropriate for most cases. In general, when no diff --git a/BGL/doc/BGL/PackageDescription.txt b/BGL/doc/BGL/PackageDescription.txt index 1aaf1804fbc..6ba2f1ba2d6 100644 --- a/BGL/doc/BGL/PackageDescription.txt +++ b/BGL/doc/BGL/PackageDescription.txt @@ -1,7 +1,7 @@ -/// \defgroup PkgBGL CGAL and the Boost Graph Library Reference +/// \defgroup PkgBGLRef CGAL and the Boost Graph Library Reference /*! \defgroup PkgBGLConcepts Concepts - \ingroup PkgBGL + \ingroup PkgBGLRef We extend the Boost Graph Library (\sc{Bgl} for short) with a set of new concepts. In order to make this documentation self-contained we here also document @@ -438,34 +438,34 @@ the requirement for traversal of all faces in a graph. /// The property tags model of the boost concept PropertyTag. /// These tags are used to retrieve default property maps using the traits class boost::property_map. /// \defgroup PkgBGLProperties Properties -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLPropertiesDynamic Dynamic Properties -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLHelper Helper Classes -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLHelperFct Helper Functions -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLIterators Iterators and Circulators -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLSelectionFct Selection Functions -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLAdaptors Graph Adaptors -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLEulerOperations Euler Operations -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLPartition Partitioning Operations -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /// \defgroup PkgBGLIOFct I/O Functions -/// \ingroup PkgBGL +/// \ingroup PkgBGLRef /*! \addtogroup PkgBGLPropertiesDynamic @@ -541,13 +541,13 @@ Methods to read and write graphs. /*! -\addtogroup PkgBGL -\cgalPkgDescriptionBegin{CGAL and the Boost Graph Library,PkgBGLSummary} +\addtogroup PkgBGLRef +\cgalPkgDescriptionBegin{CGAL and the Boost Graph Library,PkgBGL} \cgalPkgPicture{emst-detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Andreas Fabri, Fernando Cacciola, Philipp Moeller, and Ron Wein} \cgalPkgDesc{This package provides a framework for interfacing \cgal data structures with the algorithms of the Boost Graph Library, or \sc{BGL} for short. It allows to run graph algorithms directly on \cgal data structures which are model of the \sc{BGL} graph concepts, for example the shortest path algorithm on a Delaunay triangulation in order to compute the Euclidean minimum spanning tree. Furthermore, it introduces several new graph concepts describing halfedge data structures.} -\cgalPkgManuals{Chapter_CGAL_and_the_Boost_Graph_Library,PkgBGL} +\cgalPkgManuals{Chapter_CGAL_and_the_Boost_Graph_Library,PkgBGLRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} diff --git a/BGL/doc/BGL/graph_traits.txt b/BGL/doc/BGL/graph_traits.txt index ce760aebcde..bbc9deabdd9 100644 --- a/BGL/doc/BGL/graph_traits.txt +++ b/BGL/doc/BGL/graph_traits.txt @@ -1,7 +1,7 @@ /*! \defgroup PkgBGLTraits Specializations of boost::graph_traits -\ingroup PkgBGL +\ingroup PkgBGLRef The \sc{Bgl} defines the class template `boost::graph_traits` diff --git a/BGL/include/CGAL/boost/graph/partition.h b/BGL/include/CGAL/boost/graph/partition.h index 129e2421e13..a6bf761fccb 100644 --- a/BGL/include/CGAL/boost/graph/partition.h +++ b/BGL/include/CGAL/boost/graph/partition.h @@ -22,7 +22,7 @@ #define CGAL_BGL_PARTITION_H /** -* \ingroup PkgBGL +* \ingroup PkgBGLRef * \file CGAL/boost/graph/partition.h * Convenience header file including the headers for all the partitioning-related * free functions of this package. diff --git a/BGL/include/CGAL/boost/graph/split_graph_into_polylines.h b/BGL/include/CGAL/boost/graph/split_graph_into_polylines.h index 09fe353349b..2fc9ed6b461 100644 --- a/BGL/include/CGAL/boost/graph/split_graph_into_polylines.h +++ b/BGL/include/CGAL/boost/graph/split_graph_into_polylines.h @@ -203,7 +203,7 @@ void duplicate_terminal_vertices(Graph& graph, /*! -\ingroup PkgBGL +\ingroup PkgBGLRef splits into polylines the graph `g` at vertices of degree greater than 2 and at vertices for which `is_terminal(v,graph)==true`. The polylines are reported using a visitor. 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 da226aedf29..10c26e3d319 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 @@ -10,7 +10,7 @@ namespace CGAL { \section gbc_introduction Introduction -The package 2D Generalized Barycentric Coordinates offers an efficient and robust implementation of two-dimensional closed-form generalized barycentric coordinates defined for simple two-dimensional polygons. If coordinates with respect to multivariate scattered points instead of a polygon are required, please refer to natural neighbour coordinates from the package \ref PkgInterpolation2Summary "2D and Surface Function Interpolation". +The package 2D Generalized Barycentric Coordinates offers an efficient and robust implementation of two-dimensional closed-form generalized barycentric coordinates defined for simple two-dimensional polygons. If coordinates with respect to multivariate scattered points instead of a polygon are required, please refer to natural neighbour coordinates from the package \ref PkgInterpolation2 "2D and Surface Function Interpolation". In particular, the package includes an implementation of \ref wp_example "Wachspress", \ref mv_example "mean value", and \ref dh_example "discrete harmonic" coordinates and provides some extra functions to compute barycentric coordinates with respect to segments (\ref seg_example "segment coordinates") and triangles (\ref tri_example "triangle coordinates"). The section \ref gbc_theory gives a short introduction to the topic of barycentric coordinates. @@ -26,7 +26,7 @@ Segment and triangle coordinates can be computed by using either a global functi Any point in the plane may be taken as a query point. However, we do not recommend to use Wachspress and discrete harmonic coordinates with query points outside the closure of a polygon because at some of those points these coordinates are not well-defined, as explained in the Section \ref gbc_degeneracies. -Once instantiated for some polygon, the coordinates can be computed multiple times for different query points with respect to all the vertices of the provided polygon. Use the \ref PkgBarycentric_coordinates_2 "Reference Manual" for the detailed interface. +Once instantiated for some polygon, the coordinates can be computed multiple times for different query points with respect to all the vertices of the provided polygon. Use the \ref PkgBarycentricCoordinates2Ref "Reference Manual" for the detailed interface. The output of the computation is a set of coordinate values at the current query point with respect to all the vertices of the polygon. This output can be stored in an arbitrary container providing an appropriate output iterator. In addition, all the classes return a pointer to the last stored element and a status of the computation (Boolean true or false). @@ -85,7 +85,7 @@ This is an advanced example that shows how to use generalized barycentric coordi A 2D polygon with 50 vertices representing a piece of terrain with convex and concave parts. The height is not shown. \cgalFigureEnd -In this example we project a three-dimensional polygon orthogonally onto the two-dimensional plane using the class `CGAL::Projection_traits_xy_3`, triangulate its interior using the class `CGAL::Delaunay_mesher_2`, and compute mean value coordinates for all the obtained points with respect to all the polygon's vertices. Finally, we interpolate the height data from the polygon's boundary to its interior using the computed coordinates and the global interpolation function from the package \ref PkgInterpolation2Summary "2D and Surface Function Interpolation". +In this example we project a three-dimensional polygon orthogonally onto the two-dimensional plane using the class `CGAL::Projection_traits_xy_3`, triangulate its interior using the class `CGAL::Delaunay_mesher_2`, and compute mean value coordinates for all the obtained points with respect to all the polygon's vertices. Finally, we interpolate the height data from the polygon's boundary to its interior using the computed coordinates and the global interpolation function from the package \ref PkgInterpolation2 "2D and Surface Function Interpolation". \cgalExample{Barycentric_coordinates_2/Terrain_height_modeling.cpp} @@ -256,7 +256,7 @@ Analogously to the previous cases, we want to plot the Wachspress coordinates an The Wachspress coordinate function with respect to the indicated vertex with values from zero to one as the colour bar indicates. \cgalFigureEnd -Another type of generalized barycentric coordinates goes back to Pinkall and Polthier in 1993 \cite cgal:pp-cdmsc-93 and Eck et al. in 1995 \cite cgal:bc:eddhls-maam-95 in the context of \ref PkgSurfaceParameterizationSummary "triangle mesh parameterization". They are called discrete harmonic coordinates. \ref gbc_deg_discrete_harmonic_coordinates "These coordinates" are well-defined, similarly to Wachspress coordinates, for arbitrary strictly convex polygons and inherit all the properties of triangle coordinates apart from the positivity inside a polygon because they can take on negative values \ref gbc_deg_discrete_harmonic_coordinates "for some polygons". Another interesting property of these coordinate functions is that they coincide with Wachspress coordinates for any polygon whose vertices lie on a common circle. +Another type of generalized barycentric coordinates goes back to Pinkall and Polthier in 1993 \cite cgal:pp-cdmsc-93 and Eck et al. in 1995 \cite cgal:bc:eddhls-maam-95 in the context of \ref PkgSurfaceMeshParameterization "triangle mesh parameterization". They are called discrete harmonic coordinates. \ref gbc_deg_discrete_harmonic_coordinates "These coordinates" are well-defined, similarly to Wachspress coordinates, for arbitrary strictly convex polygons and inherit all the properties of triangle coordinates apart from the positivity inside a polygon because they can take on negative values \ref gbc_deg_discrete_harmonic_coordinates "for some polygons". Another interesting property of these coordinate functions is that they coincide with Wachspress coordinates for any polygon whose vertices lie on a common circle. To plot discrete harmonic coordinates we take \ref wp_plot "the same polygon" as for Wachspress coordinates and plot the coordinate function with respect to the same vertex. Again, we get a smooth function, which is linear along all edges and grows from zero to one. Isolines in the plot show the difference between discrete harmonic and Wachspress coordinates for the chosen polygon and vertex. @@ -265,7 +265,7 @@ To plot discrete harmonic coordinates we take \ref wp_plot "the same polygon" as The discrete harmonic coordinate function with respect to the indicated vertex with values from zero to one as the colour bar indicates. \cgalFigureEnd -The last type of generalized barycentric coordinates that we discuss are mean value coordinates \cite cgal:f-mvc-03 proposed by M. Floater in 2003. Based on the mean value theorem, \ref gbc_deg_mean_value_coordinates "these coordinates", unlike Wachspress and discrete harmonic coordinates, are well-defined for arbitrary simple polygons, inherit all the properties of triangle coordinates for any convex polygon, and lack only the positivity property for general concave polygons. Hormann and Floater prove in \cite cgal:bc:hf-mvcapp-06 that these coordinates are positive inside the kernel of a star-shaped polygon. They are also positive in the closure of any quadrilateral. Like discrete harmonic weights, mean value weights are often used in the context of \ref PkgSurfaceParameterizationSummary "triangle mesh parameterization." +The last type of generalized barycentric coordinates that we discuss are mean value coordinates \cite cgal:f-mvc-03 proposed by M. Floater in 2003. Based on the mean value theorem, \ref gbc_deg_mean_value_coordinates "these coordinates", unlike Wachspress and discrete harmonic coordinates, are well-defined for arbitrary simple polygons, inherit all the properties of triangle coordinates for any convex polygon, and lack only the positivity property for general concave polygons. Hormann and Floater prove in \cite cgal:bc:hf-mvcapp-06 that these coordinates are positive inside the kernel of a star-shaped polygon. They are also positive in the closure of any quadrilateral. Like discrete harmonic weights, mean value weights are often used in the context of \ref PkgSurfaceMeshParameterization "triangle mesh parameterization." In order to show the particular behaviour of mean value coordinates with an application to concave polygons, we take \ref fig__mv__example "a star-shaped polygon" with ten vertices \f$[v_0, \dots, v_9]\f$, sample its interior and boundary, and plot the coordinate function with respect to the fourth vertex \f$v_3\f$. As the colour bar indicates, the obtained function grows from a slightly negative value to one at the chosen vertex. It is also smooth inside the polygon and linear along all edges. diff --git a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Concepts/BarycentricCoordinates_2.h b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Concepts/BarycentricCoordinates_2.h index 961c9de9c45..3d90dd14ef9 100644 --- a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Concepts/BarycentricCoordinates_2.h +++ b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Concepts/BarycentricCoordinates_2.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgBarycentric_coordinates_2Concepts +\ingroup PkgBarycentricCoordinates2Concepts \cgalConcept Requirements of the template parameter `Coordinate_2` for the class `CGAL::Barycentric_coordinates::Generalized_barycentric_coordinates_2`. diff --git a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Concepts/BarycentricTraits_2.h b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Concepts/BarycentricTraits_2.h index b79617eea76..ae63a83a518 100644 --- a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Concepts/BarycentricTraits_2.h +++ b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Concepts/BarycentricTraits_2.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgBarycentric_coordinates_2Concepts +\ingroup PkgBarycentricCoordinates2Concepts \cgalConcept Requirements of the template parameter `Traits` for all the classes with two-dimensional barycentric coordinates from the namespace `CGAL::Barycentric_coordinates`. diff --git a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt index 29cae2cd33c..73e02ea085b 100644 --- a/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt +++ b/Barycentric_coordinates_2/doc/Barycentric_coordinates_2/PackageDescription.txt @@ -1,17 +1,17 @@ -/// \defgroup PkgBarycentric_coordinates_2 2D Generalized Barycentric Coordinates Reference +/// \defgroup PkgBarycentricCoordinates2Ref 2D Generalized Barycentric Coordinates Reference -/// \defgroup PkgBarycentric_coordinates_2Concepts Concepts -/// \ingroup PkgBarycentric_coordinates_2 +/// \defgroup PkgBarycentricCoordinates2Concepts Concepts +/// \ingroup PkgBarycentricCoordinates2Ref /*! -\addtogroup PkgBarycentric_coordinates_2 -\cgalPkgDescriptionBegin{2D Generalized Barycentric Coordinates, PkgBarycentric_coordinates_2Summary} +\addtogroup PkgBarycentricCoordinates2Ref +\cgalPkgDescriptionBegin{2D Generalized Barycentric Coordinates, PkgBarycentricCoordinates2} \cgalPkgPicture{barcoord_thumb.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Dmitry Anisimov, David Bommes, Kai Hormann, and Pierre Alliez} -\cgalPkgDesc{The package 2D Generalized Barycentric Coordinates offers an efficient and robust implementation of two-dimensional closed-form generalized barycentric coordinates defined for simple two-dimensional polygons. If coordinates with respect to multivariate scattered points instead of a polygon are required, please refer to natural neighbor coordinates from the Package \ref PkgInterpolation2Summary.} -\cgalPkgManuals{Chapter_2D_Generalized_Barycentric_Coordinates, PkgBarycentric_coordinates_2} +\cgalPkgDesc{The package 2D Generalized Barycentric Coordinates offers an efficient and robust implementation of two-dimensional closed-form generalized barycentric coordinates defined for simple two-dimensional polygons. If coordinates with respect to multivariate scattered points instead of a polygon are required, please refer to natural neighbor coordinates from the Package \ref PkgInterpolation2.} +\cgalPkgManuals{Chapter_2D_Generalized_Barycentric_Coordinates, PkgBarycentricCoordinates2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.6} diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Discrete_harmonic_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Discrete_harmonic_2.h index 5ab84f16885..c906a697198 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Discrete_harmonic_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Discrete_harmonic_2.h @@ -49,7 +49,7 @@ namespace Barycentric_coordinates { // [1] Reference: "M. S. Floater, K. Hormann, and G. Kos. A general construction of barycentric coordinates over convex polygons. Advances in Computational Mathematics, 24(1-4):311-331, 2006.". /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentricCoordinates2Ref * The class `Discrete_harmonic_2` implements 2D discrete harmonic coordinates ( \cite cgal:bc:fhk-gcbcocp-06, \cite cgal:pp-cdmsc-93, \cite cgal:bc:eddhls-maam-95 ). * This class is parameterized by a traits class `Traits`, and it is used as a coordinate class to complete the class `Generalized_barycentric_coordinates_2`. * For a polygon with three vertices (triangle) it is better to use the class `Triangle_coordinates_2`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Generalized_barycentric_coordinates_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Generalized_barycentric_coordinates_2.h index 4bce42d7680..5a214236086 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Generalized_barycentric_coordinates_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Generalized_barycentric_coordinates_2.h @@ -48,7 +48,7 @@ namespace Barycentric_coordinates { // Examples: see the User Manual here - https://doc.cgal.org/latest/Manual/index.html. /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentricCoordinates2Ref * The class `Generalized_barycentric_coordinates_2` implements generalized barycentric coordinates along the polygon's boundary and provides a common interface for all coordinate classes. * This class is parameterized by a coordinate class `Coordinate_2`, and a traits class `Traits`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Mean_value_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Mean_value_2.h index e44a126dc56..af15ec92ac8 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Mean_value_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Mean_value_2.h @@ -101,7 +101,7 @@ public: // [2] Reference: "M. S. Floater, Wachspress and mean value coordinates, to appear in the Proceedings of the 14th International Conference on Approximation Theory, G. Fasshauer and L. L. Schumaker (eds.)." /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentricCoordinates2Ref * The class `Mean_value_2` implements 2D mean value coordinates ( \cite cgal:bc:hf-mvcapp-06, \cite cgal:bc:fhk-gcbcocp-06, \cite cgal:f-mvc-03 ). * This class is parameterized by a traits class `Traits`, and it is used as a coordinate class to complete the class `Generalized_barycentric_coordinates_2`. * For a polygon with three vertices (triangle) it is better to use the class `Triangle_coordinates_2`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Segment_coordinates_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Segment_coordinates_2.h index 34fe8b3ba3b..cbd74d8fb21 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Segment_coordinates_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Segment_coordinates_2.h @@ -48,7 +48,7 @@ namespace Barycentric_coordinates { // Examples: see the User Manual - https://doc.cgal.org/latest/Manual/index.html. /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentricCoordinates2Ref * The class `Segment_coordinates_2` implements barycentric coordinates with respect to an arbitrary non-degenerate segment along an arbitrary line in the plane. * This class is parameterized by a traits class `Traits`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Triangle_coordinates_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Triangle_coordinates_2.h index 8ef6af47752..8d8222db4aa 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Triangle_coordinates_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Triangle_coordinates_2.h @@ -49,7 +49,7 @@ namespace Barycentric_coordinates { // [1] Reference: Weisstein, Eric W. "Barycentric Coordinates." From MathWorld--A Wolfram Web Resource. http://mathworld.wolfram.com/BarycentricCoordinates.html. /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentricCoordinates2Ref * The class `Triangle_coordinates_2` implements barycentric coordinates ( [1], * [2] ) with respect to an arbitrary non-degenerate triangle in the plane. * This class is parameterized by a traits class `Traits`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Wachspress_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Wachspress_2.h index 09209606660..0e9d42fa317 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Wachspress_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Wachspress_2.h @@ -49,7 +49,7 @@ namespace Barycentric_coordinates { // [1] Reference: "M. S. Floater, K. Hormann, and G. Kos. A general construction of barycentric coordinates over convex polygons. Advances in Computational Mathematics, 24(1-4):311-331, 2006.". /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentricCoordinates2Ref * The class `Wachspress_2` implements 2D Wachspress coordinates ( \cite cgal:bc:fhk-gcbcocp-06, \cite cgal:bc:mlbd-gbcip-02, \cite cgal:bc:w-rfeb-75 ). * This class is parameterized by a traits class `Traits`, and it is used as a coordinate class to complete the class `Generalized_barycentric_coordinates_2`. * For a polygon with three vertices it is better to use the class `Triangle_coordinates_2`. diff --git a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/barycentric_enum_2.h b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/barycentric_enum_2.h index 3f8fe3541ca..9f79c0227bd 100644 --- a/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/barycentric_enum_2.h +++ b/Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/barycentric_enum_2.h @@ -32,7 +32,7 @@ namespace CGAL { /*! - * \ingroup PkgBarycentric_coordinates_2 + * \ingroup PkgBarycentricCoordinates2Ref * The namespace Barycentric_coordinates contains implementations of all generalized barycentric coordinates: 2D, 3D, related enumerations, and so on. */ 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 fefab6d04e6..f62ef5d35b8 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 @@ -23,7 +23,7 @@ intersection predicates, and point containment predicates. Ordinary Boolean set-operations, which distinguish between the interior and the boundary of a polygon, are not implemented within this -package. The Chapter \ref PkgNef2Summary supports these operations for (linear) +package. The Chapter \ref PkgNef2 supports these operations for (linear) polygons. In the rest of this chapter we use, unless otherwise stated, the diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2.h index 4c918fffd2b..f22267db575 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! \addtogroup boolean_complement Complement Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_complement The `complement` function is overloaded. Depending on the @@ -58,7 +58,7 @@ namespace CGAL { /*! \addtogroup boolean_difference Difference Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_difference Each one of these functions computes the difference between two given @@ -181,7 +181,7 @@ namespace CGAL { /*! \addtogroup boolean_do_intersect Intersection Testing Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_do_intersect Each one of these functions computes if the interior of two given @@ -305,7 +305,7 @@ namespace CGAL { /*! \addtogroup boolean_intersection Intersection Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_intersection Each one of these functions computes the intersection of two given @@ -467,7 +467,7 @@ namespace CGAL { /*! \addtogroup boolean_join Union Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_union Each one of these functions computes the union of two given polygons @@ -621,7 +621,7 @@ OutputIterator oi); namespace CGAL { /*! \addtogroup boolean_oriented_side Oriented Side Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_oriented_side Each one of these functions returns `ON_POSITIVE_SIDE` if the two @@ -706,7 +706,7 @@ namespace CGAL { /*! \addtogroup boolean_symmetric_difference Symmetric Difference Functions -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_symmetric_difference Each one of these functions computes the symmetric difference between diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h index f15067d1cfb..a70de3fc84d 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref An instance of this template serves as a basis type for any face record of the Dcel class used by instances of the @@ -22,7 +22,7 @@ further. class Gps_face_base : public Arr_face_base {}; /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref An instance of this teplate serves as a basis type for any halfedge record of the Dcel class used by instances of the @@ -44,7 +44,7 @@ class Gps_halfedge_base : public Arr_halfedge_base {}; /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref The default Dcel class template used by the `General_polygon_set_2` and `General_polygon_with_holes_2` class templates. diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h index 0eef1b3b4bf..9f1b175d383 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref The class `General_polygon_2` models the concept `GeneralPolygon_2`. It represents a simple general-polygon. It is parameterized with the type diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h index fbaf40f38b8..c11787975f8 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref An object of the `General_polygon_set_2` class-template represents a point set in the plane bounded by \f$ x\f$ monotone curves. Points in the set diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h index de13d563186..663c1d11a4c 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref The traits class `Gps_circle_segment_traits_2` models the `GeneralPolygonSetTraits_2` concept. It enables Boolean set-operations on general polygons bounded by diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h index adc2521cbfa..536b7dddd40 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \cgalModels `GeneralPolygonSetTraits_2` diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h index cb5172cbf06..d5155423f8e 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref The traits class `Gps_traits_2` models the concept `GeneralPolygonSetTraits_2`. It inherits from the instantiated diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_set_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_set_2.h index 1e9b5211e9a..3ed0e9cc728 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_set_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Polygon_set_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref The class `Polygon_set_2` represents sets of linear polygons with holes. The first two template parameters (`Kernel` and `Container`) diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/connect_holes.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/connect_holes.h index 939c8566e9f..928c0d1fc96 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/connect_holes.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/connect_holes.h @@ -2,7 +2,7 @@ namespace CGAL { /*! \addtogroup boolean_connect_holes Functions on Polygon with Holes -\ingroup PkgBooleanSetOperations2 +\ingroup PkgBooleanSetOperations2Ref \anchor ref_bso_connect_holes 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 c9570ed6982..11947d410d4 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,24 +1,24 @@ -/// \defgroup PkgBooleanSetOperations2 2D Regularized Boolean Set-Operations Reference +/// \defgroup PkgBooleanSetOperations2Ref 2D Regularized Boolean Set-Operations Reference /// \defgroup PkgBooleanSetOperations2Concepts Concepts -/// \ingroup PkgBooleanSetOperations2 +/// \ingroup PkgBooleanSetOperations2Ref /// \cgalConceptNamespace /// The namespace containing concepts specific to 2D Boolean Set Operations. namespace ArrDirectionalTraits {} /*! -\addtogroup PkgBooleanSetOperations2 +\addtogroup PkgBooleanSetOperations2Ref \todo check generated documentation -\cgalPkgDescriptionBegin{2D Regularized Boolean Set-Operations,PkgBooleanSetOperations2Summary} +\cgalPkgDescriptionBegin{2D Regularized Boolean Set-Operations,PkgBooleanSetOperations2} \cgalPkgPicture{Boolean_set_operations_2.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Efi Fogel, Ophir Setter, Ron Wein, Guy Zucker, Baruch Zukerman, and Dan Halperin} \cgalPkgDesc{This package consists of the implementation of Boolean set-operations on point sets bounded by weakly x-monotone curves in 2-dimensional Euclidean space. In particular, it contains the implementation of regularized Boolean set-operations, intersection predicates, and point containment predicates.} -\cgalPkgManuals{Chapter_2D_Regularized_Boolean_Set-Operations,PkgBooleanSetOperations2} +\cgalPkgManuals{Chapter_2D_Regularized_Boolean_Set-Operations,PkgBooleanSetOperations2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} -\cgalPkgDependsOn{\ref PkgArrangement2Summary} +\cgalPkgDependsOn{\ref PkgArrangementOnSurface2} \cgalPkgBib{cgal:fwzh-rbso2} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{Boolean operations,boolean_operations_2.zip} diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h index 8fbe5d25734..c53940face3 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of class `Approximate_min_ellipsoid_d` is an approximation to the ellipsoid of smallest volume enclosing a finite multiset of points diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h index edd58cacab9..8692b24c19a 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Approximate_min_ellipsoid_d_traits_2` is a traits class for `CGAL::Approximate_min_ellipsoid_d` using the diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h index dd398e46456..b7f79cd4167 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Approximate_min_ellipsoid_d_traits_3` is a traits class for `CGAL::Approximate_min_ellipsoid_d` using the diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h index b7bdcbe586e..75d4b45137d 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Approximate_min_ellipsoid_d_traits_d` is a traits class for `CGAL::Approximate_min_ellipsoid_d` using the diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h index c7af75cd66f..fdcc62b8986 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of the class `Min_annulus_d` is the unique annulus (region between two concentric spheres with radii \f$ r\f$ and \f$ R\f$, \f$ r \leq R\f$) enclosing a diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h index f4e8d622eb0..62309eefebe 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of the class `Min_circle_2` is the unique circle of smallest area enclosing a finite (multi)set of points in two-dimensional Euclidean diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h index acba791f7dc..3fe2037bdc2 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_circle_2_traits_2` is a traits class for `Min_circle_2` using the two-dimensional \cgal kernel. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h index fc36ae9e095..a9edbb88bcd 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of the class `Min_ellipse_2` is the unique ellipse of smallest area enclosing a finite (multi)set of points in two-dimensional euclidean diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h index e6a1ec22a1e..3a1f2fd3e77 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_ellipse_2_traits_2` is a traits class for `CGAL::Min_ellipse_2` using the two-di-men-sional \cgal kernel. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h index 6562281723e..212e5188ba2 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_quadrilateral_default_traits_2` is a traits class for the functions `min_rectangle_2`, `min_parallelogram_2` and diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h index d0806b47f50..9d0e4de3c88 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_annulus_d_traits_2` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the two-dimensional \cgal kernel. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h index e4627f99380..6d07f070b9e 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_annulus_d_traits_3` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the three-dimensional \cgal kernel. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h index 5fec804b71d..0e65c594f65 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_annulus_d_traits_d` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the \f$ d\f$-dimensional \cgal kernel. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h index 7c93a00b5e1..a682dd41650 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of the class `Min_sphere_d` is the unique sphere of smallest volume enclosing a finite (multi)set of points in \f$ d\f$-dimensional diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h index 778ee39f84d..5b5f00fc91f 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_points_d_traits_2` is a diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h index 94fc8752a01..0a789e04e45 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_points_d_traits_3` is a diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h index 20af328cf96..2fa016f2303 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_points_d_traits_d` is diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h index 24de9ca7fd8..f7cb4a140ca 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef An object of the class `Min_sphere_of_spheres_d` is a data structure that represents the unique sphere of smallest volume enclosing a finite set of spheres diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h index 6154e5dae39..a0e085ede92 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_spheres_d_traits_2` is a diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h index b59539673e6..e366016a9e0 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_spheres_d_traits_3` is a diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h index 81774e86735..6821e1e210c 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Min_sphere_of_spheres_d_traits_d` is diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h index 84ce8286486..c9c0f1469ae 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The function computes a minimum area enclosing parallelogram \f$ A(P)\f$ of a given convex point set \f$ P\f$. Note that @@ -72,7 +72,7 @@ Traits& t = Default_traits); namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The function computes a minimum area enclosing rectangle \f$ R(P)\f$ of a given convex point set \f$ P\f$. Note that \f$ R(P)\f$ is not @@ -141,7 +141,7 @@ Traits& t = Default_traits); namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The function computes a minimum width enclosing strip \f$ S(P)\f$ of a given convex point set \f$ P\f$. A strip is the closed region diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h index debd0c3c8ea..77381b0cb91 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef The class `Rectangular_p_center_default_traits_2` defines types and operations needed to compute rectilinear \f$ p\f$-centers of a planar point set @@ -194,7 +194,7 @@ construct_iso_rectangle_2_above_right_point_2_object() const; }; /*! -\ingroup PkgBoundingVolumes +\ingroup PkgBoundingVolumesRef Computes rectilinear \f$ p\f$-centers of a planar point set, i.e.\ a set of \f$ p\f$ points such diff --git a/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt b/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt index 30b90996b35..761addad579 100644 --- a/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt +++ b/Bounding_volumes/doc/Bounding_volumes/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgBoundingVolumes Bounding Volumes Reference +/// \defgroup PkgBoundingVolumesRef Bounding Volumes Reference /// \defgroup PkgBoundingVolumesConcepts Concepts -/// \ingroup PkgBoundingVolumes +/// \ingroup PkgBoundingVolumesRef /*! -\addtogroup PkgBoundingVolumes +\addtogroup PkgBoundingVolumesRef \todo check generated documentation -\cgalPkgDescriptionBegin{Bounding Volumes,PkgBoundingVolumesSummary} +\cgalPkgDescriptionBegin{Bounding Volumes,PkgBoundingVolumes} \cgalPkgPicture{minCircle.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr} \cgalPkgDesc{This package provides algorithms for computing optimal bounding volumes of point sets. In d-dimensional space, the smallest enclosing sphere, ellipsoid (approximate), and annulus can be computed. In 3-dimensional space, the smallest enclosing strip is available as well, and in 2-dimensional space, there are algorithms for a number of additional volumes (rectangles, parallelograms, \f$ k=2,3,4\f$ axis-aligned rectangles). The smallest enclosing sphere algorithm can also be applied to a set of d-dimensional spheres.} -\cgalPkgManuals{Chapter_Bounding_Volumes,PkgBoundingVolumes} +\cgalPkgManuals{Chapter_Bounding_Volumes,PkgBoundingVolumesRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.1} diff --git a/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt b/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt index 272c41c14d5..1478c8a0cf1 100644 --- a/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt +++ b/Box_intersection_d/doc/Box_intersection_d/PackageDescription.txt @@ -1,33 +1,33 @@ -/// \defgroup PkgBoxIntersectionD Intersecting Sequences of dD Iso-oriented Boxes Reference +/// \defgroup PkgBoxIntersectionDRef Intersecting Sequences of dD Iso-oriented Boxes Reference /// \defgroup PkgBoxIntersectionDConcepts Concepts -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /// \defgroup PkgBoxIntersectionDClasses Classes -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /// \defgroup PkgBoxIntersectionD_box_intersection_d CGAL::box_intersection_d() -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /// \defgroup PkgBoxIntersectionD_box_intersection_all_pairs_d CGAL::box_intersection_all_pairs_d() -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /// \defgroup PkgBoxIntersectionD_box_self_intersection_d CGAL::box_self_intersection_d() -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /// \defgroup PkgBoxIntersectionD_box_self_intersection_all_pairs_d CGAL::box_self_intersection_all_pairs_d() -/// \ingroup PkgBoxIntersectionD +/// \ingroup PkgBoxIntersectionDRef /*! -\addtogroup PkgBoxIntersectionD +\addtogroup PkgBoxIntersectionDRef \todo de-math and change D to d for the dimension -\cgalPkgDescriptionBegin{Intersecting Sequences of dD Iso-oriented Boxes,PkgBoxIntersectionDSummary} +\cgalPkgDescriptionBegin{Intersecting Sequences of dD Iso-oriented Boxes,PkgBoxIntersectionD} \cgalPkgPicture{box_inters-small.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Lutz Kettner, Andreas Meyer, and Afra Zomorodian} \cgalPkgDesc{An efficient algorithm for finding all intersecting pairs for large numbers of iso-oriented boxes, in order to apply a user defined callback on them. Typically these boxes will be bounding boxes of more complicated geometries. The algorithm is useful for (self-) intersection tests of surfaces etc. } -\cgalPkgManuals{Chapter_Intersecting_Sequences_of_dD_Iso-oriented_Boxes,PkgBoxIntersectionD} +\cgalPkgManuals{Chapter_Intersecting_Sequences_of_dD_Iso-oriented_Boxes,PkgBoxIntersectionDRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.1} diff --git a/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h b/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h index 32c46524737..5152f1a50a2 100644 --- a/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h +++ b/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgCGALIpelets +\ingroup PkgCGALIpeletsRef The registration of a new ipelet can be done using the macro command `CGAL_IPELET`. Taking as a parameter the name of the class defining the new ipelet, that macro must be placed in the source file after the class definition. @@ -9,7 +9,7 @@ file after the class definition. namespace CGAL { /*! -\ingroup PkgCGALIpelets +\ingroup PkgCGALIpeletsRef `Ipelet_base` is an abstract base class for defining an ipelet. The only function that needs to be defined in a derived class is diff --git a/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt b/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt index d51312d18c2..61200e65b1f 100644 --- a/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt +++ b/CGAL_ipelets/doc/CGAL_ipelets/PackageDescription.txt @@ -1,12 +1,12 @@ -/// \defgroup PkgCGALIpelets CGAL Ipelets Reference +/// \defgroup PkgCGALIpeletsRef CGAL Ipelets Reference /*! -\addtogroup PkgCGALIpelets -\cgalPkgDescriptionBegin{CGAL Ipelets,PkgCGALIpeletsSummary} +\addtogroup PkgCGALIpeletsRef +\cgalPkgDescriptionBegin{CGAL Ipelets,PkgCGALIpelets} \cgalPkgPicture{ipeico.jpg} \cgalPkgSummaryBegin \cgalPkgAuthors{Olivier Devillers, Sébastien Loriot, and Sylvain Pion} \cgalPkgDesc{This package provides a generic framework to easily write ipelets (plug-in's) using \cgal for the the Ipe extensible drawing editor.} -\cgalPkgManuals{Chapter_CGAL_Ipelets,PkgCGALIpelets} +\cgalPkgManuals{Chapter_CGAL_Ipelets,PkgCGALIpeletsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} diff --git a/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt b/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt index 5343842eb4a..e51308477a9 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt +++ b/Circular_kernel_2/doc/Circular_kernel_2/PackageDescription.txt @@ -1,34 +1,34 @@ -/// \defgroup PkgCircularKernel2 2D Circular Geometry Kernel Reference +/// \defgroup PkgCircularKernel2Ref 2D Circular Geometry Kernel Reference /// \defgroup PkgCircularKernel2GeometricConcepts Geometric Concepts -/// \ingroup PkgCircularKernel2 +/// \ingroup PkgCircularKernel2Ref /// \defgroup PkgCircularKernel2GeometricClasses Geometric Kernel and Classes -/// \ingroup PkgCircularKernel2 +/// \ingroup PkgCircularKernel2Ref /// \defgroup PkgCircularKernel2GeometricFunctions Geometric Global Functions -/// \ingroup PkgCircularKernel2 +/// \ingroup PkgCircularKernel2Ref /// \defgroup PkgCircularKernel2AlgebraicConcepts Algebraic Concepts -/// \ingroup PkgCircularKernel2 +/// \ingroup PkgCircularKernel2Ref /// \defgroup PkgCircularKernel2AlgebraicClasses Algebraic Kernel and Classes -/// \ingroup PkgCircularKernel2 +/// \ingroup PkgCircularKernel2Ref /*! -\addtogroup PkgCircularKernel2 +\addtogroup PkgCircularKernel2Ref \todo check generated documentation -\cgalPkgDescriptionBegin{2D Circular Geometry Kernel,PkgCircularKernel2Summary} +\cgalPkgDescriptionBegin{2D Circular Geometry Kernel,PkgCircularKernel2} \cgalPkgPicture{Boolean_operation_detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Pedro Machado Manhães de Castro, Sylvain Pion, and Monique Teillaud} \cgalPkgDesc{This package is an extension of the linear \cgal kernel. It offers functionalities on circles, circular arcs and line segments in the plane. } -\cgalPkgManuals{Chapter_2D_Circular_Geometry_Kernel,PkgCircularKernel2} +\cgalPkgManuals{Chapter_2D_Circular_Geometry_Kernel,PkgCircularKernel2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Algebraic_kernel_for_spheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Algebraic_kernel_for_spheres_2_3.h index 6867ba05ee6..55a6093a78e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Algebraic_kernel_for_spheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Algebraic_kernel_for_spheres_2_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSphericalKernel3AlgebraicClasses +\ingroup PkgCircularKernel3AlgebraicClasses \cgalModels `AlgebraicKernelForSpheres` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circle_type.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circle_type.h index ac96f07d415..430446ebc00 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circle_type.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circle_type.h @@ -1,6 +1,6 @@ namespace CGAL { /*! - \ingroup PkgSphericalKernel3GeometricClasses + \ingroup PkgCircularKernel3GeometricClasses The enum `Circle_type` is used to classify an object of type `Circle_3`, so as to specify its type (normal,polar,bipolar or threaded), as defined in Section \ref sectionSKobjects. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h index eea28fb3796..ae81c8a30b1 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricClasses +\ingroup PkgCircularKernel3GeometricClasses \cgalModels `SphericalKernel::CircularArc_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h index dedfefdbf5a..aa1faa8a9cf 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricClasses +\ingroup PkgCircularKernel3GeometricClasses \cgalModels `SphericalKernel::CircularArcPoint_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Exact_spherical_kernel_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Exact_spherical_kernel_3.h index e39620dc8bb..00159f6b404 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Exact_spherical_kernel_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Exact_spherical_kernel_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricClasses +\ingroup PkgCircularKernel3GeometricClasses A typedef to a spherical kernel that provides both exact geometric predicates and exact geometric constructions. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h index 52916046472..3173d76855a 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricClasses +\ingroup PkgCircularKernel3GeometricClasses \cgalModels `SphericalKernel::LineArc_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_1_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_1_3.h index f476455d9eb..025200ba4c1 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_1_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_1_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSphericalKernel3AlgebraicClasses +\ingroup PkgCircularKernel3AlgebraicClasses \cgalModels `AlgebraicKernelForSpheres::Polynomial_1_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_2_3.h index 6410811b92d..5adf730a43a 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_2_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSphericalKernel3AlgebraicClasses +\ingroup PkgCircularKernel3AlgebraicClasses \cgalModels `AlgebraicKernelForSpheres::PolynomialForSpheres_2_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_for_line_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_for_line_3.h index 8987c2aa93c..3a8ad778710 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_for_line_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Polynomials_for_line_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSphericalKernel3AlgebraicClasses +\ingroup PkgCircularKernel3AlgebraicClasses \cgalModels `AlgebraicKernelForSpheres::PolynomialsForLines_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Root_for_spheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Root_for_spheres_2_3.h index 3afdd451378..b73f031e5d1 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Root_for_spheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Root_for_spheres_2_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSphericalKernel3AlgebraicClasses +\ingroup PkgCircularKernel3AlgebraicClasses \cgalModels `AlgebraicKernelForSpheres::RootForSpheres_2_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h index 21d92e1a274..3016c5a4035 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricClasses +\ingroup PkgCircularKernel3GeometricClasses \cgalModels `SphericalKernel` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/global_functions_spherical_kernel_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/global_functions_spherical_kernel_3.h index f1f52278e26..b00e2b99e20 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/global_functions_spherical_kernel_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/global_functions_spherical_kernel_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Classify a circle according to `sphere`, as defined in Section \ref sectionSKobjects. \pre `c` lies on `sphere`. @@ -18,7 +18,7 @@ classify(const CGAL::Circle_3 & c, const CGAL::Sphere_3 & p, const CGAL::Circular_arc_point_3 & q,const CGAL::Sphere_3& sphere); /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Compares the \f$ \theta\f$-coordinates of `p` and of the meridian defined by `m` (see Section \ref sectionSKobjects) @@ -61,7 +61,7 @@ Comparison_result compare_theta(const CGAL::Circular_arc_point_3 &p, const CGAL::Vector_3 &m, const CGAL::Sphere_3& sphere ); /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Compares the \f$ \theta\f$-coordinates of the meridian defined by `m` and of `p` (see Section \ref sectionSKobjects) in the cylindrical coordinate system relative to `sphere`. @@ -85,7 +85,7 @@ compare_theta(const CGAL::Vector_3 &m,const CGAL::Circular_arc_ namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Compares `p` and `q` according to the lexicographic ordering on \f$ \theta\f$ and \f$ z\f$-coordinates in the cylindrical coordinate system relative to `sphere`. @@ -111,7 +111,7 @@ const CGAL::Circular_arc_point_3 & q, const CGAL::Sphere_3 & a,const CGAL::Sp namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Returns the point on the circle that is extremal in \f$ \theta\f$ using the cylindrical coordinate system relative to `sphere`, and that has the smallest (resp.\ largest) @@ -147,7 +147,7 @@ theta_extremal_point(const CGAL::Circle_3 & c, const CGAL::Sphe namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Copies in the output iterator the \f$ \theta\f$-extremal points of the circle relatively to `sphere`. `res` iterates on elements of type @@ -167,7 +167,7 @@ OutputIterator res); namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Returns the point on the sphere that is extremal in the \f$ x\f$-direction, and that is the smallest (resp.\ largest) of the two @@ -179,7 +179,7 @@ CGAL::Circular_arc_point_3 x_extremal_point(const CGAL::Sphere_3 & c, bool b); /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Same for a circle. \pre The circle is not contained in a plane orthogonal to the \f$ x\f$-axis. @@ -193,7 +193,7 @@ x_extremal_point(const CGAL::Circle_3 & c, bool b); namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Copies in the output iterator the \f$ x\f$-extremal points of the sphere. `res` iterates on elements of type @@ -205,7 +205,7 @@ x_extremal_points(const CGAL::Sphere_3 & c, OutputIterator res); /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Copies in the output iterator the \f$ x\f$-extremal points of the circle. `res` iterates on elements of type @@ -223,7 +223,7 @@ OutputIterator res); namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Returns the point on the sphere that is extremal in the \f$ y\f$-direction, and that is the smallest (resp.\ largest) of the two @@ -235,7 +235,7 @@ CGAL::Circular_arc_point_3 y_extremal_point(const CGAL::Sphere_3 & c, bool b); /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Same for a circle. \pre The circle is not contained in a plane orthogonal to the \f$ y\f$-axis. @@ -249,7 +249,7 @@ y_extremal_point(const CGAL::Circle_3 & c, bool b); namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Copies in the output iterator the \f$ y\f$-extremal points of the sphere. `res` iterates on elements of type @@ -261,7 +261,7 @@ y_extremal_points(const CGAL::Sphere_3 & c, OutputIterator res); /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Copies in the output iterator the \f$ y\f$-extremal points of the circle. `res` iterates on elements of type @@ -279,7 +279,7 @@ OutputIterator res); namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Returns the point on the sphere that is extremal in the \f$ z\f$-direction, and that is the smallest (resp.\ largest) of the two @@ -291,7 +291,7 @@ CGAL::Circular_arc_point_3 z_extremal_point(const CGAL::Sphere_3 & c, bool b); /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Same for a circle. \pre The circle is not contained in a plane orthogonal to the \f$ z\f$-axis. @@ -305,7 +305,7 @@ z_extremal_point(const CGAL::Circle_3 & c, bool b); namespace CGAL { /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Copies in the output iterator the \f$ z\f$-extremal points of the sphere. `res` iterates on elements of type @@ -317,7 +317,7 @@ z_extremal_points(const CGAL::Sphere_3 & c, OutputIterator res); /*! -\ingroup PkgSphericalKernel3GeometricFunctions +\ingroup PkgCircularKernel3GeometricFunctions Copies in the output iterator the \f$ z\f$-extremal points of the circle. `res` iterates on elements of type diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h index 7ef5402dc3e..cf9c804d733 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept \sa `AlgebraicKernelForSpheres::CompareY` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h index 60cfffab7ed..98b452d668c 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept \sa `AlgebraicKernelForSpheres::CompareX` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h index 92dd9bc52d7..171641cc56e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept \sa `AlgebraicKernelForSpheres::CompareX` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h index 2d8cb30cf48..ff2b9d9ad74 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept \sa `AlgebraicKernelForSpheres::CompareX` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h index 2a2743f67c4..e30f42b9865 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept \sa `AlgebraicKernelForSpheres::CompareX` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h index 73517c1da08..074003ddad0 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept \sa `SphericalKernel::ConstructSphere_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h index 1860c7088d5..66a7c953651 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept \sa `SphericalKernel::ConstructPlane_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h index 766c1fa5833..9743e9eeb6b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept \sa `SphericalKernel::ConstructLine_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h index 9a41be9e609..6021e6ef0fa 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept Concept to represent diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Polynomial_1_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Polynomial_1_3.h index 3d1de1a9e94..9401c645852 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Polynomial_1_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Polynomial_1_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept Concept to represent trivariate polynomials of degree 1 whose diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForCircles_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForCircles_3.h index 1126a869bf9..a06bca51ecc 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForCircles_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForCircles_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept Concept to represent a system of polynomials on `FieldNumberType` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForLines_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForLines_3.h index 11da317d7c8..7f2a474f25e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForLines_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialsForLines_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept Concept to represent a system of polynomials on `FieldNumberType` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h index da3556e3fe8..0e76a7fd05d 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept Concept to represent the roots of a system of three equations of degree 2 diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h index e447c16569e..91a6d0ff7ab 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h index 6c2cab02d7b..b4d8cc88a62 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h index c1ec1bf7e91..449634f1758 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept \sa `AlgebraicKernelForSpheres::YCriticalPoints` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h index 8201c661c4d..225b8d6032c 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept \sa `AlgebraicKernelForSpheres::XCriticalPoints` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h index 68e5e99971f..45ba56ce839 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept \sa `AlgebraicKernelForSpheres::XCriticalPoints` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h index 9d891eed1db..b07d5a7a7c3 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3AlgebraicConcepts +\ingroup PkgCircularKernel3AlgebraicConcepts \cgalConcept The `AlgebraicKernelForSpheres` concept is meant to provide the diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h index 5a427f81ad4..1229ea46042 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \brief diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArcPoint_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArcPoint_3.h index c1727d5ce3b..6cab8d00438 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArcPoint_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArcPoint_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept Concept for points on spheres, circles, circular arcs or line arcs. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArc_3.h index 365d734af94..913e3383742 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CircularArc_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept Concept for arcs of circles. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h index 177382b53d2..27f341e6296 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h index c89f57589bf..07044092c83 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h index f591957d31e..95421dbdf9e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \cgalRefines `Kernel::CompareXYZ_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h index 857a9f1e6ff..99d384efd69 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \brief diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h index 596965a20aa..9f71286a30b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \brief diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h index df7e7ee7c1e..09dfffb0b17 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \brief diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h index d7eabaf9662..bbdf4dda764 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \sa `SphericalKernel::CompareZToRight_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h index afa30a84101..788af2c00a5 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h index 231e08d4e58..3e6726d5bf3 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \cgalRefines `Kernel::CompareZ_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h index 9d1616784fe..b5ffc5fae0d 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h index 10790dfe157..6c7cdd07d11 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \cgalRefines `Kernel::ComputeApproximateSquaredLength_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h index 1066b75b12f..2d52c075a4b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h index cd7832e5945..ffde6e295ba 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ class SphericalKernel::ComputeCircularY_3 { diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h index 980b4fa459a..1c17649edb6 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h index 4b8973145b1..a2e9ee38d3d 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \cgalRefines Kernel::ConstructBbox_3 diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h index 971ee15a6c7..4b3359d8fbe 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \sa `SphericalKernel::GetEquation` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h index 199e8642715..760bc6d7e0b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h index a98395e59ff..44b8c1fa74f 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept The circular arc constructed from a circle, a source, and a target, is diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h index 19a9ed9cdfb..0c4676e8718 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h index ff0685de062..bd57fb767fb 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h index 8bad0d7b5a4..e0d9ef7c0f9 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h index f200f4ef213..c702d99b7dd 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h index 2f9e57de6ba..6f6d37714ef 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h index 76773ae40b1..27f72c8a0c0 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \brief diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h index 1b955bf1428..de3af6123cf 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \brief diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h index ff91610bac5..f6847e012c4 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \brief diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h index 8ec36e83a99..d90877d8b9a 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \brief Testing whether two curves or surfaces intersect. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h index a09666706b3..d74b68decb7 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h index d2ee772abde..6daed207135 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept Testing equality between objects. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h index 4d28619e57e..9cdf8c27ddb 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h index 89edee1e7ba..0f35abc8fa4 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \brief diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h index 01b8fb9b7a1..2bc7a836d1a 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \brief diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h index bf306400dc9..dd48967e7e2 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \cgalRefines `Kernel::HasOn_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Intersect_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Intersect_3.h index e46e60c80dc..ccd903ef013 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Intersect_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Intersect_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \cgalRefines `Kernel::Intersect_3` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h index de3a4f5d298..3727037a315 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--LineArc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--LineArc_3.h index 31dd3bae744..238d4b30d76 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--LineArc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--LineArc_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept Concept for line segments supported by a line that is a model of diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h index fe16e37902f..36cb2e929b9 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h index 64d37b00258..4fb8b3d0238 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h index 531abd4088d..6e76b59bc3a 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgSphericalKernel3GeometricConcepts +\ingroup PkgCircularKernel3GeometricConcepts \cgalConcept \cgalRefines `Kernel` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt b/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt index 5b04d8f987e..26b34fec208 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt +++ b/Circular_kernel_3/doc/Circular_kernel_3/PackageDescription.txt @@ -1,31 +1,31 @@ -/// \defgroup PkgSphericalKernel3 3D Spherical Geometry Kernel Reference +/// \defgroup PkgCircularKernel3Ref 3D Spherical Geometry Kernel Reference -/// \defgroup PkgSphericalKernel3GeometricConcepts Geometric Concepts -/// \ingroup PkgSphericalKernel3 +/// \defgroup PkgCircularKernel3GeometricConcepts Geometric Concepts +/// \ingroup PkgCircularKernel3Ref -/// \defgroup PkgSphericalKernel3GeometricClasses Geometric Kernel and Classes -/// \ingroup PkgSphericalKernel3 +/// \defgroup PkgCircularKernel3GeometricClasses Geometric Kernel and Classes +/// \ingroup PkgCircularKernel3Ref -/// \defgroup PkgSphericalKernel3GeometricFunctions Geometric Global Functions -/// \ingroup PkgSphericalKernel3 +/// \defgroup PkgCircularKernel3GeometricFunctions Geometric Global Functions +/// \ingroup PkgCircularKernel3Ref -/// \defgroup PkgSphericalKernel3AlgebraicConcepts Algebraic Concepts -/// \ingroup PkgSphericalKernel3 +/// \defgroup PkgCircularKernel3AlgebraicConcepts Algebraic Concepts +/// \ingroup PkgCircularKernel3Ref -/// \defgroup PkgSphericalKernel3AlgebraicClasses Algebraic Kernel and Classes -/// \ingroup PkgSphericalKernel3 +/// \defgroup PkgCircularKernel3AlgebraicClasses Algebraic Kernel and Classes +/// \ingroup PkgCircularKernel3Ref /*! -\addtogroup PkgSphericalKernel3 -\cgalPkgDescriptionBegin{3D Spherical Geometry Kernel,PkgSphericalKernel3Summary} +\addtogroup PkgCircularKernel3Ref +\cgalPkgDescriptionBegin{3D Spherical Geometry Kernel,PkgCircularKernel3} \cgalPkgPicture{segment_sphere_intersection_detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Pedro Machado Manhães de Castro, Frédéric Cazals, Sébastien Loriot, and Monique Teillaud} \cgalPkgDesc{This package is an extension of the linear \cgal %Kernel. It offers functionalities on spheres, circles, circular arcs and line segments, in the 3D space or restricted on a reference sphere.} -\cgalPkgManuals{Chapter_3D_Spherical_Geometry_Kernel,PkgSphericalKernel3} +\cgalPkgManuals{Chapter_3D_Spherical_Geometry_Kernel,PkgCircularKernel3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.4} diff --git a/Circulator/doc/Circulator/CGAL/circulator.h b/Circulator/doc/Circulator/CGAL/circulator.h index d081d150af8..7a8cb8551ba 100644 --- a/Circulator/doc/Circulator/CGAL/circulator.h +++ b/Circulator/doc/Circulator/CGAL/circulator.h @@ -295,7 +295,7 @@ template C::size_type circulator_size(C c); namespace CGAL { /*! -\ingroup PkgHandlesAndCirculators +\ingroup PkgHandlesAndCirculatorsRef The circulator traits class distinguishes between circulators and iterators. It defines a local type `category` that is identical to the diff --git a/Circulator/doc/Circulator/PackageDescription.txt b/Circulator/doc/Circulator/PackageDescription.txt index f9141bf7c52..2b781abd240 100644 --- a/Circulator/doc/Circulator/PackageDescription.txt +++ b/Circulator/doc/Circulator/PackageDescription.txt @@ -1,33 +1,33 @@ -/// \defgroup PkgHandlesAndCirculators Handles and Circulators Reference +/// \defgroup PkgHandlesAndCirculatorsRef Handles and Circulators Reference /// \defgroup PkgHandlesAndCirculatorsConcepts Concepts -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /// \defgroup PkgHandlesAndCirculatorsAdapter Adapters for Iterators and Containers -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /// \defgroup PkgHandlesAndCirculatorsFunctions Functions -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /// \defgroup PkgHandlesAndCirculatorsTags Compile Time Tags -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /// \defgroup PkgHandlesAndCirculatorsAssert Assertions -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /// \defgroup PkgHandlesAndCirculatorsBaseClasses Base Classes -/// \ingroup PkgHandlesAndCirculators +/// \ingroup PkgHandlesAndCirculatorsRef /*! -\addtogroup PkgHandlesAndCirculators -\cgalPkgDescriptionBegin{Handles and Circulators,PkgHandlesAndCirculatorsSummary} +\addtogroup PkgHandlesAndCirculatorsRef +\cgalPkgDescriptionBegin{Handles and Circulators,PkgHandlesAndCirculators} \cgalPkgPicture{circulator.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Olivier Devillers, Lutz Kettner, Sylvain Pion, Michael Seel, and Mariette Yvinec} \cgalPkgDesc{This package descibes handles and circulators. They are related to iterators. Handles allow to dereference but neither to increment nor to decrement. Circulators have no notion of past-the-end, and they are used in \cgal whenever we have cyclic stuctures. } -\cgalPkgManuals{Chapter_Handles_Ranges_and_Circulators,PkgHandlesAndCirculators} +\cgalPkgManuals{Chapter_Handles_Ranges_and_Circulators,PkgHandlesAndCirculatorsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} diff --git a/Classification/doc/Classification/PackageDescription.txt b/Classification/doc/Classification/PackageDescription.txt index 28404554d77..b1a3dafe536 100644 --- a/Classification/doc/Classification/PackageDescription.txt +++ b/Classification/doc/Classification/PackageDescription.txt @@ -1,68 +1,68 @@ /*! -\defgroup PkgClassification Classification Reference +\defgroup PkgClassificationRef Classification Reference \defgroup PkgClassificationConcepts Concepts -\ingroup PkgClassification +\ingroup PkgClassificationRef \defgroup PkgClassificationMain Main Functions -\ingroup PkgClassification +\ingroup PkgClassificationRef Functions that perform classification based on a set of labels and a classifier, with or without regularization. \defgroup PkgClassificationClassifiers Classifiers -\ingroup PkgClassification +\ingroup PkgClassificationRef Classifiers are functors that, given a label set and an input item, associate this input item with an energy for each label. This energy measures the likelihood of the item to belong to this label. \defgroup PkgClassificationDataStructures Common Data Structures -\ingroup PkgClassification +\ingroup PkgClassificationRef Useful data structures that are used to compute features (computation of eigenvalues, for example). \defgroup PkgClassificationLabel Label -\ingroup PkgClassification +\ingroup PkgClassificationRef A label represents how an item should be classified, for example: _vegetation_, _building_, _road_, etc. \defgroup PkgClassificationFeature Feature -\ingroup PkgClassification +\ingroup PkgClassificationRef Features are defined as scalar fields that associates each input item with a specific value. \defgroup PkgClassificationFeatures Predefined Features -\ingroup PkgClassification +\ingroup PkgClassificationRef \cgal provides some predefined features that are relevant for classification of point sets. \defgroup PkgClassificationPointSet Point Set Classification -\ingroup PkgClassification +\ingroup PkgClassificationRef Data structures specialized to classify point sets. \defgroup PkgClassificationMesh Mesh Classification -\ingroup PkgClassification +\ingroup PkgClassificationRef Data structures specialized to classify surface meshes. \defgroup PkgClassificationCluster Cluster Classification -\ingroup PkgClassification +\ingroup PkgClassificationRef Data structures specialized to classify clusters. -\addtogroup PkgClassification +\addtogroup PkgClassificationRef -\cgalPkgDescriptionBegin{Classification, PkgClassificationSummary} +\cgalPkgDescriptionBegin{Classification, PkgClassification} \cgalPkgPicture{data_classif.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Simon Giraudot, Florent Lafarge} \cgalPkgDesc{This component implements an algorithm that classifies a data set into a user-defined set of labels (such as ground, vegetation, buildings, etc.). A flexible API is provided so that users can classify any type of data, compute their own local features on the input data set, and define their own labels.} -\cgalPkgManuals{Chapter_Classification, PkgClassification} +\cgalPkgManuals{Chapter_Classification, PkgClassificationRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.12} -\cgalPkgDependsOn{\ref PkgSolverSummary, \ref PkgSpatialSearchingDSummary, [Boost Serialization](http://www.boost.org/libs/serialization) and +\cgalPkgDependsOn{\ref PkgSolverInterface, \ref PkgSpatialSearchingD, [Boost Serialization](http://www.boost.org/libs/serialization) and [Boost IO Streams](http://www.boost.org/libs/iostreams)} \cgalPkgBib{cgal:lm-clscm-12} \cgalPkgLicense{\ref licensesGPL "GPL"} diff --git a/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt b/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt index 9dbdd2feb72..f1c758d89df 100644 --- a/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt +++ b/Combinatorial_map/doc/Combinatorial_map/PackageDescription.txt @@ -1,10 +1,10 @@ -/// \defgroup PkgCombinatorialMaps Combinatorial Maps Reference +/// \defgroup PkgCombinatorialMapsRef Combinatorial Maps Reference /// \defgroup PkgCombinatorialMapsConcepts Concepts -/// \ingroup PkgCombinatorialMaps +/// \ingroup PkgCombinatorialMapsRef /// \defgroup PkgCombinatorialMapsClasses Classes -/// \ingroup PkgCombinatorialMaps +/// \ingroup PkgCombinatorialMapsRef /*! Basic constructions. \code @@ -12,7 +12,7 @@ \endcode */ /// \defgroup PkgCombinatorialMapsConstructions Constructions -/// \ingroup PkgCombinatorialMaps +/// \ingroup PkgCombinatorialMapsRef /*! High-level operations. \code @@ -20,17 +20,17 @@ \endcode */ /// \defgroup PkgCombinatorialMapsOperations Operations -/// \ingroup PkgCombinatorialMaps +/// \ingroup PkgCombinatorialMapsRef /*! -\addtogroup PkgCombinatorialMaps -\cgalPkgDescriptionBegin{Combinatorial Maps,PkgCombinatorialMapsSummary} +\addtogroup PkgCombinatorialMapsRef +\cgalPkgDescriptionBegin{Combinatorial Maps,PkgCombinatorialMaps} \cgalPkgPicture{cmap_logo.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Guillaume Damiand} \cgalPkgDesc{This package implements Combinatorial Maps in d dimensions. A combinatorial map is a data structure enabling to represent an orientable subdivided object by describing all the cells of the subdivision (for example in 3D vertices, edges, faces, volumes) and all the incidence and adjacency relationships between these cells. Information can be associated to cells thanks to attributes. In 2D, a combinatorial map is equivalent to a halfedge data structure. The package provides basic creation, modification operations, and several iterators enabling to run through some specific part of the object.} -\cgalPkgManuals{Chapter_Combinatorial_Maps,PkgCombinatorialMaps} +\cgalPkgManuals{Chapter_Combinatorial_Maps,PkgCombinatorialMapsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.9} diff --git a/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt b/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt index f0258b35140..5833bf7e4ae 100644 --- a/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt +++ b/Cone_spanners_2/doc/Cone_spanners_2/PackageDescription.txt @@ -1,11 +1,11 @@ // PRETTY PACKAGE NAME should equal the project title in Doxyfile.in -/// \defgroup PkgConeBasedSpanners Cone-Based Spanners Reference +/// \defgroup PkgConeSpanners2Ref Cone-Based Spanners Reference /*! -\addtogroup PkgConeBasedSpanners +\addtogroup PkgConeSpanners2Ref -\cgalPkgDescriptionBegin{Cone-Based Spanners,PkgConeBasedSpannersSummary} +\cgalPkgDescriptionBegin{Cone-Based Spanners,PkgConeSpanners2} \cgalPkgPicture{Logo-ConeSpanners.png} \cgalPkgSummaryBegin @@ -20,7 +20,7 @@ value defined in \cgal, which is still accurate enough for most applications. Moreover, for visualization purpose, this package provides a global function to generate the data and script files used by Gnuplot to plot the constructed graphs. This package also provides options for the Half Yao graph and the Half Theta graph.} -\cgalPkgManuals{Chapter_ConeBasedSpanners,PkgConeBasedSpanners} +\cgalPkgManuals{Chapter_ConeBasedSpanners,PkgConeSpanners2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin 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 19b61beaf66..8ef3ada4897 100644 --- a/Cone_spanners_2/include/CGAL/Compute_cone_boundaries_2.h +++ b/Cone_spanners_2/include/CGAL/Compute_cone_boundaries_2.h @@ -44,7 +44,7 @@ namespace CGAL { -/*! \ingroup PkgConeBasedSpanners +/*! \ingroup PkgConeSpanners2Ref * * \brief The functor for computing the directions of cone boundaries with a given * cone number and a given initial direction. diff --git a/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h b/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h index 7f7832bfd43..ca9957a2112 100644 --- a/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h +++ b/Cone_spanners_2/include/CGAL/Cone_spanners_enum_2.h @@ -31,7 +31,7 @@ namespace CGAL { - /*! \ingroup PkgConeBasedSpanners + /*! \ingroup PkgConeSpanners2Ref \brief An enum of the choice of cones in cone spanners. */ 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 156d5b3e151..8bca1174f6a 100644 --- a/Cone_spanners_2/include/CGAL/Construct_theta_graph_2.h +++ b/Cone_spanners_2/include/CGAL/Construct_theta_graph_2.h @@ -45,7 +45,7 @@ namespace CGAL { -/*! \ingroup PkgConeBasedSpanners +/*! \ingroup PkgConeSpanners2Ref \brief A template functor for constructing Theta graphs with a given set of 2D points and a given initial direction for the cone boundaries. 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 621ce9011a6..8efbc4d921a 100644 --- a/Cone_spanners_2/include/CGAL/Construct_yao_graph_2.h +++ b/Cone_spanners_2/include/CGAL/Construct_yao_graph_2.h @@ -42,7 +42,7 @@ namespace CGAL { -/*! \ingroup PkgConeBasedSpanners +/*! \ingroup PkgConeSpanners2Ref \brief A template functor for constructing Yao graphs with a given set of 2D points and a given initial direction for the cone boundaries. diff --git a/Cone_spanners_2/include/CGAL/gnuplot_output_2.h b/Cone_spanners_2/include/CGAL/gnuplot_output_2.h index 95ec96f016b..d4fecddc892 100644 --- a/Cone_spanners_2/include/CGAL/gnuplot_output_2.h +++ b/Cone_spanners_2/include/CGAL/gnuplot_output_2.h @@ -46,7 +46,7 @@ namespace CGAL { /* ------ Declarations go first, then implementations follow. ------ */ /*! -* \ingroup PkgConeBasedSpanners +* \ingroup PkgConeSpanners2Ref * \brief Output a set of files used by Gnuplot to plot `g`. * * The files that are generated for Gnuplot are: diff --git a/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt b/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt index e572fe2a1be..19c85a1d7f5 100644 --- a/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt +++ b/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt @@ -1,13 +1,13 @@ -/// \defgroup PkgConvexDecomposition3 Convex Decomposition of Polyhedra Reference +/// \defgroup PkgConvexDecomposition3Ref Convex Decomposition of Polyhedra Reference /*! -\addtogroup PkgConvexDecomposition3 -\cgalPkgDescriptionBegin{Convex Decomposition of Polyhedra,PkgConvexDecomposition3Summary} +\addtogroup PkgConvexDecomposition3Ref +\cgalPkgDescriptionBegin{Convex Decomposition of Polyhedra,PkgConvexDecomposition3} \cgalPkgPicture{Convex_decomposition_3/fig/Convex_decomposition_3-teaser.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Peter Hachenberger} \cgalPkgDesc{This packages provides a function for decomposing a bounded polyhedron into convex sub-polyhedra. The decomposition yields \f$ O(r^2)\f$ convex pieces, where \f$ r\f$ is the number of edges, whose adjacent facets form an angle of more than 180 degrees with respect to the polyhedron's interior. This bound is worst-case optimal. } -\cgalPkgManuals{Chapter_Convex_Decomposition_of_Polyhedra,PkgConvexDecomposition3} +\cgalPkgManuals{Chapter_Convex_Decomposition_of_Polyhedra,PkgConvexDecomposition3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.5} diff --git a/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h b/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h index f232603ff8f..45ae44ca0f7 100644 --- a/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h +++ b/Convex_decomposition_3/include/CGAL/convex_decomposition_3.h @@ -44,7 +44,7 @@ namespace CGAL { /*! -\ingroup PkgConvexDecomposition3 +\ingroup PkgConvexDecomposition3Ref The function `convex_decomposition_3()` inserts additional facets into the given `Nef_polyhedron_3` `N`, such that each bounded diff --git a/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt b/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt index e27762884c3..8ccbfaa6dfa 100644 --- a/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt +++ b/Convex_hull_2/doc/Convex_hull_2/PackageDescription.txt @@ -1,32 +1,32 @@ -/// \defgroup PkgConvexHull2 2D Convex Hulls and Extreme Points Reference +/// \defgroup PkgConvexHull2Ref 2D Convex Hulls and Extreme Points Reference /// \defgroup PkgConvexHull2Concepts Concepts -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /// \defgroup PkgConvexHull2Traits Traits Classes -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /// \defgroup PkgConvexHull2Functions Convex Hull Functions -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /// \defgroup PkgConvexHull2Convexity Convexity Checking -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /// \defgroup PkgConvexHull2Subsequence Hull Subsequence Functions -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /// \defgroup PkgConvexHull2Extreme Extreme Point Functions -/// \ingroup PkgConvexHull2 +/// \ingroup PkgConvexHull2Ref /*! -\addtogroup PkgConvexHull2 +\addtogroup PkgConvexHull2Ref -\cgalPkgDescriptionBegin{2D Convex Hulls and Extreme Points,PkgConvexHull2Summary} +\cgalPkgDescriptionBegin{2D Convex Hulls and Extreme Points,PkgConvexHull2} \cgalPkgPicture{Convex_hull_2/fig/convex_hull.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Susan Hert and Stefan Schirra} \cgalPkgDesc{This package provides functions for computing convex hulls in two dimensions as well as functions for checking if sets of points are strongly convex are not. There are also a number of functions described for computing particular extreme points and subsequences of hull points, such as the lower and upper hull of a set of points.} -\cgalPkgManuals{Chapter_2D_Convex_Hulls_and_Extreme_Points,PkgConvexHull2} +\cgalPkgManuals{Chapter_2D_Convex_Hulls_and_Extreme_Points,PkgConvexHull2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} diff --git a/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt b/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt index 9f0636fa1e3..1c808b0fdc0 100644 --- a/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt +++ b/Convex_hull_3/doc/Convex_hull_3/PackageDescription.txt @@ -1,13 +1,13 @@ -/// \defgroup PkgConvexHull3 3D Convex Hulls Reference +/// \defgroup PkgConvexHull3Ref 3D Convex Hulls Reference /// \defgroup PkgConvexHull3Concepts Concepts -/// \ingroup PkgConvexHull3 +/// \ingroup PkgConvexHull3Ref /// \defgroup PkgConvexHull3Traits Traits Classes -/// \ingroup PkgConvexHull3 +/// \ingroup PkgConvexHull3Ref /*! \defgroup PkgConvexHull3Functions Convex Hull Functions - \ingroup PkgConvexHull3 + \ingroup PkgConvexHull3Ref The function `convex_hull_3()` computes the convex hull of a given set of three-dimensional points. @@ -17,22 +17,22 @@ degenerate hull may also be possible. */ /// \defgroup PkgConvexityChecking Convexity Checking -/// \ingroup PkgConvexHull3 +/// \ingroup PkgConvexHull3Ref /*! -\addtogroup PkgConvexHull3 +\addtogroup PkgConvexHull3Ref \todo fix or keep the `Default_traits` -\cgalPkgDescriptionBegin{3D Convex Hulls,PkgConvexHull3Summary} +\cgalPkgDescriptionBegin{3D Convex Hulls,PkgConvexHull3} \cgalPkgPicture{Convex_hull_3/fig/bunny.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Susan Hert and Stefan Schirra} \cgalPkgDesc{This package provides functions for computing convex hulls in three dimensions as well as functions for checking if sets of points are strongly convex or not. One can compute the convex hull of a set of points in three dimensions in two ways: using a static algorithm or using a triangulation to get a fully dynamic computation.} -\cgalPkgManuals{Chapter_3D_Convex_Hulls,PkgConvexHull3} +\cgalPkgManuals{Chapter_3D_Convex_Hulls,PkgConvexHull3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.1} -\cgalPkgDependsOn{The dynamic algorithms depend on \ref PkgTriangulation3Summary "3D Triangulations".} +\cgalPkgDependsOn{The dynamic algorithms depend on \ref PkgTriangulation3 "3D Triangulations".} \cgalPkgBib{cgal:hs-ch3} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{Polyhedron demo,polyhedron_3.zip} diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h index ec21aaa1d83..c14515a6e9a 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h @@ -1,9 +1,9 @@ namespace CGAL { /*! -\ingroup PkgConvexHullD +\ingroup PkgConvexHullDRef -\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. +\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead. An instance `C` of type `Convex_hull_d` is the convex hull of a multi-set `S` of points in \f$ d\f$-dimensional space. We call diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_to_polyhedron_3.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_to_polyhedron_3.h index 13d0c98dfd9..9f7775b2157 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_to_polyhedron_3.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_to_polyhedron_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. +\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead. converts the convex hull `C` to polyhedral surface stored in `P`. @@ -13,7 +13,7 @@ template void convex_hull_d_to_polyhedron_3( const Convex_hull_d& C, Polyhedron_3& P) ; /*! -\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead +\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead constructs the representation of the surface of `C` as a bidirected LEDA graph `G`. diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h index 3719f9fc270..694105e5729 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h @@ -1,9 +1,9 @@ namespace CGAL { /*! -\ingroup PkgConvexHullD +\ingroup PkgConvexHullDRef -\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. +\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead. diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h index eb83d360fb8..21e2d14953d 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h @@ -1,9 +1,9 @@ namespace CGAL { /*! -\ingroup PkgConvexHullD +\ingroup PkgConvexHullDRef -\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. +\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead. An instance `DT` of type `Delaunay_d< R, Lifted_R >` is the nearest and furthest site Delaunay triangulation of a set `S` of diff --git a/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h b/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h index a5b30b4e9cb..3be7fa3ddbb 100644 --- a/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h @@ -2,7 +2,7 @@ \ingroup PkgConvexHullDConcepts \cgalConcept -\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. +\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead. Requirements of the traits class to be used with the class `CGAL::Convex_hull_d`. diff --git a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h index d6211139b40..047dcdd09b1 100644 --- a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h @@ -2,7 +2,7 @@ \ingroup PkgConvexHullDConcepts \cgalConcept -\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. +\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead. Requirements of the second traits class to be used with the class `CGAL::Delaunay_d`. diff --git a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h index 868aa546169..3857c62ba55 100644 --- a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h @@ -2,7 +2,7 @@ \ingroup PkgConvexHullDConcepts \cgalConcept -\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. +\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead. Requirements of the first traits class to be used with the class `CGAL::Delaunay_d`. diff --git a/Convex_hull_d/doc/Convex_hull_d/Convex_hull_d.txt b/Convex_hull_d/doc/Convex_hull_d/Convex_hull_d.txt index 1f31fff9b19..07f98db9fc6 100644 --- a/Convex_hull_d/doc/Convex_hull_d/Convex_hull_d.txt +++ b/Convex_hull_d/doc/Convex_hull_d/Convex_hull_d.txt @@ -7,7 +7,7 @@ namespace CGAL { \anchor chapconvexhulld \authors Susan Hert and Michael Seel -\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. +\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead. \section Convex_hull_dIntroduction Introduction diff --git a/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt b/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt index b0a8e105d97..86ce0ec9281 100644 --- a/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt +++ b/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgConvexHullD dD Convex Hulls and Delaunay Triangulations Reference +/// \defgroup PkgConvexHullDRef dD Convex Hulls and Delaunay Triangulations Reference /// \defgroup PkgConvexHullDConcepts Concepts -/// \ingroup PkgConvexHullD +/// \ingroup PkgConvexHullDRef /*! -\addtogroup PkgConvexHullD +\addtogroup PkgConvexHullDRef \todo check generated documentation -\cgalPkgDescriptionBegin{dD Convex Hulls and Delaunay Triangulations,PkgConvexHullDSummary} +\cgalPkgDescriptionBegin{dD Convex Hulls and Delaunay Triangulations,PkgConvexHullD} \cgalPkgPicture{convex_hull_d-teaser.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Susan Hert and Michael Seel} \cgalPkgDesc{This package provides functions for computing convex hulls and Delaunay triangulations in \f$ d\f$-dimensional Euclidean space.} -\cgalPkgManuals{Chapter_dD_Convex_Hulls_and_Delaunay_Triangulations,PkgConvexHullD} +\cgalPkgManuals{Chapter_dD_Convex_Hulls_and_Delaunay_Triangulations,PkgConvexHullDRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.3} @@ -18,7 +18,7 @@ \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd -\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. +\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead. A subset \f$ S \subseteq \mathbb{R}^d\f$ is convex if for any two points \f$ p\f$ and \f$ q\f$ in the set the line segment with endpoints \f$ p\f$ and \f$ q\f$ is contained diff --git a/Documentation/doc/Documentation/Developer_manual/Chapter_iterators_and_circulators.txt b/Documentation/doc/Documentation/Developer_manual/Chapter_iterators_and_circulators.txt index 900eda9aa58..d1407672ac5 100644 --- a/Documentation/doc/Documentation/Developer_manual/Chapter_iterators_and_circulators.txt +++ b/Documentation/doc/Documentation/Developer_manual/Chapter_iterators_and_circulators.txt @@ -19,15 +19,15 @@ Iterators are widely used in \cgal too. \cgal extends the idea of the iterator, which works for linear data structures, to circular data structures by defining the concept of a circulator. -\ref PkgHandlesAndCirculatorsSummary "Circulators" are quite similar to iterators, with the +\ref PkgHandlesAndCirculators "Circulators" are quite similar to iterators, with the major difference being the absence of a past-the-end position in a sequence. Note that circulators are NOT part of the \stl, but of \cgal. -In \cgal, we also define the concept of \ref PkgHandlesAndCirculatorsSummary "handle", +In \cgal, we also define the concept of \ref PkgHandlesAndCirculators "handle", which behaves roughly like a pointer to an object without an increment or decrement operation. More details about handles and their requirements can be found in -the \ref PkgHandlesAndCirculatorsSummary "chapter Circulators and Handles" +the \ref PkgHandlesAndCirculators "chapter Circulators and Handles" of the Support Library part of \cgal manual. Section \ref sechandle_vs_it_vs_circ below discusses when handles should be used in your code. @@ -35,7 +35,7 @@ should be used in your code. The concepts of iterators is relatively well described in textbooks such as Stroustrup's book (The C++ Programming Language \cgalCite{cgal:s-cpl-97}) and Austern's book (Generic Programming and the \stl \cgalCite{cgal:a-gps-98}) -and in chapter \ref PkgHandlesAndCirculatorsSummary "Handles and Circulators" +and in chapter \ref PkgHandlesAndCirculators "Handles and Circulators" of the Support Library part of the \cgal manual. which also presents the concepts of handles and circulators. Thus we will not give a full description of these concept here @@ -325,7 +325,7 @@ over either a linear or circular sequence: - `CGAL_For_all( ic1, ic2)` - `CGAL_For_all_backwards( ic1, ic2)`. -See the chapter \ref PkgHandlesAndCirculatorsSummary "Handles and Circulators" +See the chapter \ref PkgHandlesAndCirculators "Handles and Circulators" in the Support Library part of \cgal manual for more information and examples. diff --git a/Documentation/doc/Documentation/Installation.txt b/Documentation/doc/Documentation/Installation.txt index 20354fe18c6..b5ba993f4f5 100644 --- a/Documentation/doc/Documentation/Installation.txt +++ b/Documentation/doc/Documentation/Installation.txt @@ -356,7 +356,7 @@ header-only. \subsubsection subsection_headeronly_pbonwindows Possible Problem on Windows -There is one possible problem when using \cgal in header-only mode on a Windows operating system when compiling a program using several modules (executable programs or dynamic-link libraries DLL). If two different modules use the same static variable, this variable is defined independently in each of these modules. If one module modifies the value of this variable, it will not be modified in the other module, which could induce an unexpected behavior. In \cgal, this concerns only a few specific variables: the default random, the failure behavior, IO mode. One example is the following: if you change the default random in one DLL, then if you use the default random in another DLL, you will not obtain the modified default random but the original one. +There is one possible problem when using \cgal in header-only mode on a Windows operating system when compiling a program using several modules (executable programs or dynamic-link libraries DLL). If two different modules use the same static variable, this variable is defined independently in each of these modules. If one module modifies the value of this variable, it will not be modified in the other module, which could induce an unexpected behavior. In \cgal, this concerns only a few specific variables: the default random, the failure behavior, IO mode. One example is the following: if you change the default random in one DLL, then if you use the default random in another DLL, you will not obtain the modified default random but the original one. \section secessential3rdpartysoftware Essential Third Party Libraries @@ -439,7 +439,7 @@ of \sc{Gmp} and \sc{Mpfr}, which can be downloaded with the installer \sc{zlib} is a data compression library, and is essential for the component libCGAL_ImageIO. -In \cgal this library is used in the examples of the \ref PkgSurfaceMesher3 package. +In \cgal this library is used in the examples of the \ref PkgSurfaceMesher3Ref package. If it is not already on your system, for instance, on Windows, you can download it from `http://www.zlib.net/`. @@ -511,7 +511,7 @@ represented using \sc{Mpfr} reliable floating-point numbers. It is based on the libraries \sc{Gmp} and \sc{Mpfr}. In the setting of \cgal, this library is optional: it is used by some models of the -\ref PkgAlgebraicKerneld "Algebraic Kernel". +\ref PkgAlgebraicKernelDRef "Algebraic Kernel". \sc{Mpfi} can be downloaded from `http://mpfi.gforge.inria.fr/`. Version 1.4 or higher is recommended. @@ -520,7 +520,7 @@ optional: it is used by some models of the \sc{Rs} (Real Solutions) is devoted to the study of the real roots of polynomial systems with a finite number of complex roots (including univariate polynomials). In \cgal, \sc{Rs} is used by one model of the -\ref PkgAlgebraicKerneld "Algebraic Kernel". +\ref PkgAlgebraicKernelDRef "Algebraic Kernel". \sc{Rs} is freely distributable for non-commercial use. You can download it from `http://vegas.loria.fr/rs/`. Actually, the \sc{Rs} package also includes \sc{Rs3}, the @@ -543,11 +543,11 @@ to speed up operations of the Polynomial package, such as GCDs. It is recommende \sc{Eigen} is a `C++` template library for linear algebra. \sc{Eigen} supports all matrix sizes, various matrix decomposition methods and sparse linear solvers. -In \cgal, \sc{Eigen} provides sparse linear solvers in the \ref PkgPoissonSurfaceReconstruction -and the \ref PkgSurfaceParameterization packages. +In \cgal, \sc{Eigen} provides sparse linear solvers in the \ref PkgPoissonSurfaceReconstruction3Ref +and the \ref PkgSurfaceMeshParameterizationRef packages. -In addition, \sc{Eigen} also provides singular value decomposition for the \ref PkgJet_fitting_3 -and the \ref PkgRidges_3 packages. +In addition, \sc{Eigen} also provides singular value decomposition for the \ref PkgJetFitting3Ref +and the \ref PkgRidges3Ref packages. The \sc{Eigen} web site is `http://eigen.tuxfamily.org`. @@ -557,7 +557,7 @@ The \sc{Esbtl} (Easy Structural Biology Template Library) is a library that allo the handling of \sc{Pdb} data. In \cgal the \sc{Esbtl} is used in an example of the -\ref PkgSkinSurface3 package. +\ref PkgSkinSurface3Ref package. It can be downloaded from `http://esbtl.sourceforge.net/`. @@ -576,7 +576,7 @@ The \sc{Tbb} web site is `http: the LAS format (or the compressed LAZ format). In \cgal, \sc{LASlib} is used to provide input and output functions in -the \ref PkgPointSetProcessing package. +the \ref PkgPointSetProcessing3Ref package. The \sc{LASlib} web site is `https://rapidlasso.com/lastools/`. \sc{LASlib} @@ -589,7 +589,7 @@ CMake based install procedure. \sc{OpenCV} (Open Computer Vision) is a library designed for computer vision, computer graphics and machine learning. -In \cgal, \sc{OpenCV} is used by the \ref PkgClassification package. +In \cgal, \sc{OpenCV} is used by the \ref PkgClassificationRef package. The \sc{OpenCV} web site is `http://opencv.org/`. @@ -601,7 +601,7 @@ and designed to partition graphs and produce fill-reducing matrix orderings. \cgal offers wrappers around some of the methods of the \sc{METIS} library to allow the partitioning of graphs that are models of the concepts of the Boost Graph Library, -and, by extension, of surface meshes (see Section \ref BGLPartitioning of the package \ref PkgBGLSummary). +and, by extension, of surface meshes (see Section \ref BGLPartitioning of the package \ref PkgBGL). More information is available on the METIS library at `http://glaros.dtc.umn.edu/gkhome/metis/metis/overview`. diff --git a/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt b/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt index 99b6ca99c44..e90944007da 100644 --- a/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt +++ b/Documentation/doc/Documentation/Tutorials/Tutorial_hello_world.txt @@ -318,7 +318,7 @@ This function only compiles if the `operator<(..)` is defined for the type used and we say that the type must be a model of `LessThanComparable`. An example for a concept with required free functions is the `HalfedgeListGraph` in the -\cgal package \ref PkgBGLSummary. In order to be a model of `HalfedgeListGraph` a class `G` +\cgal package \ref PkgBGL. In order to be a model of `HalfedgeListGraph` a class `G` there must be a global function `halfedges(const G&)`, etc. An example for a concept with a required traits class is `InputIterator`. diff --git a/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h b/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h index 5458eeee9f3..8bc3b12b7e4 100644 --- a/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h +++ b/Envelope_2/doc/Envelope_2/CGAL/Envelope_diagram_1.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope2 +\ingroup PkgEnvelope2Ref This class is the default envelope-diagram class used by envelope functions to represent the minimization or the maximization diagram of a set of curves. diff --git a/Envelope_2/doc/Envelope_2/CGAL/envelope_2.h b/Envelope_2/doc/Envelope_2/CGAL/envelope_2.h index b6c9172ef2e..d45a0463b5f 100644 --- a/Envelope_2/doc/Envelope_2/CGAL/envelope_2.h +++ b/Envelope_2/doc/Envelope_2/CGAL/envelope_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope2 +\ingroup PkgEnvelope2Ref Computes the lower envelope of a set of curves in \f$ \mathbb{R}^2\f$, as given by the range `[begin, end)`. The lower envelope is @@ -19,7 +19,7 @@ EnvelopeDiagram& diag); namespace CGAL { /*! -\ingroup PkgEnvelope2 +\ingroup PkgEnvelope2Ref Computes the lower envelope of a set of \f$ x\f$-monotone curves in \f$ \mathbb{R}^2\f$, as given by the range `[begin, end)`. The lower @@ -38,7 +38,7 @@ EnvelopeDiagram& diag); namespace CGAL { /*! -\ingroup PkgEnvelope2 +\ingroup PkgEnvelope2Ref Computes the upper envelope of a set of curves in \f$ \mathbb{R}^2\f$, as given by the range `[begin, end)`. The upper envelope is @@ -56,7 +56,7 @@ EnvelopeDiagram& diag); namespace CGAL { /*! -\ingroup PkgEnvelope2 +\ingroup PkgEnvelope2Ref Computes the upper envelope of a set of \f$ x\f$-monotone curves in \f$ \mathbb{R}^2\f$, as given by the range `[begin, end)`. The upper diff --git a/Envelope_2/doc/Envelope_2/PackageDescription.txt b/Envelope_2/doc/Envelope_2/PackageDescription.txt index 23f43104d00..c5f8b125e8b 100644 --- a/Envelope_2/doc/Envelope_2/PackageDescription.txt +++ b/Envelope_2/doc/Envelope_2/PackageDescription.txt @@ -1,19 +1,19 @@ -/// \defgroup PkgEnvelope2 2D Envelopes Reference +/// \defgroup PkgEnvelope2Ref 2D Envelopes Reference /// \defgroup PkgEnvelope2Concepts Concepts -/// \ingroup PkgEnvelope2 +/// \ingroup PkgEnvelope2Ref /*! -\addtogroup PkgEnvelope2 +\addtogroup PkgEnvelope2Ref \todo check generated documentation -\cgalPkgDescriptionBegin{2D Envelopes,PkgEnvelope2Summary} +\cgalPkgDescriptionBegin{2D Envelopes,PkgEnvelope2} \cgalPkgPicture{Envelope_2/fig/Envelope_2.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Ron Wein} \cgalPkgDesc{This package consits of functions that computes the lower (or upper) envelope of a set of arbitrary curves in 2D. The output is represented as an envelope diagram, namely a subdivision of the \f$ x\f$-axis into intervals, such that the identity of the curves that induce the envelope on each interval is unique.} -\cgalPkgManuals{Chapter_Envelopes_of_Curves_in_2D,PkgEnvelope2} +\cgalPkgManuals{Chapter_Envelopes_of_Curves_in_2D,PkgEnvelope2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} -\cgalPkgDependsOn{\ref PkgArrangement2Summary} +\cgalPkgDependsOn{\ref PkgArrangementOnSurface2} \cgalPkgBib{cgal:w-e2} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgShortInfoEnd diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h index 47c5254d1db..c1a839a38be 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_plane_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref The traits class `Env_plane_traits_3` models the `EnvelopeTraits_3` concept, and is used for the construction of lower and upper envelopes of planes diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h index faffe652e84..157ad738d8f 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_sphere_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref The traits class `Env_sphere_traits_3` models the `EnvelopeTraits_3` concept, and is used for the construction of lower and upper envelopes diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h index 30dbf206ca1..9c8fbdec403 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref The class `Env_surface_data_traits_3` is a model of the `EnvelopeTraits_3` concept and serves as a decorator class that allows the extension of the surfaces diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h index 0043b162c32..87ade2cb2ff 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_triangle_traits_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref The traits class `Env_triangle_traits_3` models the `EnvelopeTraits_3` concept, and is used for the construction of lower and upper envelopes diff --git a/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h b/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h index d5c6b319111..d281cdb698d 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref The class-template `Envelope_diagram_2` represents the minimization diagram that corresponds to the lower envelope of a set of curves, or the @@ -165,7 +165,7 @@ Envelope_diagram_2 (EnvTraits *traits); namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref Computes the lower envelope of a set of surfaces in \f$ \mathbb{R}^3\f$, as given by the range `[begin, end)`. The lower envelope is @@ -182,7 +182,7 @@ Envelope_diagram_2& diag); namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref Computes the lower envelope of a set of \f$ xy\f$-monotone surfaces in \f$ \mathbb{R}^3\f$, as given by the range `[begin, end)`. The lower @@ -199,7 +199,7 @@ Envelope_diagram_2& diag); namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref Computes the upper envelope of a set of surfaces in \f$ \mathbb{R}^3\f$, as given by the range `[begin, end)`. The upper envelope is @@ -216,7 +216,7 @@ Envelope_diagram_2& diag); namespace CGAL { /*! -\ingroup PkgEnvelope3 +\ingroup PkgEnvelope3Ref Computes the upper envelope of a set of \f$ xy\f$-monotone surfaces in \f$ \mathbb{R}^3\f$, as given by the range `[begin, end)`. The lower diff --git a/Envelope_3/doc/Envelope_3/PackageDescription.txt b/Envelope_3/doc/Envelope_3/PackageDescription.txt index afbadf2eaf2..b20188b1d1d 100644 --- a/Envelope_3/doc/Envelope_3/PackageDescription.txt +++ b/Envelope_3/doc/Envelope_3/PackageDescription.txt @@ -1,19 +1,19 @@ -/// \defgroup PkgEnvelope3 3D Envelopes Reference +/// \defgroup PkgEnvelope3Ref 3D Envelopes Reference /// \defgroup PkgEnvelope3Concepts Concepts -/// \ingroup PkgEnvelope3 +/// \ingroup PkgEnvelope3Ref /*! -\addtogroup PkgEnvelope3 +\addtogroup PkgEnvelope3Ref \todo check generated documentation -\cgalPkgDescriptionBegin{3D Envelopes,PkgEnvelope3Summary} +\cgalPkgDescriptionBegin{3D Envelopes,PkgEnvelope3} \cgalPkgPicture{Envelope_3/fig/Envelope_3.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Dan Halperin, Michal Meyerovitch, Ron Wein, and Baruch Zukerman} \cgalPkgDesc{This package consits of functions that compute the lower (or upper) envelope of a set of arbitrary surfaces in 3D. The output is represented as an 2D envelope diagram, namely a planar subdivision such that the identity of the surfaces that induce the envelope over each diagram cell is unique.} -\cgalPkgManuals{Chapter_Envelopes_of_Surfaces_in_3D,PkgEnvelope3} +\cgalPkgManuals{Chapter_Envelopes_of_Surfaces_in_3D,PkgEnvelope3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} -\cgalPkgDependsOn{\ref PkgArrangement2Summary} +\cgalPkgDependsOn{\ref PkgArrangementOnSurface2} \cgalPkgBib{cgal:mwz-e3} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{3D Envelopes,envelope_3.zip,L1 Voronoi Diagram,l1_voronoi_diagram_2.zip} diff --git a/Generalized_map/doc/Generalized_map/PackageDescription.txt b/Generalized_map/doc/Generalized_map/PackageDescription.txt index acbdf16ff7e..642f145a29a 100644 --- a/Generalized_map/doc/Generalized_map/PackageDescription.txt +++ b/Generalized_map/doc/Generalized_map/PackageDescription.txt @@ -1,19 +1,19 @@ -/// \defgroup PkgGeneralizedMaps Generalized Maps Reference +/// \defgroup PkgGeneralizedMapsRef Generalized Maps Reference /// \defgroup PkgGeneralizedMapsConcepts Concepts -/// \ingroup PkgGeneralizedMaps +/// \ingroup PkgGeneralizedMapsRef /// \defgroup PkgGeneralizedMapsClasses Classes -/// \ingroup PkgGeneralizedMaps +/// \ingroup PkgGeneralizedMapsRef /*! -\addtogroup PkgGeneralizedMaps -\cgalPkgDescriptionBegin{Generalized Maps,PkgGeneralizedMapsSummary} +\addtogroup PkgGeneralizedMapsRef +\cgalPkgDescriptionBegin{Generalized Maps,PkgGeneralizedMaps} \cgalPkgPicture{gmap_logo.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Guillaume Damiand} \cgalPkgDesc{This package implements Generalized Maps in d dimensions. A generalized map is a data structure enabling to represent an orientable or non orientable subdivided object by describing all the cells of the subdivision (for example in 3D vertices, edges, faces, volumes) and all the incidence and adjacency relationships between these cells. Information can be associated to cells thanks to attributes. The package provides basic creation, modification operations, and several iterators enabling to run through some specific part of the object.} -\cgalPkgManuals{Chapter_Generalized_Maps,PkgGeneralizedMaps} +\cgalPkgManuals{Chapter_Generalized_Maps,PkgGeneralizedMapsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.9} diff --git a/Generator/doc/Generator/CGAL/Combination_enumerator.h b/Generator/doc/Generator/CGAL/Combination_enumerator.h index 80a57e20784..5e1873882c0 100644 --- a/Generator/doc/Generator/CGAL/Combination_enumerator.h +++ b/Generator/doc/Generator/CGAL/Combination_enumerator.h @@ -1,6 +1,6 @@ namespace CGAL { -/// \addtogroup PkgGenerators +/// \addtogroup PkgGeneratorsRef /// @{ /*! diff --git a/Generator/doc/Generator/CGAL/Random.h b/Generator/doc/Generator/CGAL/Random.h index ead823642c6..653aa3240ca 100644 --- a/Generator/doc/Generator/CGAL/Random.h +++ b/Generator/doc/Generator/CGAL/Random.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef The class `Random` is a random numbers generator. It generates uniformly distributed random `bool`, `int` and `double`. It can be used as the random number generating function object in the @@ -180,7 +180,7 @@ bool operator == ( Random const& random2) const; }; /* end Random */ /*! - \ingroup PkgGenerators + \ingroup PkgGeneratorsRef The global function `get_default_random()` returns the default random numbers generator used for the generator functions and classes. The returned generator is thread local. @@ -188,7 +188,7 @@ bool operator == ( Random const& random2) const; Random &get_default_random(); /*! - \ingroup PkgGenerators + \ingroup PkgGeneratorsRef \deprecated The variable `default_random` was the default random numbers generator used for the generator functions and classes. Deprecated. Use `get_default_random()` instead. diff --git a/Generator/doc/Generator/CGAL/point_generators_2.h b/Generator/doc/Generator/CGAL/point_generators_2.h index 449f0444a20..4db77fafc06 100644 --- a/Generator/doc/Generator/CGAL/point_generators_2.h +++ b/Generator/doc/Generator/CGAL/point_generators_2.h @@ -1,6 +1,6 @@ namespace CGAL { -/// \addtogroup PkgGenerators +/// \addtogroup PkgGeneratorsRef /// @{ /*! diff --git a/Generator/doc/Generator/CGAL/point_generators_3.h b/Generator/doc/Generator/CGAL/point_generators_3.h index 631637941df..cb87e09ed95 100644 --- a/Generator/doc/Generator/CGAL/point_generators_3.h +++ b/Generator/doc/Generator/CGAL/point_generators_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef \brief generates a given number of points on a cubic grid whose size is determined by the number of points to be generated. diff --git a/Generator/doc/Generator/CGAL/point_generators_d.h b/Generator/doc/Generator/CGAL/point_generators_d.h index aa103faaa8b..b064051adac 100644 --- a/Generator/doc/Generator/CGAL/point_generators_d.h +++ b/Generator/doc/Generator/CGAL/point_generators_d.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef generates a given number of points on a cubic grid in any dimension whose size is determined by the number of points to be generated. diff --git a/Generator/doc/Generator/CGAL/random_convex_hull_in_disc_2.h b/Generator/doc/Generator/CGAL/random_convex_hull_in_disc_2.h index 3fd55c14b06..3800a0f7491 100644 --- a/Generator/doc/Generator/CGAL/random_convex_hull_in_disc_2.h +++ b/Generator/doc/Generator/CGAL/random_convex_hull_in_disc_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef \brief Computes a random convex polygon as the convex hull of \f$ n \f$ random points in a disc centered at the origin with radius `radius`. diff --git a/Generator/doc/Generator/CGAL/random_convex_set_2.h b/Generator/doc/Generator/CGAL/random_convex_set_2.h index 750bc06592d..dea39b97031 100644 --- a/Generator/doc/Generator/CGAL/random_convex_set_2.h +++ b/Generator/doc/Generator/CGAL/random_convex_set_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef \brief computes a random convex planar point set of given size where the points are drawn from a specific domain. diff --git a/Generator/doc/Generator/CGAL/random_polygon_2.h b/Generator/doc/Generator/CGAL/random_polygon_2.h index 1cb14cd4fdd..be9c8766f4b 100644 --- a/Generator/doc/Generator/CGAL/random_polygon_2.h +++ b/Generator/doc/Generator/CGAL/random_polygon_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef \brief computes a random simple polygon by writing its vertices (oriented counterclockwise) to `result`. The polygon generated will have a number diff --git a/Generator/doc/Generator/CGAL/random_selection.h b/Generator/doc/Generator/CGAL/random_selection.h index 173008e7fa4..b1460b86816 100644 --- a/Generator/doc/Generator/CGAL/random_selection.h +++ b/Generator/doc/Generator/CGAL/random_selection.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgGenerators +\ingroup PkgGeneratorsRef \brief chooses `n` items at random from a random access iterator range which is useful to produce degenerate input data sets with multiple entries of identical items. diff --git a/Generator/doc/Generator/PackageDescription.txt b/Generator/doc/Generator/PackageDescription.txt index 2596c89d39d..f9e3f2f935a 100644 --- a/Generator/doc/Generator/PackageDescription.txt +++ b/Generator/doc/Generator/PackageDescription.txt @@ -1,14 +1,14 @@ -/// \defgroup PkgGenerators Geometric Object Generators Reference +/// \defgroup PkgGeneratorsRef Geometric Object Generators Reference /// \defgroup PkgGeneratorsConcepts Concepts -/// \ingroup PkgGenerators +/// \ingroup PkgGeneratorsRef /*! -\addtogroup PkgGenerators -\cgalPkgDescriptionBegin{Geometric Object Generators,PkgGeneratorsSummary} +\addtogroup PkgGeneratorsRef +\cgalPkgDescriptionBegin{Geometric Object Generators,PkgGenerators} \cgalPkgPicture{dice.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Pedro M. M. de Castro, Olivier Devillers, Susan Hert, Michael Hoffmann, Lutz Kettner, Sven Schönherr, Alexandru Tifrea, and Maxime Gimeno} \cgalPkgDesc{This package provides a variety of generators for geometric objects. They are useful as synthetic test data sets, e.g. for testing algorithms on degenerate object sets and for performance analysis. } -\cgalPkgManuals{Chapter_Geometric_Object_Generators,PkgGenerators} +\cgalPkgManuals{Chapter_Geometric_Object_Generators,PkgGeneratorsRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} diff --git a/Geomview/doc/Geomview/CGAL/IO/Geomview_stream.h b/Geomview/doc/Geomview/CGAL/IO/Geomview_stream.h index 3b6cc552736..d189bb8367f 100644 --- a/Geomview/doc/Geomview/CGAL/IO/Geomview_stream.h +++ b/Geomview/doc/Geomview/CGAL/IO/Geomview_stream.h @@ -1,7 +1,7 @@ namespace CGAL { /*! - \ingroup PkgGeomview + \ingroup PkgGeomviewRef An object of the class `Geomview_stream` is a stream in which geometric objects can be inserted and where geometric objects can be extracted @@ -256,7 +256,7 @@ Geomview_stream& operator<<(Geomview_stream& gs, const Point_2& p); /// \addtogroup GeomviewOutput Output Operators for CGAL Kernel Classes -/// \ingroup PkgGeomview +/// \ingroup PkgGeomviewRef /// The following classes of the \cgal kernel have output /// operators. 2D objects are embedded in the `xy`-plane. /// @{ @@ -380,7 +380,7 @@ operator<<(Geomview_stream& gs, const Bbox_3& b); /// @} /// \addtogroup GeomviewInput Input Operators for CGAL Kernel Classes -/// \ingroup PkgGeomview +/// \ingroup PkgGeomviewRef /// An input operator is provided for points. The user has to select /// a point on the pick plane with the right mouse button. The pick plane /// can be moved anywhere with the left mouse button, before a point is entered. @@ -398,7 +398,7 @@ operator>>(Geomview_stream& gs, Point_3& p); /// @} /// \addtogroup GeomviewOutputClasses Output Operators for CGAL Basic Library Classes -/// \ingroup PkgGeomview +/// \ingroup PkgGeomviewRef /// Output operators are provided for polyhedral surfaces, as well as for 3D /// and 2D triangulations. The latter allow to visualize terrrains if the /// point type isa 3D point. diff --git a/Geomview/doc/Geomview/PackageDescription.txt b/Geomview/doc/Geomview/PackageDescription.txt index 7e598818921..15e58d59d6f 100644 --- a/Geomview/doc/Geomview/PackageDescription.txt +++ b/Geomview/doc/Geomview/PackageDescription.txt @@ -1,13 +1,13 @@ -/// \defgroup PkgGeomview Geomview Reference +/// \defgroup PkgGeomviewRef Geomview Reference /*! -\addtogroup PkgGeomview +\addtogroup PkgGeomviewRef \todo check generated documentation -\cgalPkgDescriptionBegin{Geomview,PkgGeomviewSummary} +\cgalPkgDescriptionBegin{Geomview,PkgGeomview} \cgalPkgPicture{geomview.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Andreas Fabri and Sylvain Pion} \cgalPkgDesc{This package implements an interface to Geomview, an interactive 3D viewing program, originally developed at the Geometry Center in Minneapolis.} -\cgalPkgManuals{Chapter_Geomview,PkgGeomview} +\cgalPkgManuals{Chapter_Geomview,PkgGeomviewRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{2.0} diff --git a/GraphicsView/doc/GraphicsView/PackageDescription.txt b/GraphicsView/doc/GraphicsView/PackageDescription.txt index 01513917180..0e6d19ed6a8 100644 --- a/GraphicsView/doc/GraphicsView/PackageDescription.txt +++ b/GraphicsView/doc/GraphicsView/PackageDescription.txt @@ -1,20 +1,20 @@ -/// \defgroup PkgGraphicsView CGAL and the Qt Graphics View Framework Reference +/// \defgroup PkgGraphicsViewRef CGAL and the Qt Graphics View Framework Reference /// \defgroup PkgGraphicsViewGraphicsItemClasses Graphics Item Classes -/// \ingroup PkgGraphicsView +/// \ingroup PkgGraphicsViewRef /// \defgroup PkgGraphicsViewInputClasses Input Classes -/// \ingroup PkgGraphicsView +/// \ingroup PkgGraphicsViewRef /// \defgroup PkgGraphicsViewMiscClasses Miscellaneous Classes -/// \ingroup PkgGraphicsView +/// \ingroup PkgGraphicsViewRef /*! -\addtogroup PkgGraphicsView +\addtogroup PkgGraphicsViewRef -\cgalPkgDescriptionBegin{CGAL and the Qt Graphics View Framework,PkgGraphicsViewSummary} +\cgalPkgDescriptionBegin{CGAL and the Qt Graphics View Framework,PkgGraphicsView} \cgalPkgPicture{detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Andreas Fabri and Laurent Rineau} \cgalPkgDesc{This package provides classes for displaying \cgal objects and data structures in the Qt 5 Graphics View Framework.} -\cgalPkgManuals{Chapter_CGAL_and_the_Qt_Graphics_View_Framework,PkgGraphicsView} +\cgalPkgManuals{Chapter_CGAL_and_the_Qt_Graphics_View_Framework,PkgGraphicsViewRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.4} diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h index 872112801dc..3f4ba1cab28 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_Decorators +\ingroup PkgHalfedgeDS_Decorators The class `CGAL::HalfedgeDS_items_decorator` provides additional functions diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h index 746362713ac..03fead17851 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h @@ -1,6 +1,6 @@ namespace CGAL { /*! -\ingroup PkgHDS_Decorators +\ingroup PkgHalfedgeDS_Decorators The class `CGAL::HalfedgeDS_items_decorator` provides additional functions diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h index bbd41329b33..6ab2a83d527 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_HDS +\ingroup PkgHalfedgeDS_HDS The class `HalfedgeDS_default` is a model for the `HalfedgeDS` concept. The second template parameter `HalfedgeDSItems` has a default argument diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h index 4f6e98e924a..37ca8daed46 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_VHF +\ingroup PkgHalfedgeDS_VHF The class `HalfedgeDS_face_base` is a model of the `HalfedgeDSFace` concept. `Refs` is an instantiation of a `HalfedgeDS`. The diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h index 56ced2fd44e..ad6692b85b8 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_VHF +\ingroup PkgHalfedgeDS_VHF The class `HalfedgeDS_face_min_base` is a model of the `HalfedgeDSFace` concept. `Refs` is an instantiation of a `HalfedgeDS`. It is diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h index 45c9e165444..4fee656edb6 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_VHF +\ingroup PkgHalfedgeDS_VHF The class `HalfedgeDS_halfedge_base` is a model of the `HalfedgeDSHalfedge` concept. `Refs` is an instantiation of a `HalfedgeDS`. diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h index 661409637db..b12a7dc7869 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_VHF +\ingroup PkgHalfedgeDS_VHF The class `HalfedgeDS_halfedge_min_base` is a model of the `HalfedgeDSHalfedge` concept. `Refs` is an instantiation of a `HalfedgeDS`. diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h index 74762abd8ee..d65e338e313 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_Items +\ingroup PkgHalfedgeDS_Items The class `HalfedgeDS_items_2` is a model of the `HalfedgeDSItems` concept. It uses the default types for vertices, halfedges, and faces that diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h index 7ad28c20c2a..a7c1c8452f2 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_Decorators +\ingroup PkgHalfedgeDS_Decorators The class `CGAL::HalfedgeDS_items_decorator` provides additional functions diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h index 7199bce9c1a..81d5ee9884b 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_HDS +\ingroup PkgHalfedgeDS_HDS The class `HalfedgeDS_list` is a model for the `HalfedgeDS` concept. `HalfedgeDS_list` is a list-based representation with bidirectional diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h index 7036bb036b4..e77630c9bb3 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_Items +\ingroup PkgHalfedgeDS_Items The class `HalfedgeDS_min_items` is a model of the `HalfedgeDSItems` concept. It defines types for vertices, halfedges, and faces that diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h index 4eb89512958..88c32a00b1d 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_HDS +\ingroup PkgHalfedgeDS_HDS The class `HalfedgeDS_vector` is a model for the `HalfedgeDS` concept. `HalfedgeDS_vector` is a vector-based representation with random diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h index e76ea3dd61e..bbc6345e128 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_VHF +\ingroup PkgHalfedgeDS_VHF The class `HalfedgeDS_vertex_base` is a model of the `HalfedgeDSVertex` concept. `Refs` is an instantiation of a `HalfedgeDS`. The diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h index 28756ef9d02..550b4c0aaa6 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgHDS_VHF +\ingroup PkgHalfedgeDS_VHF The class `HalfedgeDS_vertex_min_base` is a model of the `HalfedgeDSVertex` concept. `Refs` is an instantiation of a `HalfedgeDS`. It is diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h index 5e3c5d9c27d..b8bbf25099c 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgHDSConcepts +\ingroup PkgHalfedgeDSConcepts \cgalConcept The concept of a halfedge data structure (abbreviated as `HalfedgeDS`, or diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h index e025a3a8f87..e98a08bc57e 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgHDSConcepts +\ingroup PkgHalfedgeDSConcepts \cgalConcept The concept `HalfedgeDSFace` defines the requirements for the local `Face` diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h index 108ba5d5b46..ac634b0bad6 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgHDSConcepts +\ingroup PkgHalfedgeDSConcepts \cgalConcept The concept `HalfedgeDSHalfedge` defines the requirements for the local `Halfedge` diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h index 47b33ced659..085875ee624 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgHDSConcepts +\ingroup PkgHalfedgeDSConcepts \cgalConcept The concept `HalfedgeDSItems` wraps the three item types - vertex, diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h index 008297822a5..a8e41712676 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h @@ -1,5 +1,5 @@ /*! -\ingroup PkgHDSConcepts +\ingroup PkgHalfedgeDSConcepts \cgalConcept The concept `HalfedgeDSVertex` defines the requirements for the local `Vertex` diff --git a/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt b/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt index bca353bfb67..5202070123e 100644 --- a/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt +++ b/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt @@ -1,31 +1,31 @@ -/// \defgroup PkgHDS Halfedge Data Structures Reference -/// \defgroup PkgHDSConcepts Concepts -/// \ingroup PkgHDS +/// \defgroup PkgHalfedgeDSRef Halfedge Data Structures Reference +/// \defgroup PkgHalfedgeDSConcepts Concepts +/// \ingroup PkgHalfedgeDSRef -/// \defgroup PkgHDS_HDS Halfedge Data Structures -/// \ingroup PkgHDS +/// \defgroup PkgHalfedgeDS_HDS Halfedge Data Structures +/// \ingroup PkgHalfedgeDSRef -/// \defgroup PkgHDS_Items Item Classes -/// \ingroup PkgHDS +/// \defgroup PkgHalfedgeDS_Items Item Classes +/// \ingroup PkgHalfedgeDSRef -/// \defgroup PkgHDS_VHF Vertices, Halfedges, Faces -/// \ingroup PkgHDS +/// \defgroup PkgHalfedgeDS_VHF Vertices, Halfedges, Faces +/// \ingroup PkgHalfedgeDSRef -/// \defgroup PkgHDS_Decorators Decorators -/// \ingroup PkgHDS +/// \defgroup PkgHalfedgeDS_Decorators Decorators +/// \ingroup PkgHalfedgeDSRef /// Classes that provide additional functions /// to examine and to modify a halfedge data structure. /*! -\addtogroup PkgHDS +\addtogroup PkgHalfedgeDSRef \todo check generated documentation -\cgalPkgDescriptionBegin{Halfedge Data Structures,PkgHDSSummary} +\cgalPkgDescriptionBegin{Halfedge Data Structures,PkgHalfedgeDS} \cgalPkgPicture{HalfedgeDS/fig/HalfedgeDS-teaser-small.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Lutz Kettner} \cgalPkgDesc{A halfedge data structure is an edge-centered data structure capable of maintaining incidence information of vertices, edges and faces, for example for planar maps, polyhedra, or other orientable, two-dimensional surfaces embedded in arbitrary dimension. Each edge is decomposed into two halfedges with opposite orientations. One incident face and one incident vertex are stored in each halfedge. For each face and each vertex, one incident halfedge is stored. Reduced variants of the halfedge data structure can omit some of these information, for example the halfedge pointers in faces or the storage of faces at all.} -\cgalPkgManuals{Chapter_Halfedge_Data_Structures,PkgHDS} +\cgalPkgManuals{Chapter_Halfedge_Data_Structures,PkgHalfedgeDSRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.0} diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h index 4cbe9351891..106392639d5 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef \cgalAdvancedClass \cgalAdvancedBegin @@ -105,7 +105,7 @@ Orientation_2 orientation_2_object(); }; /* end Extremal_polygon_area_traits_2 */ /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef \cgalAdvancedClass \cgalAdvancedBegin diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h index 716236ecf76..f464fb1fdee 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef Given a set of points in the plane, the class `Largest_empty_iso_rectangle_2` is a data structure that maintains an iso-rectangle with the largest area among diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h index ebc2093435c..08c4b2a7031 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef computes a maximal (as specified by `t`) inscribed `k`-gon of the convex polygon described by [`points_begin`, @@ -49,7 +49,7 @@ const Traits& t); /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef \brief computes a maximum area inscribed `k`-gon of the convex polygon @@ -116,7 +116,7 @@ OutputIterator o); namespace CGAL { /*! -\ingroup PkgInscribedAreas +\ingroup PkgInscribedAreasRef \brief computes a maximum perimeter inscribed `k`-gon of the convex polygon described by `[points_begin, points_end)`, writes its diff --git a/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt b/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt index 929cb77847e..9270c38d3bb 100644 --- a/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt +++ b/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt @@ -1,17 +1,17 @@ -/// \defgroup PkgInscribedAreas Inscribed Areas Reference +/// \defgroup PkgInscribedAreasRef Inscribed Areas Reference /// \defgroup PkgInscribedAreasConcepts Concepts -/// \ingroup PkgInscribedAreas +/// \ingroup PkgInscribedAreasRef /*! -\addtogroup PkgInscribedAreas +\addtogroup PkgInscribedAreasRef \todo check generated documentation -\cgalPkgDescriptionBegin{Inscribed Areas,PkgInscribedAreasSummary} +\cgalPkgDescriptionBegin{Inscribed Areas,PkgInscribedAreas} \cgalPkgPicture{ler-detail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Michael Hoffmann and Eli Packer} \cgalPkgDesc{This package provides algorithms for computing inscribed areas. The algorithms for computing inscribed areas are: the largest inscribed k-gon (area or perimeter) of a convex point set and the largest inscribed iso-rectangle.} -\cgalPkgManuals{Chapter_Inscribed_Areas,PkgInscribedAreas} +\cgalPkgManuals{Chapter_Inscribed_Areas,PkgInscribedAreasRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.1} diff --git a/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h b/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h index 873b22ccb11..a50d9cbff1a 100644 --- a/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h +++ b/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgInterpolation2 +\ingroup PkgInterpolation2Ref The struct `Data_access` implements a functor that allows to retrieve data from an associative container. The functor keeps a reference to diff --git a/Interpolation/doc/Interpolation/Interpolation.txt b/Interpolation/doc/Interpolation/Interpolation.txt index decec2ed20e..cc5fb39cacc 100644 --- a/Interpolation/doc/Interpolation/Interpolation.txt +++ b/Interpolation/doc/Interpolation/Interpolation.txt @@ -95,7 +95,7 @@ diagrams, also known as power diagrams, are obtained by considering wei defined between two weighted points \f$ (p, \omega_p) \f$ and \f$ (q, \omega_q) \f$ by \f$ \Pi( (p, \omega_p), (q, \omega_q) ) = pq^2 - \omega_p - \omega_q \f$. See \link Subsection_2D_Triangulations_Regular_Description this section \endlink -of the package \ref PkgTriangulation2Summary for an in-depth description of power diagrams. +of the package \ref PkgTriangulation2 for an in-depth description of power diagrams. \cgalFigureBegin{figrn_coords, rn_coords.svg} Illustration of regular neighbor coordinates. The point set is the same diff --git a/Interpolation/doc/Interpolation/PackageDescription.txt b/Interpolation/doc/Interpolation/PackageDescription.txt index 1b13ef5d3b3..6482d84ac87 100644 --- a/Interpolation/doc/Interpolation/PackageDescription.txt +++ b/Interpolation/doc/Interpolation/PackageDescription.txt @@ -1,27 +1,27 @@ -/// \defgroup PkgInterpolation2 2D and Surface Function Interpolation Reference +/// \defgroup PkgInterpolation2Ref 2D and Surface Function Interpolation Reference /// \defgroup PkgInterpolation2Concepts Concepts -/// \ingroup PkgInterpolation2 +/// \ingroup PkgInterpolation2Ref /// \defgroup PkgInterpolation2Interpolation Interpolation Functions -/// \ingroup PkgInterpolation2 +/// \ingroup PkgInterpolation2Ref /// \defgroup PkgInterpolation2NatNeighbor Natural Neighbor Coordinate Computation -/// \ingroup PkgInterpolation2 +/// \ingroup PkgInterpolation2Ref /// \defgroup PkgInterpolation2SurfaceNeighbor Surface Neighbor and Surface Neighbor Coordinate Computation -/// \ingroup PkgInterpolation2 +/// \ingroup PkgInterpolation2Ref /*! -\addtogroup PkgInterpolation2 -\cgalPkgDescriptionBegin{2D and Surface Function Interpolation,PkgInterpolation2Summary} +\addtogroup PkgInterpolation2Ref +\cgalPkgDescriptionBegin{2D and Surface Function Interpolation,PkgInterpolation2} \cgalPkgPicture{interpolation.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Julia Flötotto} \cgalPkgDesc{This package implements different methods for scattered data interpolation: Given measures of a function on a set of discrete data points, the task is to interpolate this function on an arbitrary query point. The package further offers functions for natural neighbor interpolation.} -\cgalPkgManuals{Chapter_2D_and_Surface_Function_Interpolation,PkgInterpolation2} +\cgalPkgManuals{Chapter_2D_and_Surface_Function_Interpolation,PkgInterpolation2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.1} diff --git a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h index 0aa28b3c0d4..ad15203e6ce 100644 --- a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h +++ b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgIntervalSkipList +\ingroup PkgIntervalSkipListRef The class `Interval_skip_list` is a dynamic data structure that allows to find all members of a set of intervals that overlap a point. diff --git a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h index 6db50ce910f..d5a2ce3250f 100644 --- a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h +++ b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgIntervalSkipList +\ingroup PkgIntervalSkipListRef The class `Interval_skip_list_interval` represents intervals with lower and upper bound of type `Value`. These intervals diff --git a/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h b/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h index 0175c59494e..eaa1db22fc9 100644 --- a/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h +++ b/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgIntervalSkipList +\ingroup PkgIntervalSkipListRef The class `Level_interval` represents intervals for the minimum and maximum value of the `z`-coordinate of a face of a triangulation. diff --git a/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt b/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt index 30af0633afc..aff3f5fe49f 100644 --- a/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt +++ b/Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgIntervalSkipList Interval Skip List Reference +/// \defgroup PkgIntervalSkipListRef Interval Skip List Reference /// \defgroup PkgIntervalSkipListConcepts Concepts -/// \ingroup PkgIntervalSkipList +/// \ingroup PkgIntervalSkipListRef /*! -\addtogroup PkgIntervalSkipList +\addtogroup PkgIntervalSkipListRef -\cgalPkgDescriptionBegin{Interval Skip List,PkgIntervalSkipListSummary} +\cgalPkgDescriptionBegin{Interval Skip List,PkgIntervalSkipList} \cgalPkgPicture{Interval_skip_list/fig/query.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Andreas Fabri} \cgalPkgDesc{An interval skip list is a data structure for finding all intervals that contain a point, and for stabbing queries, that is for answering the question whether a given point is contained in an interval or not. For a triangulated terrain, this allows to quickly identify the triangles which intersect an iso line. } -\cgalPkgManuals{Chapter_Interval_Skip_List,PkgIntervalSkipList} +\cgalPkgManuals{Chapter_Interval_Skip_List,PkgIntervalSkipListRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.0} diff --git a/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h b/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h index 7f31a429a16..2bfe86e437a 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgJet_fitting_3 +\ingroup PkgJetFitting3Ref The class `Monge_via_jet_fitting` is designed to perform the estimation of the local differential quantities at a given point. The point range is @@ -39,7 +39,7 @@ public: /// @{ /*! -\ingroup PkgJet_fitting_3 +\ingroup PkgJetFitting3Ref The class `Monge_form` stores the Monge representation, i.e., the Monge coordinate system and the coefficients of the Monge form in this diff --git a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h index 52107e77128..23f4f36fce0 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgJet_fitting_3Concepts +\ingroup PkgJetFitting3Concepts \cgalConcept The concept `DataKernel` describes the set of requirements to be diff --git a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h index 93e8c849938..bd830a31714 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h @@ -1,6 +1,6 @@ /*! -\ingroup PkgJet_fitting_3Concepts +\ingroup PkgJetFitting3Concepts \cgalConcept The concept `LocalKernel` describes the set of requirements to be diff --git a/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt b/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt index ff80e0f65c4..adb780b42f7 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt +++ b/Jet_fitting_3/doc/Jet_fitting_3/PackageDescription.txt @@ -1,19 +1,19 @@ -/// \defgroup PkgJet_fitting_3 Estimation of Local Differential Properties of Point-Sampled Surfaces Reference -/// \defgroup PkgJet_fitting_3Concepts Concepts -/// \ingroup PkgJet_fitting_3 +/// \defgroup PkgJetFitting3Ref Estimation of Local Differential Properties of Point-Sampled Surfaces Reference +/// \defgroup PkgJetFitting3Concepts Concepts +/// \ingroup PkgJetFitting3Ref /*! -\addtogroup PkgJet_fitting_3 +\addtogroup PkgJetFitting3Ref \todo check generated documentation -\cgalPkgDescriptionBegin{Estimation of Local Differential Properties of Point-Sampled Surfaces,PkgJet_fitting_3Summary} +\cgalPkgDescriptionBegin{Estimation of Local Differential Properties of Point-Sampled Surfaces,PkgJetFitting3} \cgalPkgPicture{DavidDetail.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Marc Pouget and Frédéric Cazals} \cgalPkgDesc{For a surface discretized as a point cloud or a mesh, it is desirable to estimate pointwise differential quantities. More precisely, first order properties correspond to the normal or the tangent plane; second order properties provide the principal curvatures and directions, third order properties provide the directional derivatives of the principal curvatures along the curvature lines, etc. This package allows the estimation of local differential quantities of a surface from a point sample.} -\cgalPkgManuals{Chapter_Estimation_of_Local_Differential_Properties_of_Point-Sampled_Surfaces,PkgJet_fitting_3} +\cgalPkgManuals{Chapter_Estimation_of_Local_Differential_Properties_of_Point-Sampled_Surfaces,PkgJetFitting3Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.3} -\cgalPkgDependsOn{\ref PkgSolverSummary and \ref thirdpartyEigen} +\cgalPkgDependsOn{\ref PkgSolverInterface and \ref thirdpartyEigen} \cgalPkgBib{cgal:pc-eldp} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{Polyhedron demo,polyhedron_3.zip} diff --git a/Kernel_23/doc/Kernel_23/CGAL/Origin.h b/Kernel_23/doc/Kernel_23/CGAL/Origin.h index ad1fccbaaa7..2b590a04bed 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Origin.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Origin.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgKernel23 +\ingroup PkgKernel23Ref \cgal defines a symbolic constant `NULL_VECTOR` to construct zero length vectors. @@ -21,7 +21,7 @@ public: namespace CGAL { /*! -\ingroup PkgKernel23 +\ingroup PkgKernel23Ref \cgal defines a symbolic constant `ORIGIN` which denotes the point at the origin. diff --git a/Kernel_23/doc/Kernel_23/PackageDescription.txt b/Kernel_23/doc/Kernel_23/PackageDescription.txt index aa5e95fc237..4dfd75a4e2d 100644 --- a/Kernel_23/doc/Kernel_23/PackageDescription.txt +++ b/Kernel_23/doc/Kernel_23/PackageDescription.txt @@ -1,7 +1,7 @@ -/// \defgroup PkgKernel23 2D and 3D Linear Geometry Kernel Reference +/// \defgroup PkgKernel23Ref 2D and 3D Linear Geometry Kernel Reference /// \defgroup PkgKernel23Concepts Concepts -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup PkgKernel23ConceptsGeomObject Kernel Geometric Object Concepts /// \ingroup PkgKernel23Concepts @@ -10,37 +10,37 @@ /// \ingroup PkgKernel23Concepts /// \defgroup kernel_predef Predefined Kernels -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_classes2 2D Kernel Objects -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_classes3 3D Kernel Objects -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_classes Kernel Classes -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_global_function Global Kernel Functions -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_enums Enumerations and Related Functions -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_conversion Cartesian/Homogenous Conversion -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /// \defgroup kernel_dimension Dimension Handling Tools -/// \ingroup PkgKernel23 +/// \ingroup PkgKernel23Ref /*! -\addtogroup PkgKernel23 -\cgalPkgDescriptionBegin{2D and 3D Linear Geometry Kernel,PkgKernel23Summary} +\addtogroup PkgKernel23Ref +\cgalPkgDescriptionBegin{2D and 3D Linear Geometry Kernel,PkgKernel23} \cgalPkgPicture{pointSegmentTriangle.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Hervé Brönnimann, Andreas Fabri, Geert-Jan Giezeman, Susan Hert, Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Stefan Schirra} \cgalPkgDesc{This package contains kernels each containing objects of constant size, such as point, vector, direction, line, ray, segment, circle as well as predicates and constructions for these objects. The kernels mainly differ in the way they handle robustness issues.} -\cgalPkgManuals{Chapter_2D_and_3D_Geometry_Kernel,PkgKernel23} +\cgalPkgManuals{Chapter_2D_and_3D_Geometry_Kernel,PkgKernel23Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{0.9} diff --git a/Kernel_d/doc/Kernel_d/PackageDescription.txt b/Kernel_d/doc/Kernel_d/PackageDescription.txt index 296f53b8bf4..a2a4f31cbf3 100644 --- a/Kernel_d/doc/Kernel_d/PackageDescription.txt +++ b/Kernel_d/doc/Kernel_d/PackageDescription.txt @@ -1,33 +1,33 @@ -/// \defgroup PkgKernelD dD Geometry Kernel Reference +/// \defgroup PkgKernelDRef dD Geometry Kernel Reference /// \defgroup PkgKernelDLinAlgConcepts Linear Algebra Concepts -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /// \defgroup PkgKernelDLinAlgClasses Linear Algebra Classes -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /// \defgroup PkgKernelDKernels Kernels -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /// \defgroup PkgKernelDKernelObjs Kernel Objects -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /// \defgroup PkgKernelDFunctions Global Kernel Functions -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /// \defgroup PkgKernelDKernelConcept Kernel Concept -/// \ingroup PkgKernelD +/// \ingroup PkgKernelDRef /*! -\addtogroup PkgKernelD +\addtogroup PkgKernelDRef \todo check generated documentation -\cgalPkgDescriptionBegin{dD Geometry Kernel,PkgKernelDSummary} +\cgalPkgDescriptionBegin{dD Geometry Kernel,PkgKernelD} \cgalPkgPicture{hypercube.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Michael Seel} \cgalPkgDesc{The dD %Kernel contains objects of constant size, such as point, vector, direction, line, ray, segment, circle in d dimensional Euclidean space, as well as predicates and constructions for these objects.} -\cgalPkgManuals{Chapter_dD_Geometry_Kernel,PkgKernelD} +\cgalPkgManuals{Chapter_dD_Geometry_Kernel,PkgKernelDRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.1} diff --git a/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt b/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt index 8eb6f42e7dc..4aa6d9777bf 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt +++ b/Linear_cell_complex/doc/Linear_cell_complex/PackageDescription.txt @@ -1,15 +1,15 @@ -/// \defgroup PkgLinearCellComplex Linear Cell Complex Reference +/// \defgroup PkgLinearCellComplexRef Linear Cell Complex Reference /// \defgroup PkgLinearCellComplexConcepts Concepts -/// \ingroup PkgLinearCellComplex +/// \ingroup PkgLinearCellComplexRef /// \defgroup PkgLinearCellComplexClasses Classes -/// \ingroup PkgLinearCellComplex +/// \ingroup PkgLinearCellComplexRef /*! Basic constructions. */ /// \defgroup PkgLinearCellComplexConstructions Constructions for Linear Cell Complex -/// \ingroup PkgLinearCellComplex +/// \ingroup PkgLinearCellComplexRef /*! High-level operations. \code @@ -17,7 +17,7 @@ \endcode */ /// \defgroup PkgLinearCellComplexOperations Operations for Linear Cell Complex -/// \ingroup PkgLinearCellComplex +/// \ingroup PkgLinearCellComplexRef /*! Draw. \code @@ -25,22 +25,22 @@ \endcode */ /// \defgroup PkgDrawLinearCellComplex Draw a Linear Cell Complex -/// \ingroup PkgLinearCellComplex +/// \ingroup PkgLinearCellComplexRef /*! -\addtogroup PkgLinearCellComplex -\cgalPkgDescriptionBegin{Linear Cell Complex,PkgLinearCellComplexSummary} +\addtogroup PkgLinearCellComplexRef +\cgalPkgDescriptionBegin{Linear Cell Complex,PkgLinearCellComplex} \cgalPkgPicture{lcc_logo.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Guillaume Damiand} \cgalPkgDesc{This package implements linear cell complexes, objects in d-dimension with linear geometry. The combinatorial part of objects is described either by a combinatorial or a generalized map, representing all the cells of the object plus the incidence and adjacency relations between cells. Geometry is added to the combinatorial data-structure simply by associating a point to each vertex of the map. Taking a 2D combinatorial map, and using 3D points, gives a linear cell complex equivalent to a Polyhedron_3.} -\cgalPkgManuals{Chapter_Linear_Cell_Complex,PkgLinearCellComplex} +\cgalPkgManuals{Chapter_Linear_Cell_Complex,PkgLinearCellComplexRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{4.0} -\cgalPkgDependsOn{\ref PkgCombinatorialMapsSummary} -\cgalPkgDependsOn{\ref PkgGeneralizedMapsSummary} +\cgalPkgDependsOn{\ref PkgCombinatorialMaps} +\cgalPkgDependsOn{\ref PkgGeneralizedMaps} \cgalPkgBib{cgal:d-lcc-12} \cgalPkgLicense{\ref licensesLGPL "LGPL"} \cgalPkgDemo{3D Linear Cell Complex,linear_cell_complex_3.zip} diff --git a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h index 4761f703302..96b960f8b4a 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMatrixSearch +\ingroup PkgMatrixSearchRef The class `Dynamic_matrix` is an adaptor for an arbitrary matrix class `M` to provide the dynamic operations needed for monotone diff --git a/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h b/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h index e4f01c40586..cff3fcffd6a 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMatrixSearch +\ingroup PkgMatrixSearchRef The class `Sorted_matrix_search_traits_adaptor` can be used as an adaptor to create sorted matrix search traits classes for diff --git a/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h b/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h index a62799d1a10..91b60ccd958 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h +++ b/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMatrixSearch +\ingroup PkgMatrixSearchRef \brief computes the maximum (as specified by `compare_strictly`) entry for each row of `m` and writes the corresponding column diff --git a/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h b/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h index f54578520b4..d27ad901387 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h +++ b/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMatrixSearch +\ingroup PkgMatrixSearchRef \brief returns the element `x` in one of the sorted matrices from the range `[f, l)`, for which `t.is_feasible(x)` diff --git a/Matrix_search/doc/Matrix_search/PackageDescription.txt b/Matrix_search/doc/Matrix_search/PackageDescription.txt index 97b2f8fbd5c..6e91a1dba4e 100644 --- a/Matrix_search/doc/Matrix_search/PackageDescription.txt +++ b/Matrix_search/doc/Matrix_search/PackageDescription.txt @@ -1,17 +1,17 @@ -/// \defgroup PkgMatrixSearch Monotone and Sorted Matrix Search Reference +/// \defgroup PkgMatrixSearchRef Monotone and Sorted Matrix Search Reference /// \defgroup PkgMatrixSearchConcepts Concepts -/// \ingroup PkgMatrixSearch +/// \ingroup PkgMatrixSearchRef /*! -\addtogroup PkgMatrixSearch +\addtogroup PkgMatrixSearchRef \todo check generated documentation -\cgalPkgDescriptionBegin{Monotone and Sorted Matrix Search,PkgMatrixSearchSummary} +\cgalPkgDescriptionBegin{Monotone and Sorted Matrix Search,PkgMatrixSearch} \cgalPkgPicture{matrix.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Michael Hoffmann} \cgalPkgDesc{This package provides a matrix search framework, which is the underlying technique for the computation of all furthest neighbors for the vertices of a convex polygon, maximal k-gons inscribed into a planar point set, and computing rectangular p-centers.} -\cgalPkgManuals{Chapter_Monotone_and_Sorted_Matrix_Search,PkgMatrixSearch} +\cgalPkgManuals{Chapter_Monotone_and_Sorted_Matrix_Search,PkgMatrixSearchRef} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{1.1} diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h index e80acb71a5b..3979f8baf04 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h index 3fe813eecfe..909c91012c5 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h index f8624d97adc..1c29f732f89 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_vertex_base_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_vertex_base_2.h index 02894cb4e84..0eb0c2f8028 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_vertex_base_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_vertex_base_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref The class `Delaunay_mesh_vertex_base_2` is a model for the concept `DelaunayMeshVertexBase_2`. diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h index 449cb10d6e7..dd71a465d4d 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h @@ -2,7 +2,7 @@ namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref This class implements a 2D mesh generator. diff --git a/Mesh_2/doc/Mesh_2/CGAL/Mesh_2/Face_badness.h b/Mesh_2/doc/Mesh_2/CGAL/Mesh_2/Face_badness.h index fc3e577f324..57ac738075b 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Mesh_2/Face_badness.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Mesh_2/Face_badness.h @@ -1,7 +1,7 @@ namespace CGAL { namespace Mesh_2 { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref */ enum Face_badness { NOT_BAD, BAD, IMPERATIVELY_BAD}; diff --git a/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h b/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h index b0ff428a78e..2a8fcae9eef 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h @@ -40,7 +40,7 @@ template void make_conforming_Gabriel_2 (CDT &t); namespace CGAL { /*! -\ingroup PkgMesh2 +\ingroup PkgMesh2Ref The class `Triangulation_conformer_2` is an auxiliary class of diff --git a/Mesh_2/doc/Mesh_2/PackageDescription.txt b/Mesh_2/doc/Mesh_2/PackageDescription.txt index 79733d285b8..96c93298c8b 100644 --- a/Mesh_2/doc/Mesh_2/PackageDescription.txt +++ b/Mesh_2/doc/Mesh_2/PackageDescription.txt @@ -1,19 +1,19 @@ -/// \defgroup PkgMesh2 2D Conforming Triangulations and Meshes Reference +/// \defgroup PkgMesh2Ref 2D Conforming Triangulations and Meshes Reference /// \defgroup PkgMesh2Concepts Concepts -/// \ingroup PkgMesh2 +/// \ingroup PkgMesh2Ref /// \defgroup PkgMesh2Functions Mesh Generation Functions -/// \ingroup PkgMesh2 +/// \ingroup PkgMesh2Ref /// The main function to generate a mesh is `refine_Delaunay_mesh_2()`. /// The function `lloyd_optimize_mesh_2()` allows to optimize an existing mesh. /// \defgroup PkgMesh2Enum Enumerations -/// \ingroup PkgMesh2 +/// \ingroup PkgMesh2Ref /*! -\addtogroup PkgMesh2 -\cgalPkgDescriptionBegin{2D Conforming Triangulations and Meshes,PkgMesh2Summary} +\addtogroup PkgMesh2Ref +\cgalPkgDescriptionBegin{2D Conforming Triangulations and Meshes,PkgMesh2} \cgalPkgPicture{Mesh_2/fig/delaunaymesh-small.png} \cgalPkgSummaryBegin \cgalPkgAuthor{Laurent Rineau} @@ -23,11 +23,11 @@ Conforming Gabriel triangulations are obtained by further refining constrained The package provides also a 2D mesh generator that refines triangles and constrained edges until user defined size and shape criteria on triangles are satisfied. The generated meshes can be optimized using the Lloyd algorithm, also provided in this package. The package can handle intersecting input constraints and set no restriction on the angle formed by two constraints sharing an endpoint.} -\cgalPkgManuals{Chapter_2D_Conforming_Triangulations_and_Meshes,PkgMesh2} +\cgalPkgManuals{Chapter_2D_Conforming_Triangulations_and_Meshes,PkgMesh2Ref} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.1} -\cgalPkgDependsOn{\ref PkgTriangulation2Summary} +\cgalPkgDependsOn{\ref PkgTriangulation2} \cgalPkgBib{cgal:r-ctm2} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{2D Mesh Generator,constrained_delaunay_triangulation_2.zip} diff --git a/Mesh_3/doc/Mesh_3/CGAL/Compact_mesh_cell_base_3.h b/Mesh_3/doc/Mesh_3/CGAL/Compact_mesh_cell_base_3.h index d6ac28deb44..9de1c57ecc6 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Compact_mesh_cell_base_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Compact_mesh_cell_base_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3MeshClasses +\ingroup PkgMesh3MeshClasses The class `Compact_mesh_cell_base_3` is a model of the concept `MeshCellBase_3`. It is designed to serve as cell base class for the 3D triangulation diff --git a/Mesh_3/doc/Mesh_3/CGAL/Gray_image_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Gray_image_mesh_domain_3.h index cc6d2afdd75..d48567bd057 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Gray_image_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Gray_image_mesh_domain_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3Domains +\ingroup PkgMesh3Domains \deprecated The class template `Gray_image_mesh_domain_3` is deprecated since CGAL-4.13, in favor of the class template `Labeled_mesh_domain_3` and diff --git a/Mesh_3/doc/Mesh_3/CGAL/IO/File_medit.h b/Mesh_3/doc/Mesh_3/CGAL/IO/File_medit.h index e50566add7b..69966bf22b5 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/IO/File_medit.h +++ b/Mesh_3/doc/Mesh_3/CGAL/IO/File_medit.h @@ -1,6 +1,6 @@ namespace CGAL { -/// \ingroup PkgMesh_3IOFunctions +/// \ingroup PkgMesh3IOFunctions /// /// \brief Outputs a mesh complex to the medit (`.mesh`) file format. /// See \cgalCite{frey:inria-00069921} for a comprehensive description of this file format. diff --git a/Mesh_3/doc/Mesh_3/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h b/Mesh_3/doc/Mesh_3/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h index 8864ad40203..b672d4d3273 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h +++ b/Mesh_3/doc/Mesh_3/CGAL/IO/facets_in_complex_3_to_triangle_mesh.h @@ -1,5 +1,5 @@ namespace CGAL { -//! \ingroup PkgMesh_3Functions +//! \ingroup PkgMesh3Functions //! //! \brief builds a `TriangleMesh` from the surface facets, with a consistent orientation at the interface of two subdomains. //! diff --git a/Mesh_3/doc/Mesh_3/CGAL/Image_3.h b/Mesh_3/doc/Mesh_3/CGAL/Image_3.h index b973c7d2632..db38404cc9d 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Image_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Image_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3Domains +\ingroup PkgMesh3Domains The class `Image_3` is a C++ wrapper around the InrImage library. It holds a diff --git a/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h index a8dc87d0ea6..904d18d0e97 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3Domains +\ingroup PkgMesh3Domains \deprecated The class template `Implicit_mesh_domain_3` is deprecated since CGAL-4.13, in favor of the class template `Labeled_mesh_domain_3` and diff --git a/Mesh_3/doc/Mesh_3/CGAL/Implicit_to_labeling_function_wrapper.h b/Mesh_3/doc/Mesh_3/CGAL/Implicit_to_labeling_function_wrapper.h index f6b3601a71f..6446729e1c5 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Implicit_to_labeling_function_wrapper.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Implicit_to_labeling_function_wrapper.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3Domains +\ingroup PkgMesh3Domains The class `Implicit_multi_domain_to_labeling_function_wrapper` is a helping class to get a function with integer values labeling the components of a multi-domain. The multidomain is described through a set of functions {fi(p), i=1, ...n}. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h index 0aa10bb88a8..d23791874ac 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3Domains +\ingroup PkgMesh3Domains \deprecated The class template `Labeled_image_mesh_domain_3` is deprecated since CGAL-4.13, in favor of the class template `Labeled_mesh_domain_3` and diff --git a/Mesh_3/doc/Mesh_3/CGAL/Labeled_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Labeled_mesh_domain_3.h index 26720eb2cc9..399abd9a027 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Labeled_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Labeled_mesh_domain_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3Domains +\ingroup PkgMesh3Domains \brief The class `Labeled_mesh_domain_3` implements indexed domains. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h index 6d4171492d2..f2166607f7d 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_base_3.h @@ -3,7 +3,7 @@ namespace CGAL { /*! -\ingroup PkgMesh_3MeshClasses +\ingroup PkgMesh3MeshClasses