From 9930615207e9ab664b68ab2ef7579b152ee272c9 Mon Sep 17 00:00:00 2001 From: Menelaos Karavelas Date: Fri, 27 Jun 2014 03:35:31 +0300 Subject: [PATCH 1/2] [strategies][distance] update doxygen documentation for pythagoras point-box and box-box strategies --- .../cartesian/distance_pythagoras_box_box.hpp | 2 +- .../cartesian/distance_pythagoras_point_box.hpp | 13 +++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/include/boost/geometry/strategies/cartesian/distance_pythagoras_box_box.hpp b/include/boost/geometry/strategies/cartesian/distance_pythagoras_box_box.hpp index de31bf8f3..8a4234282 100644 --- a/include/boost/geometry/strategies/cartesian/distance_pythagoras_box_box.hpp +++ b/include/boost/geometry/strategies/cartesian/distance_pythagoras_box_box.hpp @@ -139,7 +139,7 @@ public : /*! -\brief Strategy to calculate the distance between two points or boxes +\brief Strategy to calculate the distance between two boxes \ingroup strategies \tparam CalculationType \tparam_calculation diff --git a/include/boost/geometry/strategies/cartesian/distance_pythagoras_point_box.hpp b/include/boost/geometry/strategies/cartesian/distance_pythagoras_point_box.hpp index 2641e7829..0ce1d422e 100644 --- a/include/boost/geometry/strategies/cartesian/distance_pythagoras_point_box.hpp +++ b/include/boost/geometry/strategies/cartesian/distance_pythagoras_point_box.hpp @@ -84,11 +84,12 @@ namespace comparable { /*! -\brief Strategy to calculate comparable distance between two points -\ingroup strategies -\tparam Point \tparam_first_point -\tparam Box \tparam_second_box -\tparam CalculationType \tparam_calculation + \brief Strategy to calculate comparable distance between a point + and a box + \ingroup strategies + \tparam Point \tparam_first_point + \tparam Box \tparam_second_box + \tparam CalculationType \tparam_calculation */ template class pythagoras_point_box @@ -132,7 +133,7 @@ public : /*! -\brief Strategy to calculate the distance between two points or boxes +\brief Strategy to calculate the distance between a point and a box \ingroup strategies \tparam CalculationType \tparam_calculation From 1465ada4ba88e78dd2e94ab2980430835e1607f6 Mon Sep 17 00:00:00 2001 From: Menelaos Karavelas Date: Fri, 27 Jun 2014 03:37:00 +0300 Subject: [PATCH 2/2] [doc][stratiegies][distance] add pythagoras point-box and box-box strategies --- doc/make_qbk.py | 3 ++- doc/quickref.xml | 2 ++ doc/reference.qbk | 2 ++ 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/make_qbk.py b/doc/make_qbk.py index 7bf5db409..92e082c03 100755 --- a/doc/make_qbk.py +++ b/doc/make_qbk.py @@ -109,7 +109,8 @@ models = ["point", "linestring", "box" , "multi_linestring", "multi_point", "multi_polygon", "referring_segment"] -strategies = ["distance::pythagoras", "distance::haversine" +strategies = ["distance::pythagoras", "distance::pythagoras_box_box" + , "distance::pythagoras_point_box", "distance::haversine" , "distance::cross_track", "distance::projected_point" , "within::winding", "within::franklin", "within::crossings_multiply" , "area::surveyor", "area::huiller" diff --git a/doc/quickref.xml b/doc/quickref.xml index 9e20847d3..e16e6535d 100644 --- a/doc/quickref.xml +++ b/doc/quickref.xml @@ -519,6 +519,8 @@ strategy::distance::projected_point strategy::distance::pythagoras + strategy::distance::pythagoras_box_box + strategy::distance::pythagoras_point_box strategy::distance::cross_track strategy::distance::haversine diff --git a/doc/reference.qbk b/doc/reference.qbk index 2b295d677..209ea7005 100644 --- a/doc/reference.qbk +++ b/doc/reference.qbk @@ -289,6 +289,8 @@ [section:strategies Strategies] [include generated/distance_pythagoras.qbk] +[include generated/distance_pythagoras_box_box.qbk] +[include generated/distance_pythagoras_point_box.qbk] [include generated/distance_haversine.qbk] [include generated/distance_projected_point.qbk] [include generated/distance_cross_track.qbk]