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

issue #7395 Improvement of layout of model relations 

- Completed the cgalModels part
This commit is contained in:
albert-github 2023-07-09 12:43:36 +02:00
parent ee2a55279d
commit 301728a8a9
521 changed files with 738 additions and 964 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Algebraic_foundations/doc/Algebraic_foundations/CGAL/Algebraic_structure_traits.h
View File

@ -5,7 +5,7 @@ namespace CGAL {
An instance of `Algebraic_structure_traits` is a model of `AlgebraicStructureTraits`, where <span class="textsc">T</span> is the associated type. An instance of `Algebraic_structure_traits` is a model of `AlgebraicStructureTraits`, where <span class="textsc">T</span> is the associated type.
\cgalModels `AlgebraicStructureTraits` \cgalModels{AlgebraicStructureTraits}
*/ */
template< typename T > template< typename T >
@ -22,7 +22,7 @@ namespace CGAL {
Tag indicating that a type is a model of the Tag indicating that a type is a model of the
`EuclideanRing` concept. `EuclideanRing` concept.
\cgalModels `DefaultConstructible` \cgalModels{DefaultConstructible}
\sa `EuclideanRing` \sa `EuclideanRing`
\sa `AlgebraicStructureTraits` \sa `AlgebraicStructureTraits`
@ -38,7 +38,7 @@ struct Euclidean_ring_tag : public Unique_factorization_domain_tag {
Tag indicating that a type is a model of the `Field` concept. Tag indicating that a type is a model of the `Field` concept.
\cgalModels `DefaultConstructible` \cgalModels{DefaultConstructible}
\sa `Field` \sa `Field`
\sa `AlgebraicStructureTraits` \sa `AlgebraicStructureTraits`
@ -54,7 +54,7 @@ struct Field_tag : public Integral_domain_tag {
Tag indicating that a type is a model of the `FieldWithKthRoot` concept. Tag indicating that a type is a model of the `FieldWithKthRoot` concept.
\cgalModels `DefaultConstructible` \cgalModels{DefaultConstructible}
\sa `FieldWithKthRoot` \sa `FieldWithKthRoot`
\sa `AlgebraicStructureTraits` \sa `AlgebraicStructureTraits`
@ -70,7 +70,7 @@ struct Field_with_kth_root_tag : public Field_with_sqrt_tag {
Tag indicating that a type is a model of the `FieldWithRootOf` concept. Tag indicating that a type is a model of the `FieldWithRootOf` concept.
\cgalModels `DefaultConstructible` \cgalModels{DefaultConstructible}
\sa `FieldWithRootOf` \sa `FieldWithRootOf`
\sa `AlgebraicStructureTraits` \sa `AlgebraicStructureTraits`
@ -86,7 +86,7 @@ struct Field_with_root_of_tag : public Field_with_kth_root_tag {
Tag indicating that a type is a model of the `FieldWithSqrt` concept. Tag indicating that a type is a model of the `FieldWithSqrt` concept.
\cgalModels `DefaultConstructible` \cgalModels{DefaultConstructible}
\sa `FieldWithSqrt` \sa `FieldWithSqrt`
\sa `AlgebraicStructureTraits` \sa `AlgebraicStructureTraits`
@ -102,7 +102,7 @@ struct Field_with_sqrt_tag : public Field_tag {
Tag indicating that a type is a model of the `IntegralDomain` concept. Tag indicating that a type is a model of the `IntegralDomain` concept.
\cgalModels `DefaultConstructible` \cgalModels{DefaultConstructible}
\sa `IntegralDomain` \sa `IntegralDomain`
\sa `AlgebraicStructureTraits` \sa `AlgebraicStructureTraits`
@ -118,7 +118,7 @@ struct Integral_domain_tag : public Integral_domain_without_division_tag {
Tag indicating that a type is a model of the `IntegralDomainWithoutDivision` concept. Tag indicating that a type is a model of the `IntegralDomainWithoutDivision` concept.
\cgalModels `DefaultConstructible` \cgalModels{DefaultConstructible}
\sa `IntegralDomainWithoutDivision` \sa `IntegralDomainWithoutDivision`
@ -133,7 +133,7 @@ struct Integral_domain_without_division_tag {
Tag indicating that a type is a model of the `UniqueFactorizationDomain` concept. Tag indicating that a type is a model of the `UniqueFactorizationDomain` concept.
\cgalModels `DefaultConstructible` \cgalModels{DefaultConstructible}
\sa `UniqueFactorizationDomain` \sa `UniqueFactorizationDomain`
\sa `AlgebraicStructureTraits` \sa `AlgebraicStructureTraits`

2
Algebraic_foundations/doc/Algebraic_foundations/CGAL/Fraction_traits.h
View File

@ -6,7 +6,7 @@ namespace CGAL {
An instance of `Fraction_traits` is a model of `FractionTraits`, An instance of `Fraction_traits` is a model of `FractionTraits`,
where `T` is the associated type. where `T` is the associated type.
\cgalModels `FractionTraits` \cgalModels{FractionTraits}
*/ */
template< typename T > template< typename T >

2
Algebraic_foundations/doc/Algebraic_foundations/CGAL/Real_embeddable_traits.h
View File

@ -6,7 +6,7 @@ namespace CGAL {
An instance of `Real_embeddable_traits` is a model of `RealEmbeddableTraits`, where <span class="textsc">T</span> is the associated type. An instance of `Real_embeddable_traits` is a model of `RealEmbeddableTraits`, where <span class="textsc">T</span> is the associated type.
\cgalModels `RealEmbeddableTraits` \cgalModels{RealEmbeddableTraits}
*/ */
template< typename T > template< typename T >

2
Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h
View File

@ -27,7 +27,7 @@ approximation of an algebraic real root is a slightly modified
(filtered) version of the one presented in \cgalCite{abbott-qir-06}. The (filtered) version of the one presented in \cgalCite{abbott-qir-06}. The
method has quadratic convergence. method has quadratic convergence.
\cgalModels `AlgebraicKernel_d_1` \cgalModels{AlgebraicKernel_d_1}
\sa `AlgebraicKernel_d_1` \sa `AlgebraicKernel_d_1`
\sa `Polynomial_d` \sa `Polynomial_d`

2
Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h
View File

@ -47,7 +47,7 @@ above. `ROOT` should be one of the integer types. See also the
documentation of `Sqrt_extension<NT,ROOT>`. documentation of `Sqrt_extension<NT,ROOT>`.
\cgalAdvancedEnd \cgalAdvancedEnd
\cgalModels `AlgebraicKernel_d_2` \cgalModels{AlgebraicKernel_d_2}
\sa `AlgebraicKernel_d_1` \sa `AlgebraicKernel_d_1`
\sa `AlgebraicKernel_d_2` \sa `AlgebraicKernel_d_2`

2
Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h
View File

@ -12,7 +12,7 @@ rational univariate polynomial root isolation. It is a model of the
isolate integer polynomials, the operations of this kernel have the isolate integer polynomials, the operations of this kernel have the
overhead of converting the polynomials to integer. overhead of converting the polynomials to integer.
\cgalModels `AlgebraicKernel_d_1` \cgalModels{AlgebraicKernel_d_1}
\sa `Algebraic_kernel_rs_gmpz_d_1` \sa `Algebraic_kernel_rs_gmpz_d_1`

2
Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h
View File

@ -10,7 +10,7 @@ This univariate algebraic kernel uses the Rs library to perform
integer univariate polynomial root isolation. It is a model of the integer univariate polynomial root isolation. It is a model of the
`AlgebraicKernel_d_1` concept. `AlgebraicKernel_d_1` concept.
\cgalModels `AlgebraicKernel_d_1` \cgalModels{AlgebraicKernel_d_1}
\sa `Algebraic_kernel_rs_gmpz_d_1` \sa `Algebraic_kernel_rs_gmpz_d_1`

2
Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h
View File

@ -16,7 +16,7 @@ if `Alpha_shape_face_base_2` is intended to be used with an alpha-shape class ba
\link Tag_true `Tag_true`\endlink, triggers exact comparisons between alpha values. See the description \link Tag_true `Tag_true`\endlink, triggers exact comparisons between alpha values. See the description
provided in the documentation of `Alpha_shape_2` for more details. The default value is \link Tag_false `Tag_false`\endlink. provided in the documentation of `Alpha_shape_2` for more details. The default value is \link Tag_false `Tag_false`\endlink.
\cgalModels `AlphaShapeFace_2` \cgalModels{AlphaShapeFace_2}
\sa `Triangulation_face_base_2` \sa `Triangulation_face_base_2`
\sa `Regular_triangulation_face_base_2` \sa `Regular_triangulation_face_base_2`

2
Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h
View File

@ -17,7 +17,7 @@ if `Alpha_shape_vertex_base_2` is intended to be used with an alpha-shape class
\link Tag_true `Tag_true`\endlink, triggers exact comparisons between alpha values. See the description \link Tag_true `Tag_true`\endlink, triggers exact comparisons between alpha values. See the description
provided in the documentation of `Alpha_shape_2` for more details. The default value is \link Tag_false `Tag_false`\endlink. provided in the documentation of `Alpha_shape_2` for more details. The default value is \link Tag_false `Tag_false`\endlink.
\cgalModels `AlphaShapeVertex_2` \cgalModels{AlphaShapeVertex_2}
\sa `Triangulation_vertex_base_2` \sa `Triangulation_vertex_base_2`
\sa `Regular_triangulation_vertex_base_2` \sa `Regular_triangulation_vertex_base_2`

2
Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h
View File

@ -19,7 +19,7 @@ provided in the documentation of `Alpha_shape_3` for more details. The default v
must be \link Tag_true `Tag_true`\endlink if the underlying triangulation of the alpha shape to be used is a regular triangulation must be \link Tag_true `Tag_true`\endlink if the underlying triangulation of the alpha shape to be used is a regular triangulation
and \link Tag_false `Tag_false`\endlink otherwise. The default is \link Tag_false `Tag_false`\endlink. and \link Tag_false `Tag_false`\endlink otherwise. The default is \link Tag_false `Tag_false`\endlink.
\cgalModels `AlphaShapeCell_3` \cgalModels{AlphaShapeCell_3}
\sa `Delaunay_triangulation_cell_base_3` \sa `Delaunay_triangulation_cell_base_3`
\sa `Regular_triangulation_cell_base_3` \sa `Regular_triangulation_cell_base_3`

2
Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_vertex_base_3.h
View File

@ -19,7 +19,7 @@ provided in the documentation of `Alpha_shape_3` for more details. The default v
must be \link Tag_true `Tag_true`\endlink if the underlying triangulation of the alpha shape to be used is a regular triangulation must be \link Tag_true `Tag_true`\endlink if the underlying triangulation of the alpha shape to be used is a regular triangulation
and \link Tag_false `Tag_false`\endlink otherwise. The default is \link Tag_false `Tag_false`\endlink. and \link Tag_false `Tag_false`\endlink otherwise. The default is \link Tag_false `Tag_false`\endlink.
\cgalModels `AlphaShapeVertex_3` \cgalModels{AlphaShapeVertex_3}
\sa `Triangulation_vertex_base_3` \sa `Triangulation_vertex_base_3`
\sa `Regular_triangulation_vertex_base_3` \sa `Regular_triangulation_vertex_base_3`

2
Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_cell_base_3.h
View File

@ -13,7 +13,7 @@ to the `Alpha_shape_3` class.
By default, it is instantiated with `Delaunay_triangulation_cell_base_3<Traits>`, By default, it is instantiated with `Delaunay_triangulation_cell_base_3<Traits>`,
which is appropriate for basic alpha shapes. which is appropriate for basic alpha shapes.
\cgalModels `FixedAlphaShapeCell_3` \cgalModels{FixedAlphaShapeCell_3}
\sa `Alpha_shape_cell_base_3` \sa `Alpha_shape_cell_base_3`
\sa `Delaunay_triangulation_cell_base_3` \sa `Delaunay_triangulation_cell_base_3`

2
Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_vertex_base_3.h
View File

@ -13,7 +13,7 @@ to the `Alpha_shape_3` class.
By default, it is instantiated with `Triangulation_vertex_base_3<Traits>`, By default, it is instantiated with `Triangulation_vertex_base_3<Traits>`,
which is appropriate for basic alpha shapes. which is appropriate for basic alpha shapes.
\cgalModels `FixedAlphaShapeVertex_3` \cgalModels{FixedAlphaShapeVertex_3}
\sa `Alpha_shape_vertex_base_3` \sa `Alpha_shape_vertex_base_3`
\sa `Triangulation_vertex_base_3` \sa `Triangulation_vertex_base_3`

2
Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h
View File

@ -46,7 +46,7 @@ ag.incident_edges(ag.infinite_vertex());
ag.incident_edges(ag.infinite_vertex(), f); ag.incident_edges(ag.infinite_vertex(), f);
\endcode \endcode
\cgalModels `DelaunayGraph_2` \cgalModels{DelaunayGraph_2}
\sa `CGAL::Apollonius_graph_traits_2<K,Method_tag>` \sa `CGAL::Apollonius_graph_traits_2<K,Method_tag>`
\sa `CGAL::Apollonius_graph_filtered_traits_2<CK,CM,EK,EM,FK,FM>` \sa `CGAL::Apollonius_graph_filtered_traits_2<CK,CM,EK,EM,FK,FM>`

2
Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h
View File

@ -37,7 +37,7 @@ The default values for the template parameters are as follows:
`FK = CGAL::Simple_cartesian<CGAL::Interval_nt<false> >`, `FK = CGAL::Simple_cartesian<CGAL::Interval_nt<false> >`,
`FM = CM`. `FM = CM`.
\cgalModels `ApolloniusGraphTraits_2` \cgalModels{ApolloniusGraphTraits_2}
\sa `Kernel` \sa `Kernel`
\sa `ApolloniusGraphTraits_2` \sa `ApolloniusGraphTraits_2`

2
Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h
View File

@ -11,7 +11,7 @@ vertex base required by the
`Apollonius_graph_hierarchy_vertex_base_2` is templated by a class `Agvb` which must be a model `Apollonius_graph_hierarchy_vertex_base_2` is templated by a class `Agvb` which must be a model
of the `ApolloniusGraphVertexBase_2` concept. of the `ApolloniusGraphVertexBase_2` concept.
\cgalModels `ApolloniusGraphHierarchyVertexBase_2` \cgalModels{ApolloniusGraphHierarchyVertexBase_2}
\sa `CGAL::Apollonius_graph_vertex_base_2<Gt,StoreHidden>` \sa `CGAL::Apollonius_graph_vertex_base_2<Gt,StoreHidden>`
\sa `CGAL::Triangulation_data_structure_2<Vb,Fb>` \sa `CGAL::Triangulation_data_structure_2<Vb,Fb>`

2
Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h
View File

@ -20,7 +20,7 @@ default value for `Method_tag` is `CGAL::Integral_domain_without_division_tag`.
The way the predicates are evaluated is discussed in The way the predicates are evaluated is discussed in
\cgalCite{cgal:ke-ppawv-02}, \cgalCite{cgal:ke-rctac-03}. \cgalCite{cgal:ke-ppawv-02}, \cgalCite{cgal:ke-rctac-03}.
\cgalModels `ApolloniusGraphTraits_2` \cgalModels{ApolloniusGraphTraits_2}
\sa `CGAL::Apollonius_graph_2<Gt,Agds>` \sa `CGAL::Apollonius_graph_2<Gt,Agds>`
\sa `CGAL::Apollonius_graph_filtered_traits_2<CK,CM,EK,EM,FK,FM>` \sa `CGAL::Apollonius_graph_filtered_traits_2<CK,CM,EK,EM,FK,FM>`

2
Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h
View File

@ -17,7 +17,7 @@ site can become visible. If `StoreHidden` is set to
`true`, hidden sites are stored, otherwise they are `true`, hidden sites are stored, otherwise they are
discarded. By default `StoreHidden` is set to `true`. discarded. By default `StoreHidden` is set to `true`.
\cgalModels `ApolloniusGraphVertexBase_2` \cgalModels{ApolloniusGraphVertexBase_2}
\sa `CGAL::Triangulation_data_structure_2<Vb,Fb>` \sa `CGAL::Triangulation_data_structure_2<Vb,Fb>`
\sa `CGAL::Apollonius_graph_hierarchy_vertex_base_2<Gt>` \sa `CGAL::Apollonius_graph_hierarchy_vertex_base_2<Gt>`

2
Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h
View File

@ -8,7 +8,7 @@ The class `Apollonius_site_2` is a model for the concept
`ApolloniusSite_2`. It is parametrized by a template parameter `ApolloniusSite_2`. It is parametrized by a template parameter
`K` which must be a model of the `Kernel` concept. `K` which must be a model of the `Kernel` concept.
\cgalModels `ApolloniusSite_2` \cgalModels{ApolloniusSite_2}
\cgalHeading{Types} \cgalHeading{Types}

3
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h
View File

@ -52,8 +52,7 @@ the `Are_mergeable_2` operation does not enforce the input curves
to have the same direction as a precondition. Moreover, `Arr_Bezier_curve_traits_2` to have the same direction as a precondition. Moreover, `Arr_Bezier_curve_traits_2`
supports the merging of curves of opposite directions. supports the merging of curves of opposite directions.
\cgalModels `ArrangementTraits_2` \cgalModels{ArrangementTraits_2,ArrangementDirectionalXMonotoneTraits_2}
\cgalModels `ArrangementDirectionalXMonotoneTraits_2`
*/ */

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h
View File

@ -22,7 +22,7 @@ the types `leda::integer` and `CORE::BigInt` are supported as well
as any instance of `CGAL::Sqrt_extension` that is instantiated with as any instance of `CGAL::Sqrt_extension` that is instantiated with
one of the integral types above. one of the integral types above.
\cgalModels `ArrangementTraits_2` \cgalModels{ArrangementTraits_2}
*/ */

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_bounded_planar_topology_traits_2.h
View File

@ -21,7 +21,7 @@ namespace CGAL {
* `Arr_default_dcel<Traits>`. * `Arr_default_dcel<Traits>`.
* </UL> * </UL>
* *
* \cgalModels `ArrangementBasicTopologyTraits` * \cgalModels{ArrangementBasicTopologyTraits}
* *
* \sa `Arr_default_dcel<Traits>` * \sa `Arr_default_dcel<Traits>`
* \sa `CGAL::Arr_geodesic_arc_on_sphere_traits_2<Kernel,x,y>` * \sa `CGAL::Arr_geodesic_arc_on_sphere_traits_2<Kernel,x,y>`

3
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h
View File

@ -32,8 +32,7 @@ namespace CGAL {
* same direction as a precondition. Moreover, `Arr_circle_segment_traits_2` * same direction as a precondition. Moreover, `Arr_circle_segment_traits_2`
* supports the merging of curves of opposite directions. * supports the merging of curves of opposite directions.
* *
* \cgalModels `ArrangementTraits_2` * \cgalModels{ArrangementTraits_2,ArrangementDirectionalXMonotoneTraits_2}
* \cgalModels `ArrangementDirectionalXMonotoneTraits_2`
* *
*/ */
template< typename Kernel > template< typename Kernel >

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_arc_traits_2.h
View File

@ -8,7 +8,7 @@ This class is a traits class for \cgal arrangements, built on top of a model of
concept `CircularKernel`. concept `CircularKernel`.
It provides curves of type `CGAL::Circular_arc_2<CircularKernel>`. It provides curves of type `CGAL::Circular_arc_2<CircularKernel>`.
\cgalModels `ArrangementTraits_2` \cgalModels{ArrangementTraits_2}
*/ */
template< typename CircularKernel > template< typename CircularKernel >

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circular_line_arc_traits_2.h
View File

@ -12,7 +12,7 @@ of both types
It uses the <A HREF="https://www.boost.org/doc/html/variant.html">boost::variant</A>. It uses the <A HREF="https://www.boost.org/doc/html/variant.html">boost::variant</A>.
\cgalModels `ArrangementTraits_2` \cgalModels{ArrangementTraits_2}
*/ */
template< typename CircularKernel > template< typename CircularKernel >

4
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h
View File

@ -80,9 +80,7 @@ namespace CGAL {
* to have the same direction as a precondition. Moreover, `Arr_conic_traits_2` * to have the same direction as a precondition. Moreover, `Arr_conic_traits_2`
* supports the merging of curves of opposite directions. * supports the merging of curves of opposite directions.
* *
* \cgalModels `ArrangementTraits_2` * \cgalModels{ArrangementTraits_2,ArrangementLandmarkTraits_2,ArrangementDirectionalXMonotoneTraits_2}
* \cgalModels `ArrangementLandmarkTraits_2`
* \cgalModels `ArrangementDirectionalXMonotoneTraits_2`
* *
* \cgalHeading{Types} * \cgalHeading{Types}
*/ */

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h
View File

@ -21,7 +21,7 @@ both resulting subcurves. In case two (or more) \f$ x\f$-monotone curves
overlap, their data sets are consolidated, and are inserted into the set overlap, their data sets are consolidated, and are inserted into the set
of the \f$ x\f$-monotone curve that represents the overlap. of the \f$ x\f$-monotone curve that represents the overlap.
\cgalModels `ArrangementTraits_2` \cgalModels{ArrangementTraits_2}
*/ */
template< typename Traits, typename Data > template< typename Traits, typename Data >

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h
View File

@ -49,7 +49,7 @@ namespace CGAL {
* `d1` and `d2`. The \f$ x\f$-monotone curve that represents the overlap is * `d1` and `d2`. The \f$ x\f$-monotone curve that represents the overlap is
* associated with the output of this functor. * associated with the output of this functor.
* *
* \cgalModels `ArrangementTraits_2` * \cgalModels{ArrangementTraits_2}
*/ */
template <typename Tr, typename XData, typename Mrg, typename CData, typename Cnv> template <typename Tr, typename XData, typename Mrg, typename CData, typename Cnv>
class Arr_curve_data_traits_2 : public Tr { class Arr_curve_data_traits_2 : public Tr {

8
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_dcel_base.h
View File

@ -16,7 +16,7 @@ must be instantiated with models of the concepts
`ArrangementDcelVertex`, `ArrangementDcelHalfedge`, `ArrangementDcelVertex`, `ArrangementDcelHalfedge`,
and `ArrangementDcelFace` respectively. and `ArrangementDcelFace` respectively.
\cgalModels `ArrangementDcel` \cgalModels{ArrangementDcel}
*/ */
template< typename V, typename H, typename F > template< typename V, typename H, typename F >
@ -29,7 +29,7 @@ public:
The basic \dcel face type. Serves as a basis class for an extended The basic \dcel face type. Serves as a basis class for an extended
face record with auxiliary data fields. face record with auxiliary data fields.
\cgalModels `ArrangementDcelFace` \cgalModels{ArrangementDcelFace}
*/ */
class Arr_face_base { class Arr_face_base {
@ -43,7 +43,7 @@ The basic \dcel halfedge type. Serves as a basis class for an
extended halfedge record with auxiliary data fields. The `Curve` extended halfedge record with auxiliary data fields. The `Curve`
parameter is the type of \f$ x\f$-monotone curves associated with the vertices. parameter is the type of \f$ x\f$-monotone curves associated with the vertices.
\cgalModels `ArrangementDcelHalfedge` \cgalModels{ArrangementDcelHalfedge}
*/ */
template< typename Curve > template< typename Curve >
@ -58,7 +58,7 @@ The basic \dcel vertex type. Serves as a basis class for an extended
vertex record with auxiliary data fields. The `Point` parameter is vertex record with auxiliary data fields. The `Point` parameter is
the type of points associated with the vertices. the type of points associated with the vertices.
\cgalModels `ArrangementDcelVertex` \cgalModels{ArrangementDcelVertex}
*/ */
template< typename Point > template< typename Point >

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_dcel.h
View File

@ -12,7 +12,7 @@ the base vertex and halfedge types, respectively. Thus, the default
\dcel records store no other information, except for the topological \dcel records store no other information, except for the topological
incidence relations and the geometric data attached to vertices and edges. incidence relations and the geometric data attached to vertices and edges.
\cgalModels `ArrangementDcelWithRebind` \cgalModels{ArrangementDcelWithRebind}
\sa `Arr_dcel_base<V,H,F>` \sa `Arr_dcel_base<V,H,F>`
*/ */

4
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_default_overlay_traits.h
View File

@ -10,7 +10,7 @@ of type `Arrangement` that store no auxiliary data with their \dcel records, whe
\dcel data as well. This class simply gives empty implementation for all \dcel data as well. This class simply gives empty implementation for all
traits-class functions. traits-class functions.
\cgalModels `OverlayTraits` \cgalModels{OverlayTraits}
\sa `overlay` \sa `overlay`
@ -43,7 +43,7 @@ it uses the functor `OvlFaceData`, which accepts a `FaceData_A` object
and a `FaceData_B` object and computes a corresponding `FaceData_R` and a `FaceData_B` object and computes a corresponding `FaceData_R`
object, in order to set the auxiliary data of the overlay face. object, in order to set the auxiliary data of the overlay face.
\cgalModels `OverlayTraits` \cgalModels{OverlayTraits}
\sa `overlay` \sa `overlay`
\sa `CGAL::Arr_face_extended_dcel<Traits,FData,V,H,F>` \sa `CGAL::Arr_face_extended_dcel<Traits,FData,V,H,F>`

10
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h
View File

@ -33,7 +33,7 @@ The default values follow:
</TABLE> </TABLE>
\cgalModels `ArrangementDcelWithRebind` \cgalModels{ArrangementDcelWithRebind}
\sa `Arr_dcel_base<V,H,F>` \sa `Arr_dcel_base<V,H,F>`
@ -57,7 +57,7 @@ The `Arr_extended_face` class-template extends the face topological-features of
\dcel. It is parameterized by a face base-type `FaceBase` and a data type \dcel. It is parameterized by a face base-type `FaceBase` and a data type
`FData` used to extend the face base-type. `FData` used to extend the face base-type.
\cgalModels `ArrangementDcelFace` \cgalModels{ArrangementDcelFace}
\sa `Arr_dcel_base<V,H,F>` \sa `Arr_dcel_base<V,H,F>`
@ -109,7 +109,7 @@ The `Arr_extended_halfedge` class-template extends the halfedge topological-feat
the \dcel. It is parameterized by a halfedge base-type `HalfedgeBase` the \dcel. It is parameterized by a halfedge base-type `HalfedgeBase`
and a data type `HData` used to extend the halfedge base-type. and a data type `HData` used to extend the halfedge base-type.
\cgalModels `ArrangementDcelHalfedge` \cgalModels{ArrangementDcelHalfedge}
\sa `Arr_dcel_base<V,H,F>` \sa `Arr_dcel_base<V,H,F>`
@ -162,7 +162,7 @@ topological-features of the \dcel. It is parameterized by a
vertex base-type `VertexBase` and a data type `VData` used to extend vertex base-type `VertexBase` and a data type `VData` used to extend
the vertex base-type. the vertex base-type.
\cgalModels `ArrangementDcelVertex` \cgalModels{ArrangementDcelVertex}
\sa `Arr_dcel_base<V,H,F>` \sa `Arr_dcel_base<V,H,F>`
@ -235,7 +235,7 @@ as follows:
</TABLE> </TABLE>
\cgalModels `ArrangementDcelWithRebind` \cgalModels{ArrangementDcelWithRebind}
\sa `Arr_dcel_base<V,H,F>` \sa `Arr_dcel_base<V,H,F>`

5
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h
View File

@ -19,10 +19,7 @@ existing faces might be removed, the notification mechanism is used
to dynamically maintain the mapping of face handles to indices. to dynamically maintain the mapping of face handles to indices.
\cgalModels DefaultConstructible \cgalModels{DefaultConstructible,CopyConstructible,Assignable,ReadablePropertyMap}
\cgalModels CopyConstructible
\cgalModels Assignable
\cgalModels `ReadablePropertyMap`
\sa `Arr_observer<Arrangement>` \sa `Arr_observer<Arrangement>`
\sa `Arr_vertex_index_map<Arrangement>` \sa `Arr_vertex_index_map<Arrangement>`

29
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_geodesic_arc_on_sphere_traits_2.h
View File

@ -39,9 +39,7 @@ namespace CGAL {
* normalized vector \f$(x,y)\f$ in the \f$xy\f$-plane that bisects the * normalized vector \f$(x,y)\f$ in the \f$xy\f$-plane that bisects the
* identification curve. * identification curve.
* \cgalModels `ArrangementTraits_2` * \cgalModels{ArrangementTraits_2,ArrangementLandmarkTraits_2,ArrangementSphericalBoundaryTraits_2}
* \cgalModels `ArrangementLandmarkTraits_2`
* \cgalModels `ArrangementSphericalBoundaryTraits_2`
*/ */
template <typename Kernel, typename X, typename Y> template <typename Kernel, typename X, typename Y>
@ -52,9 +50,7 @@ namespace CGAL {
* not-necessarily normalized 3D direction extended with information that * not-necessarily normalized 3D direction extended with information that
* specifies the location of the point pre-image in the parameter space. * specifies the location of the point pre-image in the parameter space.
* *
* \cgalModels `Assignable` * \cgalModels{Assignable,DefaultConstructible,CopyConstructible}
* \cgalModels `DefaultConstructible`
* \cgalModels `CopyConstructible`
*/ */
class Point_2 { class Point_2 {
public: public:
@ -118,9 +114,7 @@ namespace CGAL {
* intersect the identified left and right sides of the boundary of the * intersect the identified left and right sides of the boundary of the
* parameter space. * parameter space.
* *
* \cgalModels `Assignable` * \cgalModels{Assignable,DefaultConstructible,CopyConstructible}
* \cgalModels `DefaultConstructible`
* \cgalModels `CopyConstructible`
*/ */
class X_monotone_curve_2 { class X_monotone_curve_2 {
public: public:
@ -287,10 +281,7 @@ namespace CGAL {
/*! Construction functor of a point. /*! Construction functor of a point.
* *
* \cgalModels `Assignable` * \cgalModels{Assignable,CopyConstructible,AdaptableUnaryFunction,AdaptableTernaryFunction}
* \cgalModels `CopyConstructible`
* \cgalModels `AdaptableUnaryFunction`
* \cgalModels `AdaptableTernaryFunction`
*/ */
/*! /*!
*/ */
@ -325,11 +316,7 @@ namespace CGAL {
/*! Construction functor of \f$x\f$-monotone geodesic arcs. /*! Construction functor of \f$x\f$-monotone geodesic arcs.
* *
* \cgalModels `Assignable` * \cgalModels{Assignable,CopyConstructible,AdaptableUnaryFunction,AdaptableBinaryFunction,AdaptableTernaryFunction}
* \cgalModels `CopyConstructible`
* \cgalModels `AdaptableUnaryFunction`
* \cgalModels `AdaptableBinaryFunction`
* \cgalModels `AdaptableTernaryFunction`
*/ */
class Construct_x_monotone_curve_2 { class Construct_x_monotone_curve_2 {
public: public:
@ -393,11 +380,7 @@ namespace CGAL {
/*! Construction functor of geodesic arcs. /*! Construction functor of geodesic arcs.
* *
* \cgalModels `Assignable` * \cgalModels{Assignable,CopyConstructible,AdaptableUnaryFunction,AdaptableBinaryFunction,AdaptableTernaryFunction}
* \cgalModels `CopyConstructible`
* \cgalModels `AdaptableUnaryFunction`
* \cgalModels `AdaptableBinaryFunction`
* \cgalModels `AdaptableTernaryFunction`
*/ */
class Construct_curve_2 { class Construct_curve_2 {
public: public:

3
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_landmarks_point_location.h
View File

@ -47,8 +47,7 @@ when the application frequently issues point-location queries on a
rather static arrangement that the changes applied to it are mainly rather static arrangement that the changes applied to it are mainly
insertions of curves and not deletions of them. insertions of curves and not deletions of them.
\cgalModels `ArrangementPointLocation_2` \cgalModels{ArrangementPointLocation_2,ArrangementVerticalRayShoot_2}
\cgalModels `ArrangementVerticalRayShoot_2`
\sa `ArrangementPointLocation_2` \sa `ArrangementPointLocation_2`
\sa `ArrangementVerticalRayShoot_2` \sa `ArrangementVerticalRayShoot_2`

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_line_arc_traits_2.h
View File

@ -8,7 +8,7 @@ This class is a traits class for \cgal arrangements, built on top of a
model of concept `CircularKernel`. It provides curves of type model of concept `CircularKernel`. It provides curves of type
`CGAL::Line_arc_2<CircularKernel>`. `CGAL::Line_arc_2<CircularKernel>`.
\cgalModels `ArrangementTraits_2` \cgalModels{ArrangementTraits_2}
*/ */
template< typename CircularKernel > template< typename CircularKernel >

4
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h
View File

@ -21,9 +21,7 @@ namespace CGAL {
* we can find out its actual type and convert it to the respective kernel * we can find out its actual type and convert it to the respective kernel
* object (say, to a `Kernel::Ray_2`). * object (say, to a `Kernel::Ray_2`).
* *
* \cgalModels `ArrangementTraits_2` * \cgalModels{ArrangementTraits_2,ArrangementLandmarkTraits_2,ArrangementOpenBoundaryTraits_2}
* \cgalModels `ArrangementLandmarkTraits_2`
* \cgalModels `ArrangementOpenBoundaryTraits_2`
*/ */
template< typename Kernel > template< typename Kernel >
class Arr_linear_traits_2 { class Arr_linear_traits_2 {

3
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_naive_point_location.h
View File

@ -13,8 +13,7 @@ The query time is therefore linear in the complexity of the arrangement.
Naturally, this point-location strategy could turn into a heavy Naturally, this point-location strategy could turn into a heavy
time-consuming process when applied to dense arrangements. time-consuming process when applied to dense arrangements.
\cgalModels `ArrangementPointLocation_2` \cgalModels{ArrangementPointLocation_2,ArrangementVerticalRayShoot_2}
\cgalModels `ArrangementVerticalRayShoot_2`
\sa `ArrangementPointLocation_2` \sa `ArrangementPointLocation_2`
\sa `ArrangementVerticalRayShoot_2` \sa `ArrangementVerticalRayShoot_2`

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_basic_traits_2.h
View File

@ -21,7 +21,7 @@ instantiations for the kernel. Using other (inexact) number types
`Simple_cartesian<double>`) is also possible, at the user's own `Simple_cartesian<double>`) is also possible, at the user's own
risk. risk.
\cgalModels `ArrangementLandmarkTraits_2` \cgalModels{ArrangementLandmarkTraits_2}
*/ */
template< typename Kernel > template< typename Kernel >

4
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h
View File

@ -32,9 +32,7 @@ the `Are_mergeable_2` operation does not enforce the input curves
to have the same direction as a precondition. Moreover, `Arr_non_caching_segment_traits_2` to have the same direction as a precondition. Moreover, `Arr_non_caching_segment_traits_2`
supports the merging of curves of opposite directions. supports the merging of curves of opposite directions.
\cgalModels `ArrangementTraits_2` \cgalModels{ArrangementTraits_2,ArrangementLandmarkTraits_2,ArrangementDirectionalXMonotoneTraits_2}
\cgalModels `ArrangementLandmarkTraits_2`
\cgalModels `ArrangementDirectionalXMonotoneTraits_2`
\sa `Arr_segment_traits_2<Kernel>` \sa `Arr_segment_traits_2<Kernel>`

7
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polycurve_traits_2.h
View File

@ -72,10 +72,9 @@ namespace CGAL {
* set the macro `CGAL_ALWAYS_LEFT_TO_RIGHT` to 1 before any \cgal header is * set the macro `CGAL_ALWAYS_LEFT_TO_RIGHT` to 1 before any \cgal header is
* included. * included.
* *
* \cgalModels `ArrangementTraits_2` * \cgalModels{ArrangementTraits_2,ArrangementDirectionalXMonotoneTraits_2,
* \cgalModels `ArrangementDirectionalXMonotoneTraits_2` * ArrangementApproximateTraits_2 (if the type that substitutes
* \cgalModels `ArrangementApproximateTraits_2` (if the type that substitutes * the template parameter `SubcurveTraits_2` models the concept as well)}
* the template parameter `SubcurveTraits_2` models the concept as well)
* *
* \sa `Arr_algebraic_segment_traits_2<Coefficient>` * \sa `Arr_algebraic_segment_traits_2<Coefficient>`
* \sa `Arr_Bezier_curve_traits_2<RatKernel, AlgKernel, NtTraits>` * \sa `Arr_Bezier_curve_traits_2<RatKernel, AlgKernel, NtTraits>`

9
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h
View File

@ -77,12 +77,9 @@ namespace CGAL {
* the macro `CGAL_ALWAYS_LEFT_TO_RIGHT` to 1 before any \cgal header is * the macro `CGAL_ALWAYS_LEFT_TO_RIGHT` to 1 before any \cgal header is
* included. * included.
* *
* \cgalModels `ArrangementTraits_2` * \cgalModels{ArrangementTraits_2,ArrangementDirectionalXMonotoneTraits_2,`ArrangementConstructXMonotoneCurveTraits_2`
* \cgalModels `ArrangementDirectionalXMonotoneTraits_2` * ArrangementConstructCurveTraits_2,ArrangementApproximateTraits_2 (if the type that substitutes
* \cgalModels `ArrangementConstructXMonotoneCurveTraits_2` * the template parameter `SegmentTraits_2` models the concept as well)}
* \cgalModels `ArrangementConstructCurveTraits_2`
* \cgalModels `ArrangementApproximateTraits_2` (if the type that substitutes
* the template parameter `SegmentTraits_2` models the concept as well)
* *
* \sa `Arr_polycurve_traits_2<SubcurveTraits_2>` * \sa `Arr_polycurve_traits_2<SubcurveTraits_2>`
* \sa `Arr_Bezier_curve_traits_2<RatKernel, AlgKernel, NtTraits>` * \sa `Arr_Bezier_curve_traits_2<RatKernel, AlgKernel, NtTraits>`

20
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h
View File

@ -52,9 +52,7 @@ namespace CGAL {
to have the same direction as a precondition. Moreover, `Arr_rational_function_traits_2` to have the same direction as a precondition. Moreover, `Arr_rational_function_traits_2`
supports the merging of curves of opposite directions. supports the merging of curves of opposite directions.
\cgalModels `ArrangementTraits_2` \cgalModels{ArrangementTraits_2,ArrangementDirectionalXMonotoneTraits_2,ArrangementOpenBoundaryTraits_2}
\cgalModels `ArrangementDirectionalXMonotoneTraits_2`
\cgalModels `ArrangementOpenBoundaryTraits_2`
*/ */
template< typename AlgebraicKernel_d_1 > template< typename AlgebraicKernel_d_1 >
class Arr_rational_function_traits_2 { class Arr_rational_function_traits_2 {
@ -134,10 +132,7 @@ Functor to construct a `Curve_2`. To enable caching the class is not
default constructible and must be obtained via the function default constructible and must be obtained via the function
`construct_curve_2_object()`, which is a member of the traits. `construct_curve_2_object()`, which is a member of the traits.
\cgalModels `Assignable` \cgalModels{Assignable,CopyConstructible,AdaptableBinaryFunction,AdaptableUnaryFunction}
\cgalModels `CopyConstructible`
\cgalModels `AdaptableBinaryFunction`
\cgalModels `AdaptableUnaryFunction`
*/ */
class Construct_curve_2 { class Construct_curve_2 {
@ -289,10 +284,7 @@ Functor to construct a `X_monotone_curve_2`. To enable caching the class
is not default constructible and must be obtained via the function is not default constructible and must be obtained via the function
`construct_x_monotone_curve_2_object()`, which is a member of the traits. `construct_x_monotone_curve_2_object()`, which is a member of the traits.
\cgalModels `Assignable` \cgalModels{Assignable,CopyConstructible,AdaptableBinaryFunction,AdaptableUnaryFunction}
\cgalModels `CopyConstructible`
\cgalModels `AdaptableBinaryFunction`
\cgalModels `AdaptableUnaryFunction`
*/ */
class Construct_x_monotone_curve_2 { class Construct_x_monotone_curve_2 {
@ -460,7 +452,7 @@ const Algebraic_real_1& lower, const Algebraic_real_1& upper); const
The `Curve_2` class nested within the traits is used The `Curve_2` class nested within the traits is used
to represent rational functions which may be restricted to a certain x-range. to represent rational functions which may be restricted to a certain x-range.
\cgalModels `ArrTraits::Curve_2` \cgalModels{ArrTraits::Curve_2}
*/ */
class Curve_2 { class Curve_2 {
@ -531,7 +523,7 @@ Algebraic_real_1 right_x() const;
/*! /*!
\cgalModels `ArrTraits::Point_2` \cgalModels{ArrTraits::Point_2}
*/ */
class Point_2 { class Point_2 {
@ -633,7 +625,7 @@ The `X_monotone_curve_2` class nested within the traits is used
to represent \f$ x\f$-monotone parts of rational functions. In particular, such an \f$ x\f$-monotone curve to represent \f$ x\f$-monotone parts of rational functions. In particular, such an \f$ x\f$-monotone curve
may not contain a vertical asymptote in its interior \f$ x\f$-range. may not contain a vertical asymptote in its interior \f$ x\f$-range.
\cgalModels `ArrTraits::XMonotoneCurve_2` \cgalModels{ArrTraits::XMonotoneCurve_2}
*/ */
class X_monotone_curve_2 { class X_monotone_curve_2 {

4
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_segment_traits_2.h
View File

@ -52,9 +52,7 @@ namespace CGAL {
* same direction as a precondition. Moreover, `Arr_segment_traits_2` supports * same direction as a precondition. Moreover, `Arr_segment_traits_2` supports
* the merging of curves of opposite directions. * the merging of curves of opposite directions.
* *
* \cgalModels `ArrangementTraits_2` * \cgalModels{ArrangementTraits_2,ArrangementLandmarkTraits_2,ArrangementDirectionalXMonotoneTraits_2}
* \cgalModels `ArrangementLandmarkTraits_2`
* \cgalModels `ArrangementDirectionalXMonotoneTraits_2`
*/ */
template <typename Kernel> template <typename Kernel>
class Arr_segment_traits_2 : public Kernel { class Arr_segment_traits_2 : public Kernel {

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_spherical_topology_traits_2.h
View File

@ -21,7 +21,7 @@ namespace CGAL {
* `Arr_default_dcel<Traits>`. * `Arr_default_dcel<Traits>`.
* </UL> * </UL>
* *
* \cgalModels `ArrangementBasicTopologyTraits` * \cgalModels{ArrangementBasicTopologyTraits}
* *
* \sa `Arr_default_dcel<Traits>` * \sa `Arr_default_dcel<Traits>`
* \sa `CGAL::Arr_geodesic_arc_on_sphere_traits_2<Kernel,x,y>` * \sa `CGAL::Arr_geodesic_arc_on_sphere_traits_2<Kernel,x,y>`

3
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h
View File

@ -26,8 +26,7 @@ is relatively large.
This strategy supports arbitrary subdivisions, including unbounded ones. This strategy supports arbitrary subdivisions, including unbounded ones.
\cgalModels `ArrangementPointLocation_2` \cgalModels{ArrangementPointLocation_2,ArrangementVerticalRayShoot_2}
\cgalModels `ArrangementVerticalRayShoot_2`
\sa `ArrangementPointLocation_2` \sa `ArrangementPointLocation_2`
\sa `ArrangementVerticalRayShoot_2` \sa `ArrangementVerticalRayShoot_2`

3
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_triangulation_point_location.h
View File

@ -15,8 +15,7 @@ namespace CGAL {
* (especially when the number of modifications applied to the arrangement is * (especially when the number of modifications applied to the arrangement is
* high) and provided only for educational purposes. * high) and provided only for educational purposes.
* *
* \cgalModels `ArrangementPointLocation_2` * \cgalModels{ArrangementPointLocation_2,ArrangementVerticalRayShoot_2}
* \cgalModels `ArrangementVerticalRayShoot_2`
* *
* \sa `ArrangementPointLocation_2` * \sa `ArrangementPointLocation_2`
* \sa `ArrangementVerticalRayShoot_2` * \sa `ArrangementVerticalRayShoot_2`

2
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_unb_planar_topology_traits_2.h
View File

@ -21,7 +21,7 @@ namespace CGAL {
* `Arr_default_dcel<Traits>`. * `Arr_default_dcel<Traits>`.
* </UL> * </UL>
* *
* \cgalModels `ArrangementBasicTopologyTraits` * \cgalModels{ArrangementBasicTopologyTraits}
* *
* \sa `Arr_default_dcel<Traits>` * \sa `Arr_default_dcel<Traits>`
* \sa `CGAL::Arr_geodesic_arc_on_sphere_traits_2<Kernel,x,y>` * \sa `CGAL::Arr_geodesic_arc_on_sphere_traits_2<Kernel,x,y>`

5
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h
View File

@ -19,10 +19,7 @@ existing vertices might be removed, the notification mechanism is used
to dynamically maintain the mapping of vertex handles to indices. to dynamically maintain the mapping of vertex handles to indices.
\cgalModels DefaultConstructible \cgalModels{DefaultConstructible,CopyConstructible,Assignable,ReadablePropertyMap}
\cgalModels CopyConstructible
\cgalModels Assignable
\cgalModels `ReadablePropertyMap`
\sa `Arr_observer<Arrangement>` \sa `Arr_observer<Arrangement>`
\sa `Arr_face_index_map<Arrangement>` \sa `Arr_face_index_map<Arrangement>`

3
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_walk_along_line_point_location.h
View File

@ -23,8 +23,7 @@ It is therefore recommended to use the "walk" point-location strategy
for arrangements that are constantly changing, especially if the number for arrangements that are constantly changing, especially if the number
of issued queries is not large. of issued queries is not large.
\cgalModels `ArrangementPointLocation_2` \cgalModels{ArrangementPointLocation_2,ArrangementVerticalRayShoot_2}
\cgalModels `ArrangementVerticalRayShoot_2`
\sa `ArrangementPointLocation_2` \sa `ArrangementPointLocation_2`
\sa `ArrangementVerticalRayShoot_2` \sa `ArrangementVerticalRayShoot_2`

9
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h
View File

@ -18,8 +18,7 @@ defined by the `Arrangement` template-parameter, as well as the `VertexData`,
`HalfedgeData` and `FaceData` types, can all be written to an input stream using `HalfedgeData` and `FaceData` types, can all be written to an input stream using
the `<<` operator and read from an input stream using the `>>` operator. the `<<` operator and read from an input stream using the `>>` operator.
\cgalModels `ArrangementInputFormatter` \cgalModels{ArrangementInputFormatter,ArrangementOutputFormatter}
\cgalModels `ArrangementOutputFormatter`
\sa `PkgArrangementOnSurface2Read` \sa `PkgArrangementOnSurface2Read`
\sa `PkgArrangementOnSurface2Write` \sa `PkgArrangementOnSurface2Write`
@ -50,8 +49,7 @@ The `Arr_face_extended_text_formatter` class assumes that the nested `Point_2` a
defined by the `Arrangement` template-parameter and that the `FaceData` type defined by the `Arrangement` template-parameter and that the `FaceData` type
can all be written to an input stream using the `<<` operator and read from an input stream using the `>>` operator. can all be written to an input stream using the `<<` operator and read from an input stream using the `>>` operator.
\cgalModels `ArrangementInputFormatter` \cgalModels{ArrangementInputFormatter,ArrangementOutputFormatter}
\cgalModels `ArrangementOutputFormatter`
\sa `PkgArrangementOnSurface2Read` \sa `PkgArrangementOnSurface2Read`
\sa `PkgArrangementOnSurface2Write` \sa `PkgArrangementOnSurface2Write`
@ -81,8 +79,7 @@ defined by the `Arrangement` template-parameter can both be written to an input
stream using the `<<` operator and read from an input stream using the `>>` stream using the `<<` operator and read from an input stream using the `>>`
operator. operator.
\cgalModels `ArrangementInputFormatter` \cgalModels{ArrangementInputFormatter,ArrangementOutputFormatter}
\cgalModels `ArrangementOutputFormatter`
\sa `PkgArrangementOnSurface2Read` \sa `PkgArrangementOnSurface2Read`
\sa `PkgArrangementOnSurface2Write` \sa `PkgArrangementOnSurface2Write`

3
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h
View File

@ -15,8 +15,7 @@ the base arrangement, while the derived class is responsible for reading and
writing the set of curves inducing the arrangement and maintaining the writing the set of curves inducing the arrangement and maintaining the
relations between these curves and the edges they induce. relations between these curves and the edges they induce.
\cgalModels `ArrangementWithHistoryInputFormatter` \cgalModels{ArrangementWithHistoryInputFormatter,ArrangementWithHistoryOutputFormatter}
\cgalModels `ArrangementWithHistoryOutputFormatter`
\sa `PkgArrangementOnSurface2Read` \sa `PkgArrangementOnSurface2Read`
\sa `PkgArrangementOnSurface2Write` \sa `PkgArrangementOnSurface2Write`

2
BGL/doc/BGL/CGAL/HalfedgeDS_face_max_base_with_id.h
View File

@ -19,7 +19,7 @@ running a graph algorithm.
\tparam Refs must be an instantiation of a `HalfedgeDS`. \tparam Refs must be an instantiation of a `HalfedgeDS`.
\cgalModels `HalfedgeDSFace` \cgalModels{HalfedgeDSFace}
\sa `HalfedgeDS<Traits,Items,Alloc>` \sa `HalfedgeDS<Traits,Items,Alloc>`
\sa `HalfedgeDSItems` \sa `HalfedgeDSItems`

2
BGL/doc/BGL/CGAL/HalfedgeDS_halfedge_max_base_with_id.h
View File

@ -17,7 +17,7 @@ running a graph algorithm.
\tparam Refs must be an instantiation of a `HalfedgeDS`. \tparam Refs must be an instantiation of a `HalfedgeDS`.
\cgalModels `HalfedgeDSHalfedge` \cgalModels{HalfedgeDSHalfedge}
\sa `HalfedgeDS<Traits,Items,Alloc>` \sa `HalfedgeDS<Traits,Items,Alloc>`
\sa `HalfedgeDSItems` \sa `HalfedgeDSItems`

2
BGL/doc/BGL/CGAL/HalfedgeDS_vertex_max_base_with_id.h
View File

@ -17,7 +17,7 @@ running a graph algorithm.
\tparam Refs must be an instantiation of a `HalfedgeDS`. \tparam Refs must be an instantiation of a `HalfedgeDS`.
\cgalModels `HalfedgeDSVertex` \cgalModels{HalfedgeDSVertex}
\sa `HalfedgeDS<Traits,Items,Alloc>` \sa `HalfedgeDS<Traits,Items,Alloc>`
\sa `HalfedgeDSItems` \sa `HalfedgeDSItems`

2
BGL/doc/BGL/CGAL/Linear_cell_complex_bgl_min_items.h
View File

@ -6,7 +6,7 @@ namespace CGAL {
The class `Linear_cell_complex_bgl_min_items` defines `void` as the information associated with darts, darts have ids and 0- and 2-attributes are enabled and have ids. The class `Linear_cell_complex_bgl_min_items` defines `void` as the information associated with darts, darts have ids and 0- and 2-attributes are enabled and have ids.
\cgalModels `LinearCellComplexItems` \cgalModels{LinearCellComplexItems}
\cgalHeading{Example} \cgalHeading{Example}

2
BGL/doc/BGL/CGAL/Polyhedron_items_with_id_3.h
View File

@ -13,7 +13,7 @@ the point and the plane equation.
Vertices and facets both contain a halfedge handle to an incident Vertices and facets both contain a halfedge handle to an incident
halfedge. halfedge.
\cgalModels `PolyhedronItems_3` \cgalModels{PolyhedronItems_3}
\cgalHeading{Operations} \cgalHeading{Operations}

2
BGL/doc/BGL/CGAL/Triangulation_face_base_with_id_2.h
View File

@ -19,7 +19,7 @@ and must be a model of `TriangulationTraits_2`.
`Triangulation_face_base_with_id_2` derives. It has the default `Triangulation_face_base_with_id_2` derives. It has the default
value `Triangulation_face_base_2<TriangulationTraits_2>`. value `Triangulation_face_base_2<TriangulationTraits_2>`.
\cgalModels `TriangulationFaceBase_2` \cgalModels{TriangulationFaceBase_2}
\sa `CGAL::Triangulation_face_base_2` \sa `CGAL::Triangulation_face_base_2`
*/ */

2
BGL/doc/BGL/CGAL/Triangulation_vertex_base_with_id_2.h
View File

@ -19,7 +19,7 @@ and must be a model of `TriangulationTraits_2`.
`Triangulation_vertex_base_with_id_2` derives. It has the default `Triangulation_vertex_base_with_id_2` derives. It has the default
value `Triangulation_vertex_base_2<TriangulationTraits_2>`. value `Triangulation_vertex_base_2<TriangulationTraits_2>`.
\cgalModels `TriangulationVertexBase_2` \cgalModels{TriangulationVertexBase_2}
\sa `CGAL::Triangulation_vertex_base_2` \sa `CGAL::Triangulation_vertex_base_2`
*/ */

10
BGL/doc/BGL/CGAL/boost/graph/properties.h
View File

@ -6,31 +6,31 @@ namespace CGAL {
/// The constant `vertex_index` is a property tag which identifies the <i>index</i> property of a vertex of a \bgl /// The constant `vertex_index` is a property tag which identifies the <i>index</i> property of a vertex of a \bgl
/// <a href="https://www.boost.org/libs/graph/doc/Graph.html"><code>Graph</code></a>. /// <a href="https://www.boost.org/libs/graph/doc/Graph.html"><code>Graph</code></a>.
/// \cgalModels <a href="https://www.boost.org/libs/graph/doc/PropertyTag.html"><code>PropertyTag</code></a> /// \cgalModelsBare{<a href="https://www.boost.org/libs/graph/doc/PropertyTag.html"><code>PropertyTag</code></a>}
enum vertex_index_t { vertex_index }; enum vertex_index_t { vertex_index };
/// The constant `halfedge_index` is a property tag which identifies the <i>index</i> property of a halfedge of a `HalfedgeGraph`. /// The constant `halfedge_index` is a property tag which identifies the <i>index</i> property of a halfedge of a `HalfedgeGraph`.
/// ///
/// This is a property tag introduced by \cgal. /// This is a property tag introduced by \cgal.
/// \cgalModels <a href="https://www.boost.org/libs/graph/doc/PropertyTag.html"><code>PropertyTag</code></a> /// \cgalModelsBare{<a href="https://www.boost.org/libs/graph/doc/PropertyTag.html"><code>PropertyTag</code></a>}
enum halfedge_index_t { halfedge_index }; enum halfedge_index_t { halfedge_index };
/// The constant `edge_index` is a property tag which identifies the <i>index</i> property of an edge of a \bgl /// The constant `edge_index` is a property tag which identifies the <i>index</i> property of an edge of a \bgl
/// <a href="https://www.boost.org/libs/graph/doc/Graph.html"><code>Graph</code></a>. /// <a href="https://www.boost.org/libs/graph/doc/Graph.html"><code>Graph</code></a>.
/// \cgalModels <a href="https://www.boost.org/libs/graph/doc/PropertyTag.html"><code>PropertyTag</code></a> /// \cgalModelsBare{<a href="https://www.boost.org/libs/graph/doc/PropertyTag.html"><code>PropertyTag</code></a>}
enum edge_index_t { edge_index }; enum edge_index_t { edge_index };
/// The constant `face_index` is a property tag which identifies the <i>index</i> property of a face of a `FaceGraph`. /// The constant `face_index` is a property tag which identifies the <i>index</i> property of a face of a `FaceGraph`.
/// ///
/// This is a property tag introduced by \cgal. /// This is a property tag introduced by \cgal.
/// \cgalModels <a href="https://www.boost.org/libs/graph/doc/PropertyTag.html"><code>PropertyTag</code></a> /// \cgalModelsBare{<a href="https://www.boost.org/libs/graph/doc/PropertyTag.html"><code>PropertyTag</code></a>}
enum face_index_t { face_index }; enum face_index_t { face_index };
/// The constant `vertex_point` is a property tag which refers to the geometric embedding property of /// The constant `vertex_point` is a property tag which refers to the geometric embedding property of
/// a vertex of a `HalfedgeGraph`. /// a vertex of a `HalfedgeGraph`.
/// ///
/// This is a property tag introduced by \cgal. /// This is a property tag introduced by \cgal.
/// \cgalModels <a href="https://www.boost.org/libs/graph/doc/PropertyTag.html"><code>PropertyTag</code></a> /// \cgalModelsBare{<a href="https://www.boost.org/libs/graph/doc/PropertyTag.html"><code>PropertyTag</code></a>}
enum vertex_point_t { vertex_point }; enum vertex_point_t { vertex_point };
/// @} /// @}

2
BGL/include/CGAL/boost/graph/Dual.h
View File

@ -44,7 +44,7 @@ error.
\tparam Primal_ must be a model of `FaceGraph` \tparam Primal_ must be a model of `FaceGraph`
\cgalModels `FaceGraph` \cgalModels{FaceGraph}
*/ */
template <typename Primal_> template <typename Primal_>

4
BGL/include/CGAL/boost/graph/Face_filtered_graph.h
View File

@ -66,9 +66,7 @@ namespace CGAL {
* \tparam VIMap a model of `ReadablePropertyMap` with `graph_traits<Graph>::%vertex_descriptor` as key and `graph_traits<Graph>::%vertices_size_type` as value * \tparam VIMap a model of `ReadablePropertyMap` with `graph_traits<Graph>::%vertex_descriptor` as key and `graph_traits<Graph>::%vertices_size_type` as value
* \tparam HIMap a model of `ReadablePropertyMap` with `graph_traits<Graph>::%halfedge_descriptor` as key and `graph_traits<Graph>::%halfedges_size_type` as value * \tparam HIMap a model of `ReadablePropertyMap` with `graph_traits<Graph>::%halfedge_descriptor` as key and `graph_traits<Graph>::%halfedges_size_type` as value
* *
* \cgalModels `FaceListGraph` * \cgalModels{FaceListGraph,HalfedgeListGraph,\bgllink{VertexListGraph}}
* \cgalModels `HalfedgeListGraph`
* \cgalModels \bgllink{VertexListGraph}
*/ */
template<typename Graph, template<typename Graph,
typename FIMap = Default, typename FIMap = Default,

6
BGL/include/CGAL/boost/graph/Graph_with_descriptor_with_graph.h
View File

@ -115,9 +115,7 @@ All internal properties of the underlying graph are forwarded.
Property maps can be wrapped with `Graph_with_descriptor_with_graph_property_map`. Property maps can be wrapped with `Graph_with_descriptor_with_graph_property_map`.
\tparam Graph must be a model of a `FaceListGraph` and `HalfedgeListGraph`. \tparam Graph must be a model of a `FaceListGraph` and `HalfedgeListGraph`.
\cgalModels `FaceListGraph` \cgalModels{FaceListGraph,HalfedgeListGraph,MutableFaceGraph if `Graph` is a model of `MutableFaceGraph`}
\cgalModels `HalfedgeListGraph`
\cgalModels `MutableFaceGraph` if `Graph` is a model of `MutableFaceGraph`
*/ */
template<typename Graph_> template<typename Graph_>
@ -689,7 +687,7 @@ is_valid(const Graph_with_descriptor_with_graph<Graph> & w, bool verbose = false
\ingroup PkgBGLAdaptors \ingroup PkgBGLAdaptors
`Graph_with_descriptor_with_graph_property_map` enables to forward properties from a `Graph_with_descriptor_with_graph_property_map` enables to forward properties from a
`Graph` to a `Graph_with_descriptor_with_graph`. `Graph` to a `Graph_with_descriptor_with_graph`.
\cgalModels `Graph_with_descriptor_with_graph_property_map` the same property map concept as `PM` \cgalModels{Graph_with_descriptor_with_graph_property_map the same property map concept as `PM`}
@tparam Graph a model of the `FaceListGraph` and `HalfedgeListGraph` concepts. @tparam Graph a model of the `FaceListGraph` and `HalfedgeListGraph` concepts.
@tparam PM a property_map of a `Graph`. @tparam PM a property_map of a `Graph`.

15
BGL/include/CGAL/boost/graph/Seam_mesh.h
View File

@ -185,7 +185,7 @@ public:
/// a border edge (that is, such that either halfedge or the edge have null_face() /// a border edge (that is, such that either halfedge or the edge have null_face()
/// as incident face). Marking a border edge as seam will not do anything. /// as incident face). Marking a border edge as seam will not do anything.
/// ///
/// \cgalModels `FaceGraph` or `FaceListGraph`, depending on the underlying mesh `TM`. /// \cgalModels{FaceGraph or `FaceListGraph` depending on the underlying mesh `TM`.}
/// ///
/// \tparam TM a model of `FaceGraph` or `FaceListGraph` /// \tparam TM a model of `FaceGraph` or `FaceListGraph`
/// \tparam SEM a model of `ReadablePropertyMap` with `boost::graph_traits<TM>::%edge_descriptor` as key type and `bool` as value type. /// \tparam SEM a model of `ReadablePropertyMap` with `boost::graph_traits<TM>::%edge_descriptor` as key type and `bool` as value type.
@ -271,9 +271,7 @@ public:
/// Implementation note: a halfedge of the seam mesh is represented as a halfedge /// Implementation note: a halfedge of the seam mesh is represented as a halfedge
/// of the mesh and a boolean to indicate whether the halfedge is on a seam or not. /// of the mesh and a boolean to indicate whether the halfedge is on a seam or not.
/// ///
/// \cgalModels `Descriptor` /// \cgalModels{Descriptor,LessThanComparable,Hashable}
/// \cgalModels `LessThanComparable`
/// \cgalModels `Hashable`
/// ///
class halfedge_descriptor class halfedge_descriptor
{ {
@ -356,9 +354,7 @@ public:
/// Implementation note: to properly duplicate vertices that are on seams, /// Implementation note: to properly duplicate vertices that are on seams,
/// a vertex_descriptor is in fact represented as a halfedge of the seam mesh. /// a vertex_descriptor is in fact represented as a halfedge of the seam mesh.
/// ///
/// \cgalModels `Descriptor` /// \cgalModels{Descriptor,LessThanComparable,Hashable}
/// \cgalModels `LessThanComparable`
/// \cgalModels `Hashable`
/// ///
class vertex_descriptor class vertex_descriptor
{ {
@ -461,8 +457,7 @@ public:
#ifdef DOXYGEN_RUNNING #ifdef DOXYGEN_RUNNING
/// This class represents an edge of the seam mesh. /// This class represents an edge of the seam mesh.
/// ///
/// \cgalModels `Descriptor` /// \cgalModels{Descriptor,Hashable}
/// \cgalModels `Hashable`
/// ///
class edge_descriptor class edge_descriptor
{ {
@ -562,7 +557,7 @@ public:
/// This class represents a face of the seam mesh. /// This class represents a face of the seam mesh.
/// ///
/// \cgalModels `Descriptor` /// \cgalModels{Descriptor}
/// ///
typedef typename boost::graph_traits<TM>::face_descriptor face_descriptor; typedef typename boost::graph_traits<TM>::face_descriptor face_descriptor;

28
BGL/include/CGAL/boost/graph/iterator.h
View File

@ -182,7 +182,7 @@ struct Opposite_face {
* Let `h` be a halfedge of graph `g`. For a `Halfedge_around_source_iterator` `havi` with `h = *havi;` * Let `h` be a halfedge of graph `g`. For a `Halfedge_around_source_iterator` `havi` with `h = *havi;`
* the following holds: Either `++havi` is the past the end iterator, or `next(opposite(h,g),g) == *++havi`. * the following holds: Either `++havi` is the past the end iterator, or `next(opposite(h,g),g) == *++havi`.
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalIterator` * \cgalModels{BidirectionalIterator}
*/ */
template <typename Graph> template <typename Graph>
class Halfedge_around_source_iterator { class Halfedge_around_source_iterator {
@ -274,7 +274,7 @@ public:
* Let `h` be a halfedge of graph `g`. For a `Halfedge_around_target_iterator` `havi` with `h = *havi;` * Let `h` be a halfedge of graph `g`. For a `Halfedge_around_target_iterator` `havi` with `h = *havi;`
* the following holds: Either `++havi` is the past the end iterator, or `opposite(next(h,g),g) == *++havi`. * the following holds: Either `++havi` is the past the end iterator, or `opposite(next(h,g),g) == *++havi`.
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalIterator` * \cgalModels{BidirectionalIterator}
*/ */
template <typename Graph> template <typename Graph>
@ -369,7 +369,7 @@ public:
* Let `h` be a halfedge of graph `g`. For a `Halfedge_around_face_iterator` `hafi` with `h = *hafi` * Let `h` be a halfedge of graph `g`. For a `Halfedge_around_face_iterator` `hafi` with `h = *hafi`
* the following holds: Either `++hafi` is the past the end iterator, or `next(h,g) == *++hafi`. * the following holds: Either `++hafi` is the past the end iterator, or `next(h,g) == *++hafi`.
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalIterator` * \cgalModels{BidirectionalIterator}
*/ */
template <typename Graph> template <typename Graph>
@ -465,7 +465,7 @@ class Halfedge_around_target_circulator;
* Let `h` be a halfedge of graph `g`. For a `Halfedge_around_source_circulator` `havc` with `h = *havc;` * Let `h` be a halfedge of graph `g`. For a `Halfedge_around_source_circulator` `havc` with `h = *havc;`
* the following holds: `next(opposite(h,g),g) == *++havc`. * the following holds: `next(opposite(h,g),g) == *++havc`.
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalCirculator` * \cgalModels{BidirectionalCirculator}
*/ */
template <typename Graph> template <typename Graph>
class Halfedge_around_source_circulator class Halfedge_around_source_circulator
@ -531,7 +531,7 @@ private:
* It circulates over the same halfedges as the `Halfedge_around_target_circulator`. * It circulates over the same halfedges as the `Halfedge_around_target_circulator`.
* *
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalCirculator` * \cgalModels{BidirectionalCirculator}
*/ */
template <typename Graph> template <typename Graph>
@ -590,7 +590,7 @@ private:
* Let `h` be a halfedge of graph `g`. For a `Halfedge_around_target_circulator` `havc` with `h = *havc;` * Let `h` be a halfedge of graph `g`. For a `Halfedge_around_target_circulator` `havc` with `h = *havc;`
* the following holds: `opposite(next(h,g),g) == *++havc`. * the following holds: `opposite(next(h,g),g) == *++havc`.
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalCirculator` * \cgalModels{BidirectionalCirculator}
*/ */
@ -692,7 +692,7 @@ private:
* Let `h` be a halfedge of graph `g`. For a `Halfedge_around_face_circulator` `hafc` with `h = *hafc` * Let `h` be a halfedge of graph `g`. For a `Halfedge_around_face_circulator` `hafc` with `h = *hafc`
* the following holds: `next(h,g) == *++hafc`. * the following holds: `next(h,g) == *++hafc`.
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalCirculator` * \cgalModels{BidirectionalCirculator}
*/ */
template <typename Graph> template <typename Graph>
@ -844,7 +844,7 @@ halfedges_around_face(typename boost::graph_traits<Graph>::halfedge_descriptor h
* may be the null face, and it may be several times the same face descriptor. * may be the null face, and it may be several times the same face descriptor.
* *
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalCirculator` * \cgalModels{BidirectionalCirculator}
*/ */
template <typename Graph> template <typename Graph>
class Face_around_face_iterator class Face_around_face_iterator
@ -882,7 +882,7 @@ private:
* may be the null face, and it may be several times the same face descriptor. * may be the null face, and it may be several times the same face descriptor.
* *
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalCirculator` * \cgalModels{BidirectionalCirculator}
*/ */
template <typename Graph> template <typename Graph>
class Face_around_face_circulator class Face_around_face_circulator
@ -896,7 +896,7 @@ class Face_around_face_circulator
* may be the null face, and it may be several times the same face descriptor. * may be the null face, and it may be several times the same face descriptor.
* *
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalIterator` * \cgalModels{BidirectionalIterator}
*/ */
template <typename Graph> template <typename Graph>
class Face_around_target_iterator class Face_around_target_iterator
@ -956,7 +956,7 @@ faces_around_face(typename boost::graph_traits<Graph>::halfedge_descriptor h, co
* \ingroup PkgBGLIterators * \ingroup PkgBGLIterators
* A bidirectional circulator with value type `boost::graph_traits<Graph>::%vertex_descriptor` over all vertices incident to the same face or border. * A bidirectional circulator with value type `boost::graph_traits<Graph>::%vertex_descriptor` over all vertices incident to the same face or border.
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalIterator` * \cgalModels{BidirectionalIterator}
*/ */
template <typename Graph> template <typename Graph>
class Vertex_around_face_circulator class Vertex_around_face_circulator
@ -1013,7 +1013,7 @@ private:
* A bidirectional iterator with value type `boost::graph_traits<Graph>::%vertex_descriptor` * A bidirectional iterator with value type `boost::graph_traits<Graph>::%vertex_descriptor`
* over all vertices incident to the same face or border. * over all vertices incident to the same face or border.
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalIterator` * \cgalModels{BidirectionalIterator}
*/ */
template <typename Graph> template <typename Graph>
class Vertex_around_face_iterator class Vertex_around_face_iterator
@ -1135,7 +1135,7 @@ edges_around_face(typename boost::graph_traits<Graph>::halfedge_descriptor h, co
* It circulates over the same halfedges as the `Halfedge_around_target_circulator`. * It circulates over the same halfedges as the `Halfedge_around_target_circulator`.
* *
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalCirculator` * \cgalModels{BidirectionalCirculator}
*/ */
template <typename Graph> template <typename Graph>
class Vertex_around_target_circulator class Vertex_around_target_circulator
@ -1194,7 +1194,7 @@ private:
* It iterates over the same halfedges as the `Halfedge_around_target_iterator`. * It iterates over the same halfedges as the `Halfedge_around_target_iterator`.
* *
* \tparam Graph must be a model of the concept `HalfedgeGraph` * \tparam Graph must be a model of the concept `HalfedgeGraph`
* \cgalModels `BidirectionalIterator` * \cgalModels{BidirectionalIterator}
*/ */
template <typename Graph> template <typename Graph>
class Vertex_around_target_iterator class Vertex_around_target_iterator

2
Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Delaunay_domain_2.h
View File

@ -51,7 +51,7 @@ namespace Barycentric_coordinates {
a model of `ReadablePropertyMap` whose key type is `VertexRange::value_type` and a model of `ReadablePropertyMap` whose key type is `VertexRange::value_type` and
value type is `Point_2`. The default is `CGAL::Identity_property_map`. value type is `Point_2`. The default is `CGAL::Identity_property_map`.
\cgalModels `DiscretizedDomain_2` \cgalModels{DiscretizedDomain_2}
*/ */
template< template<
typename VertexRange, typename VertexRange,

2
Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Discrete_harmonic_2.h
View File

@ -48,7 +48,7 @@ namespace Barycentric_coordinates {
\tparam Traits must be a model of the concepts `BarycentricTraits_2` and `PolygonTraits_2`. \tparam Traits must be a model of the concepts `BarycentricTraits_2` and `PolygonTraits_2`.
\cgalModels `BarycentricCoordinates_2` \cgalModels{BarycentricCoordinates_2}
\pre The provided polygon is strictly convex. \pre The provided polygon is strictly convex.

2
Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Mean_value_2.h
View File

@ -100,7 +100,7 @@ public:
\tparam Traits must be a model of the concept `BarycentricTraits_2`. \tparam Traits must be a model of the concept `BarycentricTraits_2`.
\cgalModels `BarycentricCoordinates_2` \cgalModels{BarycentricCoordinates_2}
*/ */
template<class Traits> template<class Traits>

2
Barycentric_coordinates_2/include/CGAL/Barycentric_coordinates_2/Wachspress_2.h
View File

@ -48,7 +48,7 @@ namespace Barycentric_coordinates {
\tparam Traits must be a model of the concepts `BarycentricTraits_2` and `PolygonTraits_2`. \tparam Traits must be a model of the concepts `BarycentricTraits_2` and `PolygonTraits_2`.
\cgalModels `BarycentricCoordinates_2` \cgalModels{BarycentricCoordinates_2}
\pre The provided polygon is strictly convex. \pre The provided polygon is strictly convex.

6
Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h
View File

@ -15,7 +15,7 @@ You need to extend this template with auxiliary data only if you intend to
obtain the underlying arrangement of the general polygon set and process it obtain the underlying arrangement of the general polygon set and process it
further. further.
\cgalModels `GeneralPolygonSetDcelFace` \cgalModels{GeneralPolygonSetDcelFace}
\sa `Arr_face_base` \sa `Arr_face_base`
*/ */
@ -35,7 +35,7 @@ You need to extend this template with auxiliary data only if you intend to
obtain the underlying arrangement of the general polygon set and process it obtain the underlying arrangement of the general polygon set and process it
further. further.
\cgalModels `GeneralPolygonSetDcelHalfedge` \cgalModels{GeneralPolygonSetDcelHalfedge}
\sa `Arr_halfedge_base<X_monotone_curve_2>` \sa `Arr_halfedge_base<X_monotone_curve_2>`
*/ */
@ -62,7 +62,7 @@ You need to override this default and use a different
\dcel only if you intend to obtain the underlying \dcel only if you intend to obtain the underlying
arrangement of the general polygon set and process it further. arrangement of the general polygon set and process it further.
\cgalModels `GeneralPolygonSetDcel` \cgalModels{GeneralPolygonSetDcel}
\sa `Arr_dcel_base<V,H,F>` \sa `Arr_dcel_base<V,H,F>`
\sa `Gps_halfedge_base<X_monotone_curve_2>` \sa `Gps_halfedge_base<X_monotone_curve_2>`

2
Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h
View File

@ -20,7 +20,7 @@ support the following functions:
This class supports a few convenient operations in addition to the This class supports a few convenient operations in addition to the
requirements that the concept `GeneralPolygon_2` lists. requirements that the concept `GeneralPolygon_2` lists.
\cgalModels `GeneralPolygon_2` \cgalModels{GeneralPolygon_2}
*/ */
template< typename ArrTraits > template< typename ArrTraits >

2
Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_circle_segment_traits_2.h
View File

@ -9,7 +9,7 @@ concept. It enables Boolean set-operations on general polygons bounded by
linear segments or circular arcs. linear segments or circular arcs.
It should be parameterized with a kernel. It should be parameterized with a kernel.
\cgalModels `GeneralPolygonSetTraits_2` \cgalModels{GeneralPolygonSetTraits_2}
\sa `CGAL::Arr_circle_segment_traits_2<Kernel>` \sa `CGAL::Arr_circle_segment_traits_2<Kernel>`

2
Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h
View File

@ -4,7 +4,7 @@ namespace CGAL {
/*! /*!
\ingroup PkgBooleanSetOperations2Ref \ingroup PkgBooleanSetOperations2Ref
\cgalModels `GeneralPolygonSetTraits_2` \cgalModels{GeneralPolygonSetTraits_2}
\sa `CGAL::Arr_segment_traits_2<Kernel>` \sa `CGAL::Arr_segment_traits_2<Kernel>`

2
Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_traits_2.h
View File

@ -13,7 +13,7 @@ the concept `ArrangementXMonotoneTraits_2`). The template parameter
of `GpsTraitsGeneralPolygon_2`. By default, the latter is instantiated by of `GpsTraitsGeneralPolygon_2`. By default, the latter is instantiated by
`CGAL::General_polygon_2<ArrTraits>`. `CGAL::General_polygon_2<ArrTraits>`.
\cgalModels `GeneralPolygonSetTraits_2` \cgalModels{GeneralPolygonSetTraits_2}
*/ */
template< typename ArrTraits, typename GeneralPolygon_t > template< typename ArrTraits, typename GeneralPolygon_t >

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h
View File

@ -18,7 +18,7 @@ exact computations.
`CGAL::Tag_true`. (Examples of such a `CGAL::Tag_true`. (Examples of such a
number-type are `MP_Float`, `CORE::Expr`, and `Gmpq`.) number-type are `MP_Float`, `CORE::Expr`, and `Gmpq`.)
\cgalModels `ApproximateMinEllipsoid_d_Traits_d` \cgalModels{ApproximateMinEllipsoid_d_Traits_d}
\sa `CGAL::Approximate_min_ellipsoid_d_traits_3<K,ET>` \sa `CGAL::Approximate_min_ellipsoid_d_traits_3<K,ET>`
\sa `CGAL::Approximate_min_ellipsoid_d_traits_d<K,ET>` \sa `CGAL::Approximate_min_ellipsoid_d_traits_d<K,ET>`

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h
View File

@ -19,7 +19,7 @@ exact computations.
`Tag_true` (Examples of such a `Tag_true` (Examples of such a
number-type are `MP_Float`, `CORE::Expr`, and `Gmpq`.) number-type are `MP_Float`, `CORE::Expr`, and `Gmpq`.)
\cgalModels `ApproximateMinEllipsoid_d_Traits_d` \cgalModels{ApproximateMinEllipsoid_d_Traits_d}
\sa `CGAL::Approximate_min_ellipsoid_d_traits_2<K,ET>` \sa `CGAL::Approximate_min_ellipsoid_d_traits_2<K,ET>`
\sa `CGAL::Approximate_min_ellipsoid_d_traits_d<K,ET>` \sa `CGAL::Approximate_min_ellipsoid_d_traits_d<K,ET>`

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h
View File

@ -18,7 +18,7 @@ exact computations.
`CGAL::Tag_true` (Examples of such a `CGAL::Tag_true` (Examples of such a
number-type are `MP_Float`, `CORE::Expr`, and `Gmpq`.) number-type are `MP_Float`, `CORE::Expr`, and `Gmpq`.)
\cgalModels `ApproximateMinEllipsoid_d_Traits_d` \cgalModels{ApproximateMinEllipsoid_d_Traits_d}
\sa `CGAL::Approximate_min_ellipsoid_d_traits_2<K,ET>` \sa `CGAL::Approximate_min_ellipsoid_d_traits_2<K,ET>`
\sa `CGAL::Approximate_min_ellipsoid_d_traits_3<K,ET>` \sa `CGAL::Approximate_min_ellipsoid_d_traits_3<K,ET>`

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h
View File

@ -9,7 +9,7 @@ using the two-dimensional \cgal kernel.
\tparam K must be a model for `Kernel`. \tparam K must be a model for `Kernel`.
\cgalModels `MinCircle2Traits` \cgalModels{MinCircle2Traits}
\sa `CGAL::Min_circle_2<Traits>` \sa `CGAL::Min_circle_2<Traits>`
\sa `MinCircle2Traits` \sa `MinCircle2Traits`

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h
View File

@ -9,7 +9,7 @@ using the two-dimensional \cgal kernel.
The template parameter `K` must be a model for `Kernel`. The template parameter `K` must be a model for `Kernel`.
\cgalModels `MinEllipse2Traits` \cgalModels{MinEllipse2Traits}
\sa `CGAL::Min_ellipse_2<Traits>` \sa `CGAL::Min_ellipse_2<Traits>`
\sa `MinEllipse2Traits` \sa `MinEllipse2Traits`

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h
View File

@ -10,7 +10,7 @@ functions `min_rectangle_2()`, `min_parallelogram_2()` and
\tparam K must be a model for `Kernel`. \tparam K must be a model for `Kernel`.
\cgalModels `MinQuadrilateralTraits_2` \cgalModels{MinQuadrilateralTraits_2}
\sa `CGAL::min_rectangle_2()` \sa `CGAL::min_rectangle_2()`
\sa `CGAL::min_parallelogram_2()` \sa `CGAL::min_parallelogram_2()`

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h
View File

@ -10,7 +10,7 @@ optimisation algorithms using the two-dimensional \cgal kernel.
\tparam K must bea model for `Kernel`. \tparam K must bea model for `Kernel`.
\tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`. \tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`.
\cgalModels `MinSphereAnnulusDTraits` \cgalModels{MinSphereAnnulusDTraits}
\sa `CGAL::Min_sphere_d<Traits>` \sa `CGAL::Min_sphere_d<Traits>`
\sa `CGAL::Min_annulus_d<Traits>` \sa `CGAL::Min_annulus_d<Traits>`

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h
View File

@ -10,7 +10,7 @@ optimisation algorithms using the three-dimensional \cgal kernel.
\tparam K must be a model for `Kernel`. \tparam K must be a model for `Kernel`.
\tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`. \tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`.
\cgalModels `MinSphereAnnulusDTraits` \cgalModels{MinSphereAnnulusDTraits}
\sa `CGAL::Min_sphere_d<Traits>` \sa `CGAL::Min_sphere_d<Traits>`
\sa `CGAL::Min_annulus_d<Traits>` \sa `CGAL::Min_annulus_d<Traits>`

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h
View File

@ -10,7 +10,7 @@ optimisation algorithms using the \f$ d\f$-dimensional \cgal kernel.
\tparam K must be a model for `Kernel`. \tparam K must be a model for `Kernel`.
\tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`. \tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`.
\cgalModels `MinSphereAnnulusDTraits` \cgalModels{MinSphereAnnulusDTraits}
\sa `CGAL::Min_sphere_d<Traits>` \sa `CGAL::Min_sphere_d<Traits>`
\sa `CGAL::Min_annulus_d<Traits>` \sa `CGAL::Min_annulus_d<Traits>`

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h
View File

@ -8,7 +8,7 @@ The class
model for concept `MinSphereOfSpheresTraits`. It uses the \cgal model for concept `MinSphereOfSpheresTraits`. It uses the \cgal
type `Point_2` to represent circles. type `Point_2` to represent circles.
\cgalModels `MinSphereOfSpheresTraits` \cgalModels{MinSphereOfSpheresTraits}

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h
View File

@ -8,7 +8,7 @@ The class
model for concept `MinSphereOfSpheresTraits`. It uses the \cgal model for concept `MinSphereOfSpheresTraits`. It uses the \cgal
type `Point_3` to represent spheres. type `Point_3` to represent spheres.
\cgalModels `MinSphereOfSpheresTraits` \cgalModels{MinSphereOfSpheresTraits}

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h
View File

@ -8,7 +8,7 @@ The class
a model for concept `MinSphereOfSpheresTraits`. It uses the a model for concept `MinSphereOfSpheresTraits`. It uses the
\cgal type `Point_d` to represent circles. \cgal type `Point_d` to represent circles.
\cgalModels `MinSphereOfSpheresTraits` \cgalModels{MinSphereOfSpheresTraits}
\tparam K is a model for `Kernel`. \tparam K is a model for `Kernel`.

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h
View File

@ -8,7 +8,7 @@ The class
model for concept `MinSphereOfSpheresTraits`. It uses a pair of \cgal model for concept `MinSphereOfSpheresTraits`. It uses a pair of \cgal
`Point_2` and `FT` to represent circles. `Point_2` and `FT` to represent circles.
\cgalModels `MinSphereOfSpheresTraits` \cgalModels{MinSphereOfSpheresTraits}
The last two template parameters, `UseSqrt` and `Algorithm`, have The last two template parameters, `UseSqrt` and `Algorithm`, have

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h
View File

@ -8,7 +8,7 @@ The class
model for concept `MinSphereOfSpheresTraits`. It uses a pair of \cgal model for concept `MinSphereOfSpheresTraits`. It uses a pair of \cgal
`Point_3` and `FT` to represent spheres. `Point_3` and `FT` to represent spheres.
\cgalModels `MinSphereOfSpheresTraits` \cgalModels{MinSphereOfSpheresTraits}
\tparam K must be a model for `Kernel`. \tparam K must be a model for `Kernel`.

2
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h
View File

@ -8,7 +8,7 @@ The class
a model for concept `MinSphereOfSpheresTraits`. It uses the a model for concept `MinSphereOfSpheresTraits`. It uses the
\cgal type `Point_d` to represent circles. \cgal type `Point_d` to represent circles.
\cgalModels `MinSphereOfSpheresTraits` \cgalModels{MinSphereOfSpheresTraits}
\tparam K is a model for `Kernel`. \tparam K is a model for `Kernel`.

2
Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h
View File

@ -10,7 +10,7 @@ using the function `rectangular_p_center_2()`.
\tparam K must be a model for `Kernel`. \tparam K must be a model for `Kernel`.
\cgalModels `RectangularPCenterTraits_2` \cgalModels{RectangularPCenterTraits_2}
\sa `CGAL::rectangular_p_center_2()` \sa `CGAL::rectangular_p_center_2()`

2
Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h
View File

@ -40,7 +40,7 @@ creates copies of the boxes that would not have identical
`id`-numbers. `id`-numbers.
</UL> </UL>
\cgalModels `BoxIntersectionBox_d` \cgalModels{BoxIntersectionBox_d}
\sa \link PkgBoxIntersectionD_box_intersection_d `CGAL::box_intersection_d()` \endlink \sa \link PkgBoxIntersectionD_box_intersection_d `CGAL::box_intersection_d()` \endlink
\sa \link PkgBoxIntersectionD_box_self_intersection_d `CGAL::box_self_intersection_d()` \endlink \sa \link PkgBoxIntersectionD_box_self_intersection_d `CGAL::box_self_intersection_d()` \endlink

2
Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_traits_d.h
View File

@ -20,7 +20,7 @@ cases it just uses the pointer type.
const-pointer `const B*`, where `B` is a model of the const-pointer `const B*`, where `B` is a model of the
`BoxIntersectionBox_d` concept. `BoxIntersectionBox_d` concept.
\cgalModels `BoxIntersectionTraits_d` \cgalModels{BoxIntersectionTraits_d}
\sa \link PkgBoxIntersectionD_box_intersection_d `CGAL::box_intersection_d()` \endlink \sa \link PkgBoxIntersectionD_box_intersection_d `CGAL::box_intersection_d()` \endlink
\sa \link PkgBoxIntersectionD_box_self_intersection_d `CGAL::box_self_intersection_d()` \endlink \sa \link PkgBoxIntersectionD_box_self_intersection_d `CGAL::box_self_intersection_d()` \endlink

2
Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_with_handle_d.h
View File

@ -52,7 +52,7 @@ the safe default implementation.
available for the `CGAL::Box_intersection_d::Box_d` type available for the `CGAL::Box_intersection_d::Box_d` type
that does not store a handle. that does not store a handle.
\cgalModels `BoxIntersectionBox_d` \cgalModels{BoxIntersectionBox_d}
\sa \link PkgBoxIntersectionD_box_intersection_d `CGAL::box_intersection_d()` \endlink \sa \link PkgBoxIntersectionD_box_intersection_d `CGAL::box_intersection_d()` \endlink
\sa \link PkgBoxIntersectionD_box_self_intersection_d `CGAL::box_self_intersection_d()` \endlink \sa \link PkgBoxIntersectionD_box_self_intersection_d `CGAL::box_self_intersection_d()` \endlink

2
Circular_kernel_2/doc/Circular_kernel_2/CGAL/Algebraic_kernel_for_circles_2_2.h
View File

@ -4,7 +4,7 @@ namespace CGAL {
/*! /*!
\ingroup PkgCircularKernel2AlgebraicClasses \ingroup PkgCircularKernel2AlgebraicClasses
\cgalModels `AlgebraicKernelForCircles` \cgalModels{AlgebraicKernelForCircles}
*/ */
template< typename RT > template< typename RT >

2
Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_2.h
View File

@ -4,7 +4,7 @@ namespace CGAL {
/*! /*!
\ingroup PkgCircularKernel2GeometricClasses \ingroup PkgCircularKernel2GeometricClasses
\cgalModels `CircularKernel::CircularArc_2` \cgalModels{CircularKernel::CircularArc_2}
\sa `CGAL::Circular_arc_point_2<CircularKernel>` \sa `CGAL::Circular_arc_point_2<CircularKernel>`
\sa `CGAL::Line_arc_2<CircularKernel>` \sa `CGAL::Line_arc_2<CircularKernel>`

2
Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_point_2.h
View File

@ -4,7 +4,7 @@ namespace CGAL {
/*! /*!
\ingroup PkgCircularKernel2GeometricClasses \ingroup PkgCircularKernel2GeometricClasses
\cgalModels `CircularKernel::CircularArcPoint_2` \cgalModels{CircularKernel::CircularArcPoint_2}
\sa `CGAL::Circular_arc_2<CircularKernel>` \sa `CGAL::Circular_arc_2<CircularKernel>`
\sa `CGAL::Line_arc_2<CircularKernel>` \sa `CGAL::Line_arc_2<CircularKernel>`

2
Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_kernel_2.h
View File

@ -4,7 +4,7 @@ namespace CGAL {
/*! /*!
\ingroup PkgCircularKernel2GeometricClasses \ingroup PkgCircularKernel2GeometricClasses
\cgalModels `CircularKernel` \cgalModels{CircularKernel}
\cgalHeading{Parameters} \cgalHeading{Parameters}

2
Circular_kernel_2/doc/Circular_kernel_2/CGAL/Exact_circular_kernel_2.h
View File

@ -8,7 +8,7 @@ A typedef to a circular kernel that provides both exact geometric
predicates and exact geometric constructions. This kernel uses some predicates and exact geometric constructions. This kernel uses some
geometric filtering (based on bounding boxes) to gain efficiency. geometric filtering (based on bounding boxes) to gain efficiency.
\cgalModels `CircularKernel` \cgalModels{CircularKernel}
\sa `CGAL::Circular_kernel_2<Kernel,AlgebraicKernelForCircles>` \sa `CGAL::Circular_kernel_2<Kernel,AlgebraicKernelForCircles>`

2
Circular_kernel_2/doc/Circular_kernel_2/CGAL/Line_arc_2.h
View File

@ -4,7 +4,7 @@ namespace CGAL {
/*! /*!
\ingroup PkgCircularKernel2GeometricClasses \ingroup PkgCircularKernel2GeometricClasses
\cgalModels `CircularKernel::LineArc_2` \cgalModels{CircularKernel::LineArc_2}
\cgalHeading{I/O} \cgalHeading{I/O}

2
Circular_kernel_2/doc/Circular_kernel_2/CGAL/Polynomials_1_2.h
View File

@ -4,7 +4,7 @@ namespace CGAL {
/*! /*!
\ingroup PkgCircularKernel2AlgebraicClasses \ingroup PkgCircularKernel2AlgebraicClasses
\cgalModels `AlgebraicKernelForCircles::Polynomial_1_2` \cgalModels{AlgebraicKernelForCircles::Polynomial_1_2}
*/ */
template< typename RT > template< typename RT >

Some files were not shown because too many files have changed in this diff Show More