Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r85412 - in trunk: boost/geometry/strategies/cartesian boost/geometry/strategies/spherical libs/geometry/doc libs/geometry/doc/doxy
From: barend.gehrels_at_[hidden]
Date: 2013-08-20 16:22:33


Author: barendgehrels
Date: 2013-08-20 16:22:33 EDT (Tue, 20 Aug 2013)
New Revision: 85412
URL: http://svn.boost.org/trac/boost/changeset/85412

Log:
[geometry] fixed documentation: removed template parameters, made pythagoras back to a class, remove xml files in make_qbk to avoid using old ones

Text files modified:
   trunk/boost/geometry/strategies/cartesian/distance_projected_point.hpp | 2 --
   trunk/boost/geometry/strategies/cartesian/distance_pythagoras.hpp | 6 +++---
   trunk/boost/geometry/strategies/spherical/distance_cross_track.hpp | 2 --
   trunk/boost/geometry/strategies/spherical/distance_haversine.hpp | 3 +--
   trunk/libs/geometry/doc/doxy/Doxyfile | 1 +
   trunk/libs/geometry/doc/make_qbk.py | 1 +
   6 files changed, 6 insertions(+), 9 deletions(-)

Modified: trunk/boost/geometry/strategies/cartesian/distance_projected_point.hpp
==============================================================================
--- trunk/boost/geometry/strategies/cartesian/distance_projected_point.hpp Tue Aug 20 15:42:20 2013 (r85411)
+++ trunk/boost/geometry/strategies/cartesian/distance_projected_point.hpp 2013-08-20 16:22:33 EDT (Tue, 20 Aug 2013) (r85412)
@@ -50,8 +50,6 @@
 \ingroup strategies
 \details Calculates distance using projected-point method, and (optionally) Pythagoras
 \author Adapted from: http://geometryalgorithms.com/Archive/algorithm_0102/algorithm_0102.htm
-\tparam Point \tparam_point
-\tparam PointOfSegment \tparam_segment_point
 \tparam CalculationType \tparam_calculation
 \tparam Strategy underlying point-point distance strategy
 \par Concepts for Strategy:

Modified: trunk/boost/geometry/strategies/cartesian/distance_pythagoras.hpp
==============================================================================
--- trunk/boost/geometry/strategies/cartesian/distance_pythagoras.hpp Tue Aug 20 15:42:20 2013 (r85411)
+++ trunk/boost/geometry/strategies/cartesian/distance_pythagoras.hpp 2013-08-20 16:22:33 EDT (Tue, 20 Aug 2013) (r85412)
@@ -115,8 +115,6 @@
 /*!
 \brief Strategy to calculate the distance between two points
 \ingroup strategies
-\tparam Point1 \tparam_first_point
-\tparam Point2 \tparam_second_point
 \tparam CalculationType \tparam_calculation
 
 \qbk{
@@ -131,8 +129,10 @@
 <
     typename CalculationType = void
>
-struct pythagoras
+class pythagoras
 {
+public :
+
     template <typename P1, typename P2>
     struct calculation_type
         : util::calculation_type::geometric::binary

Modified: trunk/boost/geometry/strategies/spherical/distance_cross_track.hpp
==============================================================================
--- trunk/boost/geometry/strategies/spherical/distance_cross_track.hpp Tue Aug 20 15:42:20 2013 (r85411)
+++ trunk/boost/geometry/strategies/spherical/distance_cross_track.hpp 2013-08-20 16:22:33 EDT (Tue, 20 Aug 2013) (r85412)
@@ -44,8 +44,6 @@
 \ingroup strategies
 \details Class which calculates the distance of a point to a segment, using latlong points
 \see http://williams.best.vwh.net/avform.htm
-\tparam Point point type
-\tparam PointOfSegment \tparam_segment_point
 \tparam CalculationType \tparam_calculation
 \tparam Strategy underlying point-point distance strategy, defaults to haversine
 

Modified: trunk/boost/geometry/strategies/spherical/distance_haversine.hpp
==============================================================================
--- trunk/boost/geometry/strategies/spherical/distance_haversine.hpp Tue Aug 20 15:42:20 2013 (r85411)
+++ trunk/boost/geometry/strategies/spherical/distance_haversine.hpp 2013-08-20 16:22:33 EDT (Tue, 20 Aug 2013) (r85412)
@@ -100,8 +100,7 @@
 \brief Distance calculation for spherical coordinates
 on a perfect sphere using haversine
 \ingroup strategies
-\tparam Point1 \tparam_first_point
-\tparam Point2 \tparam_second_point
+\tparam RadiusType \tparam_radius
 \tparam CalculationType \tparam_calculation
 \author Adapted from: http://williams.best.vwh.net/avform.htm
 \see http://en.wikipedia.org/wiki/Great-circle_distance

Modified: trunk/libs/geometry/doc/doxy/Doxyfile
==============================================================================
--- trunk/libs/geometry/doc/doxy/Doxyfile Tue Aug 20 15:42:20 2013 (r85411)
+++ trunk/libs/geometry/doc/doxy/Doxyfile 2013-08-20 16:22:33 EDT (Tue, 20 Aug 2013) (r85412)
@@ -54,6 +54,7 @@
                         tparam_box="Any type fulfilling a Box Concept" \
                         tparam_box_or_segment="Any type fulfilling a Box Concept or a Segment Concept" \
                         tparam_calculation="numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point" \
+ tparam_radius="numeric type for radius (of sphere, earth)" \
                         tparam_container="container type, for example std::vector, std::deque" \
                         tparam_dimension_required="Dimension, this template parameter is required. Should contain \\[0 .. n-1\\] for an n-dimensional geometry" \
                         tparam_first_point="first point type" \

Modified: trunk/libs/geometry/doc/make_qbk.py
==============================================================================
--- trunk/libs/geometry/doc/make_qbk.py Tue Aug 20 15:42:20 2013 (r85411)
+++ trunk/libs/geometry/doc/make_qbk.py 2013-08-20 16:22:33 EDT (Tue, 20 Aug 2013) (r85412)
@@ -36,6 +36,7 @@
 
 def call_doxygen():
     os.chdir("doxy");
+ os.system("rm -f doxygen_output/xml/*.xml")
     os.system(doxygen_cmd)
     os.chdir("..")
 


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk