From a1710c2bd3a0ffc41af0484f72f864076fb64ee4 Mon Sep 17 00:00:00 2001 From: Menelaos Karavelas Date: Wed, 2 Jul 2014 11:50:04 +0300 Subject: [PATCH] [doc][algorithms] add documentation for the comparable_distance free function that takes a strategy --- .../detail/comparable_distance/interface.hpp | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/include/boost/geometry/algorithms/detail/comparable_distance/interface.hpp b/include/boost/geometry/algorithms/detail/comparable_distance/interface.hpp index 45f4fcdf1..d009ba7ef 100644 --- a/include/boost/geometry/algorithms/detail/comparable_distance/interface.hpp +++ b/include/boost/geometry/algorithms/detail/comparable_distance/interface.hpp @@ -27,7 +27,24 @@ namespace boost { namespace geometry { -// MK::need to add qbk documentation +/*! +\brief \brief_calc2{comparable distance measurement} \brief_strategy +\ingroup distance +\details The free function comparable_distance does not necessarily calculate the distance, + but it calculates a distance measure such that two distances are comparable to each other. + For example: for the Cartesian coordinate system, Pythagoras is used but the square root + is not taken, which makes it faster and the results of two point pairs can still be + compared to each other. +\tparam Geometry1 first geometry type +\tparam Geometry2 second geometry type +\tparam Strategy \tparam_strategy{Distance} +\param geometry1 \param_geometry +\param geometry2 \param_geometry +\param strategy \param_strategy{distance} +\return \return_calc{comparable distance} + +\qbk{distinguish,with strategy} + */ template inline typename strategy::distance::services::return_type <