workaround for a doxygen bug: remove space after /!* to avoid a verbatim env
this happens if you have an empty line or the text directly after /!* to find them in the generated documentation, grep for "pre class=\"fragment\"" (a few of them are legitimate however)
This commit is contained in:
Sébastien Loriot
@@ -19,7 +19,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
constructs an instance with `traits` as traits class instance.
|
||||
*/
|
||||
Hilbert_sort_2(const Traits &traits = Traits());
|
||||
@@ -29,7 +29,7 @@ Hilbert_sort_2(const Traits &traits = Traits());
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
sorts the range `[begin, end)`.
|
||||
\tparam RandomAccessIterator must be an iterator with value type `Traits::Point_2`.
|
||||
*/
|
||||
|
||||
@@ -17,7 +17,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
constructs an instance with `traits` as traits class instance.
|
||||
*/
|
||||
Hilbert_sort_3(const Traits &traits = Traits());
|
||||
@@ -27,7 +27,7 @@ Hilbert_sort_3(const Traits &traits = Traits());
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
sorts the range `[begin, end)`.
|
||||
\tparam RandomAccessIterator must be an iterator with value type `Traits::Point_3`.
|
||||
*/
|
||||
|
||||
@@ -17,7 +17,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
constructs an instance with `traits` as traits class instance.
|
||||
*/
|
||||
Hilbert_sort_d(const Traits &traits = Traits());
|
||||
@@ -27,7 +27,7 @@ Hilbert_sort_d(const Traits &traits = Traits());
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
sorts the range `[begin, end)`.
|
||||
\tparam RandomAccessIterator must be an iteratoe with value type `Traits::Point_d`.
|
||||
*/
|
||||
|
||||
@@ -19,7 +19,7 @@ public:
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
constructs an instance with `traits` as traits class instance.
|
||||
*/
|
||||
Multiscale_sort (const Sort &sort = Sort(), std::ptrdiff_t threshold = 1, double ratio = 0.5);
|
||||
@@ -29,7 +29,7 @@ Multiscale_sort (const Sort &sort = Sort(), std::ptrdiff_t threshold = 1, double
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
sorts the range `[begin, end)`.
|
||||
\cgalRequires `Sort::operator()(RandomAccessIterator begin, RandomAccessIterator end)` is defined.
|
||||
*/
|
||||
|
||||
@@ -22,7 +22,7 @@ public:
|
||||
/// \name Types
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
boost::property_traits<PointPropertyMap>::key_type Point_2;
|
||||
@@ -32,12 +32,12 @@ boost::property_traits<PointPropertyMap>::key_type Point_2;
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Spatial_sort_traits_adapter_2(Base_traits base=Base_traits());
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Spatial_sort_traits_adapter_2(const PointPropertyMap& ppmap,Base_traits base=Base_traits());
|
||||
@@ -47,7 +47,7 @@ Spatial_sort_traits_adapter_2(const PointPropertyMap& ppmap,Base_traits base=Bas
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Returns a const reference to the point property map.
|
||||
*/
|
||||
const PointPropertyMap& point_property_map() const;
|
||||
|
||||
@@ -23,7 +23,7 @@ public:
|
||||
/// \name Types
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
boost::property_traits<PointPropertyMap>::key_type Point_3;
|
||||
@@ -33,12 +33,12 @@ boost::property_traits<PointPropertyMap>::key_type Point_3;
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Spatial_sort_traits_adapter_3(Base_traits base=Base_traits());
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Spatial_sort_traits_adapter_3(const PointPropertyMap& ppmap,Base_traits base=Base_traits());
|
||||
@@ -48,7 +48,7 @@ Spatial_sort_traits_adapter_3(const PointPropertyMap& ppmap,Base_traits base=Bas
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Returns a const reference to the point property map.
|
||||
*/
|
||||
const PointPropertyMap& point_property_map() const;
|
||||
|
||||
@@ -23,7 +23,7 @@ public:
|
||||
/// \name Types
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
boost::property_traits<PointPropertyMap>::key_type Point_d;
|
||||
@@ -33,12 +33,12 @@ boost::property_traits<PointPropertyMap>::key_type Point_d;
|
||||
/// \name Creation
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Spatial_sort_traits_adapter_d(Base_traits base=Base_traits());
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Spatial_sort_traits_adapter_d(const PointPropertyMap& ppmap,Base_traits base=Base_traits());
|
||||
@@ -48,7 +48,7 @@ Spatial_sort_traits_adapter_d(const PointPropertyMap& ppmap,Base_traits base=Bas
|
||||
/// \name Operations
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Returns a const reference to the point property map.
|
||||
*/
|
||||
const PointPropertyMap& point_property_map() const;
|
||||
|
||||
@@ -20,12 +20,12 @@ public:
|
||||
/// \name Types
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
The point type on which the sorting algorithms operate.
|
||||
*/
|
||||
typedef unspecified_type Point_2;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Functor object type returning the \f$ x\f$ coordinate of a `Point_2`.
|
||||
Must provide
|
||||
`FT operator()(Point_2 p)` where `FT` can be used as
|
||||
@@ -34,7 +34,7 @@ argument of `CGAL::to_double`.
|
||||
*/
|
||||
typedef unspecified_type Compute_x_2;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Functor object type returning the \f$ y\f$ coordinate of a `Point_2`.
|
||||
Must provide
|
||||
`FT operator()(Point_2 p)` where `FT` can be used as
|
||||
@@ -43,7 +43,7 @@ argument of `CGAL::to_double`.
|
||||
*/
|
||||
typedef unspecified_type Compute_y_2;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Binary predicate object type comparing `Point_2`s
|
||||
along the \f$ x\f$ coordinate.
|
||||
Must provide
|
||||
@@ -55,7 +55,7 @@ respectively.
|
||||
*/
|
||||
typedef unspecified_type Less_x_2;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Binary predicate object type comparing `Point_2`s
|
||||
along the \f$ y\f$ coordinate.
|
||||
Must provide
|
||||
@@ -73,7 +73,7 @@ typedef unspecified_type Less_y_2;
|
||||
/// Only a copy constructor is required.
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
SpatialSortingTraits_2(const SpatialSortingTraits_2& t);
|
||||
@@ -84,22 +84,22 @@ SpatialSortingTraits_2(const SpatialSortingTraits_2& t);
|
||||
/// The following member functions to create instances of the above predicate object types must exist.
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Compute_x_2 compute_x_2_object();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Compute_y_2 compute_y_2_object();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Less_x_2 less_x_2_object();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Less_y_2 less_y_2_object();
|
||||
|
||||
@@ -20,12 +20,12 @@ public:
|
||||
/// \name Types
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
The point type on which the sorting algorithms operate.
|
||||
*/
|
||||
typedef unspecified_type Point_3;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Functor object type returning the \f$ x\f$ coordinate of a `Point_3`.
|
||||
Must provide
|
||||
`FT operator()(Point_3 p)` where `FT` can be used as
|
||||
@@ -34,7 +34,7 @@ argument of `CGAL::to_double`.
|
||||
*/
|
||||
typedef unspecified_type Compute_x_3;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Functor object type returning the \f$ y\f$ coordinate of a `Point_3`.
|
||||
Must provide
|
||||
`FT operator()(Point_3 p)` where `FT` can be used as
|
||||
@@ -43,7 +43,7 @@ argument of `CGAL::to_double`.
|
||||
*/
|
||||
typedef unspecified_type Compute_y_3;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Functor object type returning the \f$ z\f$ coordinate of a `Point_3`.
|
||||
Must provide
|
||||
`FT operator()(Point_3 p)` where `FT` can be used as
|
||||
@@ -52,7 +52,7 @@ argument of `CGAL::to_double`.
|
||||
*/
|
||||
typedef unspecified_type Compute_z_3;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Binary predicate object type comparing `Point_3`s
|
||||
along the \f$ x\f$ coordinate.
|
||||
Must provide
|
||||
@@ -64,7 +64,7 @@ respectively.
|
||||
*/
|
||||
typedef unspecified_type Less_x_3;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Binary predicate object type comparing `Point_3`s
|
||||
along the \f$ y\f$ coordinate.
|
||||
Must provide
|
||||
@@ -76,7 +76,7 @@ respectively.
|
||||
*/
|
||||
typedef unspecified_type Less_y_3;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Binary predicate object type comparing `Point_3`s
|
||||
along the \f$ z\f$ coordinate.
|
||||
Must provide
|
||||
@@ -94,7 +94,7 @@ typedef unspecified_type Less_z_3;
|
||||
/// Only a copy constructor is required.
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
SpatialSortingTraits_3(const SpatialSortingTraits_3& t);
|
||||
@@ -105,32 +105,32 @@ SpatialSortingTraits_3(const SpatialSortingTraits_3& t);
|
||||
/// The following member functions to create instances of the above predicate object types must exist.
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Compute_x_3 compute_x_3_object();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Compute_y_3 compute_y_3_object();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Compute_z_3 compute_z_3_object();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Less_x_3 less_x_3_object();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Less_y_3 less_y_3_object();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Less_z_3 less_z_3_object();
|
||||
|
||||
@@ -20,13 +20,13 @@ public:
|
||||
/// \name Types
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
The point type on which the sorting algorithms operate.
|
||||
|
||||
*/
|
||||
typedef unspecified_type Point_d;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Functor object type returning the dimension of a `Point_d`.
|
||||
Must provide
|
||||
`int operator()(Point_d p)` returning the dimension of \f$ p\f$.
|
||||
@@ -34,7 +34,7 @@ Must provide
|
||||
*/
|
||||
typedef unspecified_type Point_dimension_d;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Functor object type returning the coordinates of a `Point_d`.
|
||||
Must provide
|
||||
`FT operator()(Point_d p, int i)` returning the \f$ i\f$th
|
||||
@@ -44,7 +44,7 @@ argument of `CGAL::to_double`.
|
||||
*/
|
||||
typedef unspecified_type Compute_coordinate_d;
|
||||
|
||||
/*!
|
||||
/*!
|
||||
Binary predicate object type comparing `Point_d`s
|
||||
along some coordinate.
|
||||
Must provide
|
||||
@@ -62,7 +62,7 @@ typedef unspecified_type Less_coordinate_d;
|
||||
/// Only a copy constructor is required.
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
SpatialSortingTraits_d(const SpatialSortingTraits_d& t);
|
||||
@@ -73,17 +73,17 @@ SpatialSortingTraits_d(const SpatialSortingTraits_d& t);
|
||||
/// The following member functions to create instances of the above predicate object types must exist.
|
||||
/// @{
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Point_dimension_d point_dimension_d_object();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Compute_coordinate_d compute_coordinate_d_object();
|
||||
|
||||
/*!
|
||||
/*!
|
||||
|
||||
*/
|
||||
Less_coordinate_d less_coordinate_d_object();
|
||||
|
||||
Reference in New Issue
Block a user