mirror of https://github.com/CGAL/cgal
use macro for subsections
command used:
grep -l "###" */doc/*/PackageDescription.txt | xargs sed -i -E 's/\#\#\#\s*([[:print:]]+[[:alnum:]])\s*\#\#\#\s*$/\\cgalCRPSubsection{\1}/
This commit is contained in:
Sébastien Loriot
parent
50a59c3096
commit
90ad079eb4
|
|
@ -25,7 +25,7 @@
|
|||
|
||||
## Algebraic Structures ##
|
||||
|
||||
### Concepts ###
|
||||
\cgalCRPSubsection{Concepts}
|
||||
|
||||
- `IntegralDomainWithoutDivision`
|
||||
- `IntegralDomain`
|
||||
|
|
@ -54,7 +54,7 @@
|
|||
- `AlgebraicStructureTraits_::KthRoot`
|
||||
- `AlgebraicStructureTraits_::RootOf`
|
||||
|
||||
### Classes ###
|
||||
\cgalCRPSubsection{Classes}
|
||||
|
||||
- `CGAL::Algebraic_structure_traits<T>`
|
||||
- `CGAL::Integral_domain_without_division_tag`
|
||||
|
|
@ -64,7 +64,7 @@
|
|||
- `CGAL::Unique_factorization_domain_tag`
|
||||
- `CGAL::Euclidean_ring_tag`
|
||||
|
||||
### Global Functions ###
|
||||
\cgalCRPSubsection{Global Functions}
|
||||
|
||||
- `CGAL::is_zero()`
|
||||
- `CGAL::is_one()`
|
||||
|
|
@ -84,7 +84,7 @@
|
|||
|
||||
## Real Embeddable ##
|
||||
|
||||
### Concepts ###
|
||||
\cgalCRPSubsection{Concepts}
|
||||
|
||||
- `RealEmbeddable`
|
||||
|
||||
|
|
@ -98,11 +98,11 @@
|
|||
- `RealEmbeddableTraits_::ToDouble`
|
||||
- `RealEmbeddableTraits_::ToInterval`
|
||||
|
||||
### Classes ###
|
||||
\cgalCRPSubsection{Classes}
|
||||
|
||||
- `CGAL::Real_embeddable_traits<T>`
|
||||
|
||||
### Global Functions ###
|
||||
\cgalCRPSubsection{Global Functions}
|
||||
|
||||
- `CGAL::is_zero()`
|
||||
- `CGAL::abs()`
|
||||
|
|
@ -115,25 +115,25 @@
|
|||
|
||||
## Real Number Types ##
|
||||
|
||||
### Concepts ###
|
||||
\cgalCRPSubsection{Concepts}
|
||||
|
||||
- `RingNumberType`
|
||||
- `FieldNumberType`
|
||||
|
||||
## Interoperability ##
|
||||
|
||||
### Concepts ###
|
||||
\cgalCRPSubsection{Concepts}
|
||||
|
||||
- `ExplicitInteroperable`
|
||||
- `ImplicitInteroperable`
|
||||
|
||||
### Classes ###
|
||||
\cgalCRPSubsection{Classes}
|
||||
|
||||
- `CGAL::Coercion_traits<A,B>`
|
||||
|
||||
## Fractions ##
|
||||
|
||||
### Concepts ###
|
||||
\cgalCRPSubsection{Concepts}
|
||||
|
||||
- `Fraction`
|
||||
- `FractionTraits`
|
||||
|
|
@ -141,13 +141,13 @@
|
|||
- `FractionTraits_::Compose`
|
||||
- `FractionTraits_::CommonFactor`
|
||||
|
||||
### Classes ###
|
||||
\cgalCRPSubsection{Classes}
|
||||
|
||||
- `CGAL::Fraction_traits<T>`
|
||||
|
||||
## Miscellaneous ##
|
||||
|
||||
### Concepts ###
|
||||
\cgalCRPSubsection{Concepts}
|
||||
- `FromIntConstructible`
|
||||
- `FromDoubleConstructible`
|
||||
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@
|
|||
|
||||
## Concepts ##
|
||||
|
||||
### Univariate Algebraic %Kernel ###
|
||||
\cgalCRPSubsection{Univariate Algebraic %Kernel}
|
||||
|
||||
- `AlgebraicKernel_d_1`
|
||||
|
||||
|
|
@ -58,7 +58,7 @@
|
|||
- `AlgebraicKernel_d_1::ApproximateAbsolute_1`
|
||||
- `AlgebraicKernel_d_1::ApproximateRelative_1`
|
||||
|
||||
### Bivariate Algebraic %Kernel ###
|
||||
\cgalCRPSubsection{Bivariate Algebraic %Kernel}
|
||||
|
||||
- `AlgebraicKernel_d_2`
|
||||
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@
|
|||
|
||||
- `CircularKernel`
|
||||
|
||||
### Functors ###
|
||||
\cgalCRPSubsection{Functors}
|
||||
|
||||
- `CircularKernel::ConstructLine_2`
|
||||
- `CircularKernel::ConstructCircle_2`
|
||||
|
|
@ -82,16 +82,16 @@
|
|||
|
||||
## Geometric Kernels and Classes ##
|
||||
|
||||
### Kernels ###
|
||||
\cgalCRPSubsection{Kernels}
|
||||
|
||||
- `CGAL::Circular_kernel_2<Kernel,AlgebraicKernelForCircles>`
|
||||
- `CGAL::Exact_circular_kernel_2`
|
||||
|
||||
### Points ###
|
||||
\cgalCRPSubsection{Points}
|
||||
|
||||
- `CGAL::Circular_arc_point_2<CircularKernel>`
|
||||
|
||||
### Arcs ###
|
||||
\cgalCRPSubsection{Arcs}
|
||||
|
||||
- `CGAL::Circular_arc_2<CircularKernel>`
|
||||
- `CGAL::Line_arc_2<CircularKernel>`
|
||||
|
|
@ -118,7 +118,7 @@
|
|||
|
||||
- `AlgebraicKernelForCircles`
|
||||
|
||||
### Functors ###
|
||||
\cgalCRPSubsection{Functors}
|
||||
|
||||
|
||||
- `AlgebraicKernelForCircles::ConstructPolynomial_1_2`
|
||||
|
|
@ -133,16 +133,16 @@
|
|||
|
||||
## Algebraic %Kernel and Classes ##
|
||||
|
||||
### %Kernel ###
|
||||
\cgalCRPSubsection{%Kernel}
|
||||
|
||||
- `CGAL::Algebraic_kernel_for_circles_2_2<RT>`
|
||||
|
||||
### Polynomials ###
|
||||
\cgalCRPSubsection{Polynomials}
|
||||
|
||||
- `CGAL::Polynomial_1_2<RT>`
|
||||
- `CGAL::Polynomial_for_circles_2_2<FT>`
|
||||
|
||||
### Roots of Polynomials ###
|
||||
\cgalCRPSubsection{Roots of Polynomials}
|
||||
|
||||
- `CGAL::Sqrt_extension<NT,ROOT>`
|
||||
- `CGAL::Root_for_circles_2_2<FT>`
|
||||
|
|
|
|||
|
|
@ -40,13 +40,13 @@
|
|||
|
||||
- `SphericalKernel`
|
||||
|
||||
### Object types ###
|
||||
\cgalCRPSubsection{Object types}
|
||||
|
||||
- `SphericalKernel::CircularArc_3`
|
||||
- `SphericalKernel::CircularArcPoint_3`
|
||||
- `SphericalKernel::LineArc_3`
|
||||
|
||||
### Functors ###
|
||||
\cgalCRPSubsection{Functors}
|
||||
|
||||
- `SphericalKernel::ConstructPlane_3`
|
||||
- `SphericalKernel::ConstructSphere_3`
|
||||
|
|
@ -89,16 +89,16 @@
|
|||
|
||||
## Geometric Kernels and Classes ##
|
||||
|
||||
### Kernels ###
|
||||
\cgalCRPSubsection{Kernels}
|
||||
|
||||
- `CGAL::Spherical_kernel_3<Kernel,AlgebraicKernelForSpheres>`
|
||||
- `CGAL::Exact_spherical_kernel_3`
|
||||
|
||||
### Points ###
|
||||
\cgalCRPSubsection{Points}
|
||||
|
||||
- `CGAL::Circular_arc_point_3<SphericalKernel>`
|
||||
|
||||
### Arcs ###
|
||||
\cgalCRPSubsection{Arcs}
|
||||
|
||||
- `CGAL::Line_arc_3<SphericalKernel>`
|
||||
- `CGAL::Circular_arc_3<SphericalKernel>`
|
||||
|
|
@ -133,7 +133,7 @@
|
|||
|
||||
- `AlgebraicKernelForSpheres`
|
||||
|
||||
### Functors ###
|
||||
\cgalCRPSubsection{Functors}
|
||||
|
||||
- `AlgebraicKernelForSpheres::ConstructPolynomial_1_3`
|
||||
- `AlgebraicKernelForSpheres::ConstructPolynomialForSpheres_2_3`
|
||||
|
|
@ -151,17 +151,17 @@
|
|||
|
||||
## Algebraic %Kernel and Classes ##
|
||||
|
||||
### %Kernel ###
|
||||
\cgalCRPSubsection{%Kernel}
|
||||
|
||||
- `CGAL::Algebraic_kernel_for_spheres_2_3<RT>`
|
||||
|
||||
### Polynomials ###
|
||||
\cgalCRPSubsection{Polynomials}
|
||||
|
||||
- `CGAL::Polynomial_1_3<RT>`
|
||||
- `CGAL::Polynomial_for_spheres_2_3<FT>`
|
||||
- `CGAL::Polynomials_for_lines_3<FT>`
|
||||
|
||||
### Roots of Polynomials ###
|
||||
\cgalCRPSubsection{Roots of Polynomials}
|
||||
|
||||
- `CGAL::Sqrt_extension<NT,ROOT>`
|
||||
- `CGAL::Root_for_spheres_2_3<RT>`
|
||||
|
|
|
|||
|
|
@ -54,13 +54,13 @@
|
|||
- `CGAL::Generic_map_min_items`
|
||||
|
||||
## Global Functions ##
|
||||
### Constructions for Combinatorial Maps ###
|
||||
\cgalCRPSubsection{Constructions for Combinatorial Maps}
|
||||
- `CGAL::make_edge<CMap>`
|
||||
- `CGAL::make_combinatorial_polygon<CMap>`
|
||||
- `CGAL::make_combinatorial_tetrahedron<CMap>`
|
||||
- `CGAL::make_combinatorial_hexahedron<CMap>`
|
||||
|
||||
### Operations for Combinatorial Maps ###
|
||||
\cgalCRPSubsection{Operations for Combinatorial Maps}
|
||||
- `CGAL::is_removable<CMap,i>`
|
||||
- `CGAL::remove_cell<CMap,i>`
|
||||
- `CGAL::is_insertable_cell_1_in_cell_2<CMap>`
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@
|
|||
|
||||
## %Kernel Objects ##
|
||||
|
||||
### Two-dimensional Objects ###
|
||||
\cgalCRPSubsection{Two-dimensional Objects}
|
||||
|
||||
- `CGAL::Aff_transformation_2<Kernel>`
|
||||
- `CGAL::Bbox_2`
|
||||
|
|
@ -95,7 +95,7 @@
|
|||
- `CGAL::Vector_2<Kernel>`
|
||||
- `CGAL::Weighted_point_2<Kernel>`
|
||||
|
||||
### Three-dimensional Objects ###
|
||||
\cgalCRPSubsection{Three-dimensional Objects}
|
||||
|
||||
- `CGAL::Bbox_3`
|
||||
- `CGAL::Aff_transformation_3<Kernel>`
|
||||
|
|
|
|||
|
|
@ -65,16 +65,16 @@
|
|||
- `CGAL::Linear_cell_complex<d,d2,LCCTraits,Items,Alloc>`
|
||||
|
||||
## Global Functions ##
|
||||
### Constructions for Linear Cell Complex ###
|
||||
\cgalCRPSubsection{Constructions for Linear Cell Complex}
|
||||
- `CGAL::import_from_plane_graph<LCC>`
|
||||
- `CGAL::import_from_triangulation_3<LCC,Triangulation>`
|
||||
- `CGAL::import_from_polyhedron_3<LCC,Polyhedron>`
|
||||
|
||||
### Operations for Linear Cell Complex ###
|
||||
\cgalCRPSubsection{Operations for Linear Cell Complex}
|
||||
- `CGAL::compute_normal_of_cell_0<LCC>`
|
||||
- `CGAL::compute_normal_of_cell_2<LCC>`
|
||||
|
||||
### Draw a Linear cell complex ###
|
||||
\cgalCRPSubsection{Draw a Linear cell complex}
|
||||
- `CGAL::draw<LCC>`
|
||||
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -60,21 +60,21 @@
|
|||
- \link double.h `double` \endlink
|
||||
- \link long_double.h `long double` \endlink
|
||||
|
||||
### %CORE ###
|
||||
\cgalCRPSubsection{%CORE}
|
||||
|
||||
- `CORE::BigInt`
|
||||
- `CORE::BigRat`
|
||||
- `CORE::BigFloat`
|
||||
- `CORE::Expr`
|
||||
|
||||
### LEDA ###
|
||||
\cgalCRPSubsection{LEDA}
|
||||
|
||||
- `leda_integer`
|
||||
- `leda_rational`
|
||||
- `leda_bigfloat`
|
||||
- `leda_real`
|
||||
|
||||
### GMP ###
|
||||
\cgalCRPSubsection{GMP}
|
||||
|
||||
- `mpz_class`
|
||||
- `mpq_class`
|
||||
|
|
@ -85,7 +85,7 @@
|
|||
- `CGAL::Gmpfr`
|
||||
- `CGAL::Gmpfi`
|
||||
|
||||
### %CGAL ###
|
||||
\cgalCRPSubsection{%CGAL}
|
||||
|
||||
- `CGAL::MP_Float`
|
||||
- `CGAL::Interval_nt<Protected>`
|
||||
|
|
|
|||
|
|
@ -84,7 +84,7 @@ of the concept `Periodic_2Offset_2`.
|
|||
|
||||
## Classes ##
|
||||
|
||||
### Main Classes ###
|
||||
\cgalCRPSubsection{Main Classes}
|
||||
|
||||
- `CGAL::Periodic_2_triangulation_2<PT,TDS>`
|
||||
- `CGAL::Periodic_2_Delaunay_triangulation_2<PT,TDS>`
|
||||
|
|
@ -93,7 +93,7 @@ of the concept `Periodic_2Offset_2`.
|
|||
- `CGAL::Periodic_2_triangulation_vertex_base_2<>`
|
||||
- `CGAL::Periodic_2_offset_2`
|
||||
|
||||
### Traits Classes ###
|
||||
\cgalCRPSubsection{Traits Classes}
|
||||
|
||||
- `CGAL::Periodic_2_triangulation_traits_2<Traits,Periodic_2Offset_2>`
|
||||
- `CGAL::Periodic_2_Delaunay_triangulation_traits_2<Traits,Periodic_2Offset_2>`
|
||||
|
|
|
|||
|
|
@ -89,7 +89,7 @@ of the concept `Periodic_3Offset_3`.
|
|||
|
||||
## Classes ##
|
||||
|
||||
### Main Classes ###
|
||||
\cgalCRPSubsection{Main Classes}
|
||||
|
||||
- `CGAL::Periodic_3_triangulation_3<PT,TDS>`
|
||||
- `CGAL::Periodic_3_Delaunay_triangulation_3<PT,TDS>`
|
||||
|
|
@ -101,7 +101,7 @@ of the concept `Periodic_3Offset_3`.
|
|||
- `CGAL::Periodic_3_triangulation_ds_cell_base_3<>`
|
||||
- `CGAL::Periodic_3_offset_3`
|
||||
|
||||
### Traits Classes ###
|
||||
\cgalCRPSubsection{Traits Classes}
|
||||
|
||||
- `CGAL::Periodic_3_triangulation_traits_3<Traits,Periodic_3Offset_3>`
|
||||
- `CGAL::Periodic_3_Delaunay_triangulation_traits_3<Traits,Periodic_3Offset_3>`
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ is opposite to the vertex with the same index. See
|
|||
|
||||
## Classes ##
|
||||
|
||||
### Main Classes ###
|
||||
\cgalCRPSubsection{Main Classes}
|
||||
|
||||
- `CGAL::Triangulation_3<TriangulationTraits_3,TriangulationDataStructure_3,SurjectiveLockDataStructure>`
|
||||
- `CGAL::Delaunay_triangulation_3<DelaunayTriangulationTraits_3,TriangulationDataStructure_3,LocationPolicy,SurjectiveLockDataStructure>`
|
||||
|
|
@ -108,7 +108,7 @@ is opposite to the vertex with the same index. See
|
|||
- `CGAL::Regular_triangulation_cell_base_with_weighted_circumcenter_3<RegularTriangulationTraits_3,Cb>`
|
||||
- `CGAL::Triangulation_simplex_3<Triangulation_3>`
|
||||
|
||||
### Traits Classes ###
|
||||
\cgalCRPSubsection{Traits Classes}
|
||||
|
||||
- `CGAL::Regular_triangulation_euclidean_traits_3<K,Weight>`
|
||||
- `CGAL::Robust_weighted_circumcenter_filtered_traits_3<K>`
|
||||
|
|
|
|||
Loading…
Reference in New Issue