diff --git a/Optimal_bounding_box/doc/Optimal_bounding_box/Doxyfile.in b/Optimal_bounding_box/doc/Optimal_bounding_box/Doxyfile.in index cdcca39a7c8..01d0768a767 100644 --- a/Optimal_bounding_box/doc/Optimal_bounding_box/Doxyfile.in +++ b/Optimal_bounding_box/doc/Optimal_bounding_box/Doxyfile.in @@ -5,18 +5,6 @@ EXTRACT_ALL = false HIDE_UNDOC_CLASSES = true WARN_IF_UNDOCUMENTED = true -# macros to be used inside the code -ALIASES += "cgalNamedParamsBegin=
Named Parameters
" -ALIASES += "cgalNamedParamsEnd=
" -ALIASES += "cgalParamBegin{1}=\ref OBB_\1 \"\1\"" -ALIASES += "cgalParamEnd=" - -#macros for NamedParameters.txt -ALIASES += "cgalNPTableBegin=
" -ALIASES += "cgalNPTableEnd=
" -ALIASES += "cgalNPBegin{1}=\1 " -ALIASES += "cgalNPEnd=" - MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES EXPAND_AS_DEFINED = CGAL_BGL_NP_TEMPLATE_PARAMETERS \ diff --git a/Optimal_bounding_box/doc/Optimal_bounding_box/NamedParameters.txt b/Optimal_bounding_box/doc/Optimal_bounding_box/NamedParameters.txt deleted file mode 100644 index 9e6b25e2e70..00000000000 --- a/Optimal_bounding_box/doc/Optimal_bounding_box/NamedParameters.txt +++ /dev/null @@ -1,65 +0,0 @@ -/*! -\defgroup obb_namedparameters Named Parameters for the package Optimal Bounding Box -\ingroup PkgOptimalBoundingBoxRef - -In this package, the optional parameters of all functions are implemented as BGL optional -named parameters (see \ref BGLNamedParameters for more information on how to use them). -Since the parameters of the various functions defined in this package are redundant, -their long descriptions are centralized below. -The sequence of named parameters should start with `CGAL::parameters::`. -`CGAL::parameters::all_default()` can be used to indicate -that default values of optional named parameters must be used. - -In the following, we assume that the following types are provided as template parameters -of functions and classes. Note that, for some of these functions, -the type is more specific: - - -The following named parameters, offered by the package \ref PkgBGL -(see \ref bgl_namedparameters), are used in this package: - -\cgalNPTableBegin -\cgalNPBegin{vertex_point_map} \anchor OBB_vertex_point_map -is the property map with the points associated to the vertices of the polygon mesh `pmesh`.\n -Type: a class model of `ReadablePropertyMap` with -`boost::graph_traits::%vertex_descriptor` as key type and -`GeomTraits::Point_3` as value type. \n -Default: \code boost::get(CGAL::vertex_point, pmesh) \endcode -\cgalNPEnd - -\cgalNPBegin{point_map} \anchor OBB_point_map - is the property map containing the points associated to the elements of the point range `points`.\n -Type: a class model of `ReadablePropertyMap` with `PointRange::iterator::value_type` as key type - and `geom_traits::Point_3` as value type. \n -Default: \code CGAL::Identity_property_map\endcode -\cgalNPEnd -\cgalNPTableEnd - -In addition to these named parameters, this package offers the following named parameters: - -\cgalNPTableBegin -\cgalNPBegin{geom_traits} \anchor OBB_geom_traits -is the geometric traits instance in which the mesh processing operation should be performed.\n -Type: a Geometric traits class.\n -Default: -\code typename CGAL::Kernel_traits< - typename boost::property_traits< - typename boost::property_map::type>::value_type>::Kernel \endcode -\cgalNPEnd - -\cgalNPBegin{use_convex_hull} \anchor OBB_use_convex_hull -Parameter used in the construction of oriented bounding box to indicate whether the algorithm should -first extract the extreme points (points that are on the 3D convex hull) of the input data range -to accelerate the computation of the bounding box. -\n -Type: `bool` \n -Default: `true` -\cgalNPEnd - -\cgalNPTableEnd - -*/ diff --git a/Optimal_bounding_box/include/CGAL/Optimal_bounding_box/oriented_bounding_box.h b/Optimal_bounding_box/include/CGAL/Optimal_bounding_box/oriented_bounding_box.h index 706b0be2e0b..49e4b2974f7 100644 --- a/Optimal_bounding_box/include/CGAL/Optimal_bounding_box/oriented_bounding_box.h +++ b/Optimal_bounding_box/include/CGAL/Optimal_bounding_box/oriented_bounding_box.h @@ -279,20 +279,27 @@ void construct_oriented_bounding_box(const PointRange& points, /// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below /// /// \cgalNamedParamsBegin -/// \cgalParamBegin{point_map} -/// a model of `ReadablePropertyMap` with value type the type `%Point_3` of the traits class. -/// If this parameter is omitted, `CGAL::Identity_property_map<%Point_3>` is used. -/// \cgalParamEnd -/// \cgalParamBegin{geom_traits} -/// a geometric traits class instance, model of the concept `OrientedBoundingBoxTraits_3`. -/// %Default is a default construction object of type `CGAL::Oriented_bounding_box_traits_3` -/// where `K` is a kernel type deduced from the point type. -/// \cgalParamEnd -/// \cgalParamBegin{use_convex_hull} -/// a Boolean value to indicate whether the algorithm should first extract the so-called extreme -/// points of the data range (i.e. construct the convex hull) to reduce the input data range -/// and accelerate the algorithm. %Default is `true`. -/// \cgalParamEnd +/// \cgalParamNBegin{point_map} +/// \cgalParamDescription{a property map associating points to the elements of the point range} +/// \cgalParamType{a model of `ReadablePropertyMap` with value type `geom_traits::Point_3`} +/// \cgalParamDefault{`CGAL::Identity_property_map`} +/// \cgalParamNEnd +/// +/// \cgalParamNBegin{geom_traits} +/// \cgalParamDescription{an instance of a geometric traits class} +/// \cgalParamType{a model of `OrientedBoundingBoxTraits_3`} +/// \cgalParamDefault{a default-constructed object of type `CGAL::Oriented_bounding_box_traits_3`, +/// where `K` is a kernel type deduced from the point type.} +/// \cgalParamNEnd +/// +/// \cgalParamNBegin{use_convex_hull} +/// \cgalParamDescription{Parameter used in the construction of oriented bounding box to indicate +/// whether the algorithm should first extract the extreme points (points +/// that are on the 3D convex hull) of the input data range +/// to accelerate the computation of the bounding box.} +/// \cgalParamType{Boolean} +/// \cgalParamDefault{`true`} +/// \cgalParamNEnd /// \cgalNamedParamsEnd /// template ` -/// where `K` is a kernel type deduced from the point type. -/// \cgalParamEnd -/// \cgalParamBegin{use_convex_hull} -/// a Boolean value to indicate whether the algorithm should first extract the so-called extreme -/// points of the data range (i.e. construct the convex hull) to reduce the input data range -/// and accelerate the algorithm. %Default is `true`. -/// \cgalParamEnd +/// \cgalParamNBegin{vertex_point_map} +/// \cgalParamDescription{a property map associating points to the vertices of `pmesh`} +/// \cgalParamType{a class model of `ReadablePropertyMap` with `boost::graph_traits::%vertex_descriptor` +/// as key type and `%Point_3` as value type} +/// \cgalParamDefault{`boost::get(CGAL::vertex_point, pmesh)`} +/// \cgalParamExtra{If this parameter is omitted, an internal property map for `CGAL::vertex_point_t` +/// should be available for the vertices of `pmesh`.} +/// \cgalParamNEnd +/// +/// \cgalParamNBegin{geom_traits} +/// \cgalParamDescription{an instance of a geometric traits class} +/// \cgalParamType{a model of `OrientedBoundingBoxTraits_3`} +/// \cgalParamDefault{a default-constructed object of type `CGAL::Oriented_bounding_box_traits_3`, +/// where `K` is a kernel type deduced from the point type.} +/// \cgalParamNEnd +/// +/// \cgalParamNBegin{use_convex_hull} +/// \cgalParamDescription{Parameter used in the construction of oriented bounding box to indicate +/// whether the algorithm should first extract the extreme points (points +/// that are on the 3D convex hull) of the input data range +/// to accelerate the computation of the bounding box.} +/// \cgalParamType{Boolean} +/// \cgalParamDefault{`true`} +/// \cgalParamNEnd /// \cgalNamedParamsEnd /// template