From f9d9cc2178bc07e78eb72a0dcddc78fa1d6f650b Mon Sep 17 00:00:00 2001 From: Adam Wulkiewicz Date: Sun, 26 Feb 2017 01:37:54 +0100 Subject: [PATCH] [relops] Alter doc comments (versions taking strategies). --- include/boost/geometry/algorithms/crosses.hpp | 1 + .../algorithms/detail/disjoint/interface.hpp | 1 + .../algorithms/detail/envelope/interface.hpp | 29 ++++++++++++++++++- .../algorithms/detail/expand/interface.hpp | 3 ++ .../detail/overlay/self_turn_points.hpp | 1 + .../algorithms/detail/relate/interface.hpp | 1 + .../algorithms/detail/relation/interface.hpp | 1 + include/boost/geometry/algorithms/equals.hpp | 3 +- .../boost/geometry/algorithms/intersects.hpp | 2 +- .../boost/geometry/algorithms/overlaps.hpp | 1 + include/boost/geometry/algorithms/touches.hpp | 2 +- 11 files changed, 40 insertions(+), 5 deletions(-) diff --git a/include/boost/geometry/algorithms/crosses.hpp b/include/boost/geometry/algorithms/crosses.hpp index 8a906b2e1..c9e3651ab 100644 --- a/include/boost/geometry/algorithms/crosses.hpp +++ b/include/boost/geometry/algorithms/crosses.hpp @@ -228,6 +228,7 @@ namespace resolve_variant \param strategy \param_strategy{crosses} \return \return_check2{crosses} +\qbk{distinguish,with strategy} \qbk{[include reference/algorithms/crosses.qbk]} */ template diff --git a/include/boost/geometry/algorithms/detail/disjoint/interface.hpp b/include/boost/geometry/algorithms/detail/disjoint/interface.hpp index 9b505e560..64898e35f 100644 --- a/include/boost/geometry/algorithms/detail/disjoint/interface.hpp +++ b/include/boost/geometry/algorithms/detail/disjoint/interface.hpp @@ -203,6 +203,7 @@ struct disjoint \param strategy \param_strategy{disjoint} \return \return_check2{are disjoint} +\qbk{distinguish,with strategy} \qbk{[include reference/algorithms/disjoint.qbk]} */ template diff --git a/include/boost/geometry/algorithms/detail/envelope/interface.hpp b/include/boost/geometry/algorithms/detail/envelope/interface.hpp index d768c2bbd..8e9c35b39 100644 --- a/include/boost/geometry/algorithms/detail/envelope/interface.hpp +++ b/include/boost/geometry/algorithms/detail/envelope/interface.hpp @@ -135,6 +135,7 @@ struct envelope > \param mbr \param_box \param_set{envelope} \param strategy \param_strategy{envelope} +\qbk{distinguish,with strategy} \qbk{[include reference/algorithms/envelope.qbk]} \qbk{ [heading Example] @@ -142,7 +143,7 @@ struct envelope > } */ template -inline void envelope(Geometry const& geometry, Box& mbr, Strategy& strategy) +inline void envelope(Geometry const& geometry, Box& mbr, Strategy const& strategy) { resolve_variant::envelope::apply(geometry, mbr, strategy); } @@ -169,6 +170,32 @@ inline void envelope(Geometry const& geometry, Box& mbr) } +/*! +\brief \brief_calc{envelope} +\ingroup envelope +\details \details_calc{return_envelope,\det_envelope}. \details_return{envelope} +\tparam Box \tparam_box +\tparam Geometry \tparam_geometry +\tparam Strategy \tparam_strategy{Envelope} +\param geometry \param_geometry +\param strategy \param_strategy{envelope} +\return \return_calc{envelope} + +\qbk{distinguish,with strategy} +\qbk{[include reference/algorithms/envelope.qbk]} +\qbk{ +[heading Example] +[return_envelope] [return_envelope_output] +} +*/ +template +inline Box return_envelope(Geometry const& geometry, Strategy const& strategy) +{ + Box mbr; + resolve_variant::envelope::apply(geometry, mbr, strategy); + return mbr; +} + /*! \brief \brief_calc{envelope} \ingroup envelope diff --git a/include/boost/geometry/algorithms/detail/expand/interface.hpp b/include/boost/geometry/algorithms/detail/expand/interface.hpp index dc383d4b9..5aacd8e72 100644 --- a/include/boost/geometry/algorithms/detail/expand/interface.hpp +++ b/include/boost/geometry/algorithms/detail/expand/interface.hpp @@ -160,10 +160,13 @@ inline void expand(Box& box, Geometry const& geometry, \ingroup expand \tparam Box type of the box \tparam Geometry \tparam_geometry +\tparam Strategy \tparam_strategy{expand} \param box box to be expanded using another geometry, mutable \param geometry \param_geometry geometry which envelope (bounding box) +\param strategy \param_strategy{expand} will be added to the box +\qbk{distinguish,with strategy} \qbk{[include reference/algorithms/expand.qbk]} */ template diff --git a/include/boost/geometry/algorithms/detail/overlay/self_turn_points.hpp b/include/boost/geometry/algorithms/detail/overlay/self_turn_points.hpp index 61f2c737b..8540ef98a 100644 --- a/include/boost/geometry/algorithms/detail/overlay/self_turn_points.hpp +++ b/include/boost/geometry/algorithms/detail/overlay/self_turn_points.hpp @@ -272,6 +272,7 @@ struct self_get_turn_points \tparam Turns type of intersection container (e.g. vector of "intersection/turn point"'s) \param geometry geometry + \param strategy strategy to be used \param robust_policy policy to handle robustness issues \param turns container which will contain intersection points \param interrupt_policy policy determining if process is stopped diff --git a/include/boost/geometry/algorithms/detail/relate/interface.hpp b/include/boost/geometry/algorithms/detail/relate/interface.hpp index 29d346681..3575fe2bc 100644 --- a/include/boost/geometry/algorithms/detail/relate/interface.hpp +++ b/include/boost/geometry/algorithms/detail/relate/interface.hpp @@ -375,6 +375,7 @@ struct relate< \param strategy \param_strategy{relate} \return true if the relation is compatible with the mask, false otherwise. +\qbk{distinguish,with strategy} \qbk{[include reference/algorithms/relate.qbk]} */ template diff --git a/include/boost/geometry/algorithms/detail/relation/interface.hpp b/include/boost/geometry/algorithms/detail/relation/interface.hpp index 00a784b3d..83d27ed72 100644 --- a/include/boost/geometry/algorithms/detail/relation/interface.hpp +++ b/include/boost/geometry/algorithms/detail/relation/interface.hpp @@ -175,6 +175,7 @@ struct relation \param strategy \param_strategy{relation} \return The DE-9IM matrix expressing the relation between geometries. +\qbk{distinguish,with strategy} \qbk{[include reference/algorithms/relation.qbk]} */ template diff --git a/include/boost/geometry/algorithms/equals.hpp b/include/boost/geometry/algorithms/equals.hpp index 47eb7134c..cd7b72500 100644 --- a/include/boost/geometry/algorithms/equals.hpp +++ b/include/boost/geometry/algorithms/equals.hpp @@ -601,8 +601,8 @@ struct equals< \param strategy \param_strategy{equals} \return \return_check2{are spatially equal} +\qbk{distinguish,with strategy} \qbk{[include reference/algorithms/equals.qbk]} - */ template inline bool equals(Geometry1 const& geometry1, @@ -631,7 +631,6 @@ inline bool equals(Geometry1 const& geometry1, \return \return_check2{are spatially equal} \qbk{[include reference/algorithms/equals.qbk]} - */ template inline bool equals(Geometry1 const& geometry1, Geometry2 const& geometry2) diff --git a/include/boost/geometry/algorithms/intersects.hpp b/include/boost/geometry/algorithms/intersects.hpp index e54b00503..12ae169f1 100644 --- a/include/boost/geometry/algorithms/intersects.hpp +++ b/include/boost/geometry/algorithms/intersects.hpp @@ -97,7 +97,7 @@ inline bool intersects(Geometry const& geometry) \param strategy \param_strategy{intersects} \return \return_check2{intersect each other} -\qbk{distinguish,two geometries} +\qbk{distinguish,with strategy} \qbk{[include reference/algorithms/intersects.qbk]} */ template diff --git a/include/boost/geometry/algorithms/overlaps.hpp b/include/boost/geometry/algorithms/overlaps.hpp index 800d6dac1..bedf17599 100644 --- a/include/boost/geometry/algorithms/overlaps.hpp +++ b/include/boost/geometry/algorithms/overlaps.hpp @@ -180,6 +180,7 @@ struct overlaps \param strategy \param_strategy{overlaps} \return \return_check2{overlap} +\qbk{distinguish,with strategy} \qbk{[include reference/algorithms/overlaps.qbk]} */ template diff --git a/include/boost/geometry/algorithms/touches.hpp b/include/boost/geometry/algorithms/touches.hpp index 83f2b1dfa..49e104d25 100644 --- a/include/boost/geometry/algorithms/touches.hpp +++ b/include/boost/geometry/algorithms/touches.hpp @@ -687,7 +687,7 @@ inline bool touches(Geometry1 const& geometry1, Geometry2 const& geometry2) \param strategy \param_strategy{touches} \return \return_check2{touch each other} -\qbk{distinguish,two geometries} +\qbk{distinguish,with strategy} \qbk{[include reference/algorithms/touches.qbk]} */ template