Skip to content

Commit

Permalink
Add missing closing grouping commands (#8675)
Browse files Browse the repository at this point in the history
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)
  • Loading branch information
sloriot authored Jan 7, 2025
2 parents 1c04f57 + 18de530 commit 5040cbc
Show file tree
Hide file tree
Showing 21 changed files with 28 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -440,13 +440,14 @@ class Arr_conic_traits_2 {
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.
*/
//@{
typedef double Approximate_number_type;
typedef CGAL::Cartesian<Approximate_number_type> Approximate_kernel;
typedef Approximate_kernel::Point_2 Approximate_point_2;
//@}

/*! \class Approximate_2
* A functor that approximates a point and an \f$x\f$-monotone curve.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ class Arr_segment_traits_2 : public Kernel {
X_monotone_curve_2(const X_monotone_curve_2& xcv,
const Point_2& src, const Point_2& tgt) const;

//! @}
} /* end Arr_segment_traits_2::Trim_2 */

}; /* end Arr_segment_traits_2 */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class ArrangementBottomSideTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class ArrangementContractedBottomTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class ArrangementContractedLeftTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class ArrangementContractedRightTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class ArrangementContractedTopTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class ArrangementLeftSideTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class ArrangementOpenBottomTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class ArrangementOpenLeftTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class ArrangementOpenRightTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ class ArrangementOpenTopTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class ArrangementRightSideTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class ArrangementTopSideTraits_2 {

/// \name Functor Types
/// @{
/// @}

/// \name Accessing Functor Objects
/// @{
Expand Down
2 changes: 1 addition & 1 deletion Arrangement_on_surface_2/include/CGAL/Arr_conic_traits_2.h
Original file line number Diff line number Diff line change
Expand Up @@ -1515,7 +1515,7 @@ class Arr_conic_traits_2 {

//@}

/*! \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.
*/
//@{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ class Arr_tracing_traits_2 : public BaseTraits {
using X_monotone_curve_2 = typename Base::X_monotone_curve_2;
using Curve_2 = typename Base::Curve_2;
using Multiplicity = typename Base::Multiplicity;
//@}

/*! A functor that compares the \f$x\f$-coordinates of two points. */
class Compare_x_2 {
Expand Down
1 change: 1 addition & 0 deletions CGAL_Core/include/CGAL/CORE/BigFloat.h
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,7 @@ inline long longValue(const BigFloat& bf)
{
return bf.longValue();
}
//@}

} //namespace CORE

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ class MixedIntegerProgramVariable
*/
MixedIntegerProgramVariable(MixedIntegerProgramTraits* solver, Variable_type type, FT lb =, FT ub, const std::string& name, int idx);

/// @}

/// \name Operations
/// @{

Expand Down Expand Up @@ -131,6 +133,8 @@ class MixedIntegerProgramLinearConstraint
*/
MixedIntegerProgramLinearConstraint(MixedIntegerProgramTraits* solver, FT lb, FT ub, const std::string& name, int idx);

/// @}

/// \name Operations
/// @{

Expand Down Expand Up @@ -238,6 +242,8 @@ class MixedIntegerProgramLinearObjective
*/
MixedIntegerProgramLinearObjective(MixedIntegerProgramTraits* solver, Sense sense);

/// @}

/// \name Operations
/// @{

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

/// @}

/// \name Operations
/// @{

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -870,6 +870,7 @@ a vertex of the `c`.
*/
int index(Vertex_handle v) const;

/// @}

/// \name Internal
/// \cgalAdvancedBegin
Expand Down
1 change: 1 addition & 0 deletions Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h
Original file line number Diff line number Diff line change
Expand Up @@ -785,6 +785,7 @@ is returned.
*/
Vertex_handle move(Vertex_handle v, const Point & p);

/// @}

/// \name Specialized Modifiers
/// The following member functions offer more specialized versions of
Expand Down

0 comments on commit 5040cbc

Please sign in to comment.