In a number of cases the command `@{` (or `\{`) is not closed by a corresponding closing command (`@}`). For the `\=name` command this is apparently not necessary but it is better to have corresponding open and close commands.

(also corrected a split in a line that I noticed in Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h)
This commit is contained in:
albert-github 2024-12-25 15:09:57 +01:00
parent f5f5dc7244
commit aaa6adb7c1
20 changed files with 27 additions and 1 deletions

View File

@ -440,13 +440,14 @@ public:
Bbox_2 operator()(const X_monotone_curve_2& xcv) const { return bbox(xcv); } Bbox_2 operator()(const X_monotone_curve_2& xcv) const { return bbox(xcv); }
}; };
/*! \name Auxiliary Functor definitions, used gor, e.g., the landmarks /*! \name Auxiliary Functor definitions, used gor, e.g., the landmarks \
* point-location strategy and the drawing function. * point-location strategy and the drawing function.
*/ */
//@{ //@{
typedef double Approximate_number_type; typedef double Approximate_number_type;
typedef CGAL::Cartesian<Approximate_number_type> Approximate_kernel; typedef CGAL::Cartesian<Approximate_number_type> Approximate_kernel;
typedef Approximate_kernel::Point_2 Approximate_point_2; typedef Approximate_kernel::Point_2 Approximate_point_2;
//@}
/*! \class Approximate_2 /*! \class Approximate_2
* A functor that approximates a point and an \f$x\f$-monotone curve. * A functor that approximates a point and an \f$x\f$-monotone curve.

View File

@ -121,6 +121,7 @@ public:
X_monotone_curve_2(const X_monotone_curve_2& xcv, X_monotone_curve_2(const X_monotone_curve_2& xcv,
const Point_2& src, const Point_2& tgt) const; const Point_2& src, const Point_2& tgt) const;
//! @}
} /* end Arr_segment_traits_2::Trim_2 */ } /* end Arr_segment_traits_2::Trim_2 */
}; /* end Arr_segment_traits_2 */ }; /* end Arr_segment_traits_2 */

View File

@ -29,6 +29,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -33,6 +33,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -33,6 +33,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -33,6 +33,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -33,6 +33,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -29,6 +29,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -33,6 +33,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -33,6 +33,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -33,6 +33,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -33,6 +33,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -29,6 +29,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -29,6 +29,7 @@ public:
/// \name Functor Types /// \name Functor Types
/// @{ /// @{
/// @}
/// \name Accessing Functor Objects /// \name Accessing Functor Objects
/// @{ /// @{

View File

@ -212,6 +212,7 @@ public:
using X_monotone_curve_2 = typename Base::X_monotone_curve_2; using X_monotone_curve_2 = typename Base::X_monotone_curve_2;
using Curve_2 = typename Base::Curve_2; using Curve_2 = typename Base::Curve_2;
using Multiplicity = typename Base::Multiplicity; using Multiplicity = typename Base::Multiplicity;
//@}
/*! A functor that compares the \f$x\f$-coordinates of two points. */ /*! A functor that compares the \f$x\f$-coordinates of two points. */
class Compare_x_2 { class Compare_x_2 {

View File

@ -600,6 +600,7 @@ inline long longValue(const BigFloat& bf)
{ {
return bf.longValue(); return bf.longValue();
} }
//@}
} //namespace CORE } //namespace CORE

View File

@ -39,6 +39,8 @@ public:
*/ */
MixedIntegerProgramVariable(MixedIntegerProgramTraits* solver, Variable_type type, FT lb =, FT ub, const std::string& name, int idx); MixedIntegerProgramVariable(MixedIntegerProgramTraits* solver, Variable_type type, FT lb =, FT ub, const std::string& name, int idx);
/// @}
/// \name Operations /// \name Operations
/// @{ /// @{
@ -131,6 +133,8 @@ public:
*/ */
MixedIntegerProgramLinearConstraint(MixedIntegerProgramTraits* solver, FT lb, FT ub, const std::string& name, int idx); MixedIntegerProgramLinearConstraint(MixedIntegerProgramTraits* solver, FT lb, FT ub, const std::string& name, int idx);
/// @}
/// \name Operations /// \name Operations
/// @{ /// @{
@ -238,6 +242,8 @@ public:
*/ */
MixedIntegerProgramLinearObjective(MixedIntegerProgramTraits* solver, Sense sense); MixedIntegerProgramLinearObjective(MixedIntegerProgramTraits* solver, Sense sense);
/// @}
/// \name Operations /// \name Operations
/// @{ /// @{

View File

@ -21,6 +21,8 @@ The type of the surface mesh to simplify. Must be a model of the `MutableFaceGra
*/ */
typedef Edge_profile::Triangle_mesh TriangleMesh; typedef Edge_profile::Triangle_mesh TriangleMesh;
/// @}
/// \name Operations /// \name Operations
/// @{ /// @{

View File

@ -870,6 +870,7 @@ a vertex of the `c`.
*/ */
int index(Vertex_handle v) const; int index(Vertex_handle v) const;
/// @}
/// \name Internal /// \name Internal
/// \cgalAdvancedBegin /// \cgalAdvancedBegin

View File

@ -785,6 +785,7 @@ is returned.
*/ */
Vertex_handle move(Vertex_handle v, const Point & p); Vertex_handle move(Vertex_handle v, const Point & p);
/// @}
/// \name Specialized Modifiers /// \name Specialized Modifiers
/// The following member functions offer more specialized versions of /// The following member functions offer more specialized versions of