Use \note

This commit is contained in:
Andreas Fabri 2024-10-02 08:06:35 +01:00
parent 85a898dec1
commit bea1dffa99
2 changed files with 2 additions and 6 deletions

View File

@ -16,14 +16,10 @@ convex polygon using the function `all_furthest_neighbors_2()`.
\sa `CGAL::all_furthest_neighbors_2()` \sa `CGAL::all_furthest_neighbors_2()`
\cgalHeading{Notes} \note `AllFurthestNeighborsTraits_2::Less_xy_2` and
<UL>
<LI>`AllFurthestNeighborsTraits_2::Less_xy_2` and
`AllFurthestNeighborsTraits_2::Orientation_2` are used for (expensive) `AllFurthestNeighborsTraits_2::Orientation_2` are used for (expensive)
precondition checking only. Therefore, they need not to be precondition checking only. Therefore, they need not to be
specified, in case that precondition checking is disabled. specified, in case that precondition checking is disabled.
</UL>
*/ */

View File

@ -24,7 +24,7 @@ class WidthTraits_3 {
public: public:
/// \name Types /// \name Types
/// <I>Notes:</I> If you want to compute the width of a <I>polyhedron</I> then you have to make sure that the point type in the traits class and the point type in the polyhedron class are the same! The same holds for `Traits::Plane_3` and `Polyhedron::Plane_3`. /// \note If you want to compute the width of a <I>polyhedron</I> then you have to make sure that the point type in the traits class and the point type in the polyhedron class are the same! The same holds for `Traits::Plane_3` and `Polyhedron::Plane_3`.
/// @{ /// @{
/*! /*!