diff --git a/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt b/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt index cbf76d896e0..24a69f29a19 100644 --- a/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt +++ b/Convex_decomposition_3/doc/Convex_decomposition_3/PackageDescription.txt @@ -16,5 +16,11 @@ \cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd + +\cgalClassifedRefPages + +## Functions ## +- `CGAL::convex_decomposition_3(Nef_polyhedron_3& N)` + */ diff --git a/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt b/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt index 2fc5044ff4e..88568f30007 100644 --- a/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt +++ b/Convex_hull_d/doc/Convex_hull_d/PackageDescription.txt @@ -32,5 +32,18 @@ and arbitrary dimensions as well as functions for testing if a given set of points in is strongly convex or not. This chapter describes the class available for arbitrary dimensions and its companion class for computing the nearest and furthest site Delaunay triangulation. + +\cgalClassifedRefPages + +## Concepts # +- `ConvexHullTraits_d` +- `DelaunayLiftedTraits_d` +- `DelaunayTraits_d` + +## Classes ## +- `CGAL::Convex_hull_d_traits_3` +- `CGAL::Convex_hull_d` +- `CGAL::Delaunay_d< R, Lifted_R > ` + */ diff --git a/Envelope_2/doc/Envelope_2/PackageDescription.txt b/Envelope_2/doc/Envelope_2/PackageDescription.txt index bd5392a4e29..23f43104d00 100644 --- a/Envelope_2/doc/Envelope_2/PackageDescription.txt +++ b/Envelope_2/doc/Envelope_2/PackageDescription.txt @@ -25,4 +25,20 @@ 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 over each interval is unique. +\cgalClassifedRefPages + +## Functions ## +- `CGAL::lower_envelope_2` +- `CGAL::upper_envelope_2` +- `CGAL::lower_envelope_x_monotone_2` +- `CGAL::upper_envelope_x_monotone_2` + +## Concepts ## +- `EnvelopeDiagram_1` +- `EnvelopeDiagramVertex` +- `EnvelopeDiagramEdge` + +## Classes ## +- `CGAL::Envelope_diagram_1 ` + */ diff --git a/Envelope_3/doc/Envelope_3/PackageDescription.txt b/Envelope_3/doc/Envelope_3/PackageDescription.txt index 2751f4989c0..63b83ae40a0 100644 --- a/Envelope_3/doc/Envelope_3/PackageDescription.txt +++ b/Envelope_3/doc/Envelope_3/PackageDescription.txt @@ -27,5 +27,24 @@ represented as an 2D envelope diagram - a planar subdivision such that the identity of the surfaces that induce the envelope over each diagram cell is unique. +\cgalClassifedRefPages + +## Functions ## +- `CGAL::lower_envelope_3` +- `CGAL::upper_envelope_3` +- `CGAL::lower_envelope_xy_monotone_3` +- `CGAL::upper_envelope_xy_monotone_3` + +## Concepts ## +- `EnvelopeTraits_3` + +## Classes ## +- `CGAL::Envelope_diagram_2` + +- `CGAL::Env_triangle_traits_3` +- `CGAL::Env_sphere_traits_3` +- `CGAL::Env_plane_traits_3` +- `CGAL::Env_surface_data_traits_3` + */ diff --git a/Geomview/doc/Geomview/PackageDescription.txt b/Geomview/doc/Geomview/PackageDescription.txt index 57bd13ffaed..639d3cf0f7b 100644 --- a/Geomview/doc/Geomview/PackageDescription.txt +++ b/Geomview/doc/Geomview/PackageDescription.txt @@ -17,5 +17,11 @@ \cgalPkgLicense{\ref licensesLGPL "LGPL"} \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd + +\cgalClassifedRefPages + +## Classes ## +- `CGAL::Geomview_stream` + */ diff --git a/GraphicsView/doc/GraphicsView/PackageDescription.txt b/GraphicsView/doc/GraphicsView/PackageDescription.txt index b0014d624a0..01b509258f3 100644 --- a/GraphicsView/doc/GraphicsView/PackageDescription.txt +++ b/GraphicsView/doc/GraphicsView/PackageDescription.txt @@ -29,5 +29,26 @@ This package provides some classes which allow to use \cgal classes in HREF="http://doc.qt.digia.com/latest/graphicsview.html">Qt Graphics View Framework. +\cgalClassifedRefPages + +## GraphicsItem Classes ## + +- `CGAL::Qt::GraphicsItem` +- `CGAL::Qt::TriangulationGraphicsItem` +- `CGAL::Qt::ConstrainedTriangulationGraphicsItem` +- `CGAL::Qt::VoronoiGraphicsItem
` + +## Input Classes ## +- `CGAL::Qt::GraphicsViewInput` +- `CGAL::Qt::GraphicsViewCircleInput` +- `CGAL::Qt::GraphicsViewCircularArcInput` +- `CGAL::Qt::GraphicsViewIsoRectangleInput` +- `CGAL::Qt::GraphicsViewPolylineInput` + +## Miscellaneous Classes ## +- `CGAL::Qt::Converter` +- `CGAL::Qt::PainterOstream` +- `CGAL::Qt::GraphicsViewNavigation` + */ diff --git a/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt b/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt index e82499ecd83..fa17d045ee2 100644 --- a/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt +++ b/HalfedgeDS/doc/HalfedgeDS/PackageDescription.txt @@ -58,6 +58,34 @@ overview and comparison of these different data structures together with a thorough description of the design implemented here can be found in \cite k-ugpdd-99. +\cgalClassifedRefPages + +## Concepts ## +- `HalfedgeDS` +- `HalfedgeDSItems` +- `HalfedgeDSVertex` +- `HalfedgeDSHalfedge` +- `HalfedgeDSFace` + +## Classes ## +- `CGAL::HalfedgeDS_default` +- `CGAL::HalfedgeDS_list` +- `CGAL::HalfedgeDS_vector` + +- `CGAL::HalfedgeDS_min_items` +- `CGAL::HalfedgeDS_items_2` + +- `CGAL::HalfedgeDS_vertex_base` +- `CGAL::HalfedgeDS_halfedge_base` +- `CGAL::HalfedgeDS_face_base` + +- `CGAL::HalfedgeDS_vertex_min_base` +- `CGAL::HalfedgeDS_halfedge_min_base` +- `CGAL::HalfedgeDS_face_min_base` + +- `CGAL::HalfedgeDS_items_decorator` +- `CGAL::HalfedgeDS_decorator` +- `CGAL::HalfedgeDS_const_decorator` */ diff --git a/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt b/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt index 7da3ab81edf..5cdaab9224e 100644 --- a/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt +++ b/Inscribed_areas/doc/Inscribed_areas/PackageDescription.txt @@ -29,5 +29,17 @@ The optimization code uses infix `OPTIMISATION` in the assertions, e.g. defining the compiler flag `CGAL_OPTIMISATION_NO_PRECONDITIONS` switches precondition checking off, cf. Section \ref secchecks. + +\cgalClassifedRefPages + +- `CGAL::maximum_area_inscribed_k_gon_2` +- `CGAL::maximum_perimeter_inscribed_k_gon_2` +- `CGAL::extremal_polygon_2` +- `CGAL::Largest_empty_iso_rectangle_2` +- `CGAL::Extremal_polygon_area_traits_2` +- `CGAL::Extremal_polygon_perimeter_traits_2` +- `ExtremalPolygonTraits_2` +- `LargestEmptyIsoRectangleTraits_2` + */ diff --git a/Interpolation/doc/Interpolation/PackageDescription.txt b/Interpolation/doc/Interpolation/PackageDescription.txt index b3f4205648e..b0631c2a206 100644 --- a/Interpolation/doc/Interpolation/PackageDescription.txt +++ b/Interpolation/doc/Interpolation/PackageDescription.txt @@ -73,6 +73,30 @@ approximately barycentric, see \cite bf-lcss-02. For a more thorough introduction see the user manual. +\cgalClassifedRefPages + +## Concepts ## +- `InterpolationTraits` +- `GradientFittingTraits` + +## Interpolation Functions ## +- `CGAL::linear_interpolation` +- `CGAL::sibson_c1_interpolation` +- `CGAL::farin_c1_interpolation` +- `CGAL::quadratic_interpolation` +- `CGAL::sibson_gradient_fitting` + +- `CGAL::Interpolation_traits_2` +- `CGAL::Interpolation_gradient_fitting_traits_2` + +## Natural neighbor coordinate computation ## +- `CGAL::natural_neighbor_coordinates_2` +- `CGAL::regular_neighbor_coordinates_2` + +## Surface neighbor and surface neighbor coordinate computation ## +- `CGAL::Voronoi_intersection_2_traits_3` +- `CGAL::surface_neighbor_coordinates_3` +- `CGAL::surface_neighbors_3` */