[Boost-commit] svn:boost r85413 - in trunk/boost/geometry/strategies: agnostic cartesian spherical transform

Subject: [Boost-commit] svn:boost r85413 - in trunk/boost/geometry/strategies: agnostic cartesian spherical transform
From: barend.gehrels_at_[hidden]
Date: 2013-08-20 16:39:33

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

Log:
[geometry] small fixes/typos in documentation for strategies

Text files modified: 
   trunk/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp |     9 ++++++---                               
   trunk/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp |    21 ++++++++++++---------                   
   trunk/boost/geometry/strategies/spherical/distance_cross_track.hpp    |     2 +-                                      
   trunk/boost/geometry/strategies/transform/inverse_transformer.hpp     |     2 +-                                      
   trunk/boost/geometry/strategies/transform/map_transformer.hpp         |     2 +-                                      
   trunk/boost/geometry/strategies/transform/matrix_transformers.hpp     |     2 +-                                      
   6 files changed, 22 insertions(+), 16 deletions(-)

Modified: trunk/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp
==============================================================================
--- trunk/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp	Tue Aug 20 16:22:33 2013	(r85412)
+++ trunk/boost/geometry/strategies/agnostic/simplify_douglas_peucker.hpp	2013-08-20 16:39:33 EDT (Tue, 20 Aug 2013)	(r85413)
@@ -74,9 +74,6 @@
 \ingroup strategies
 \details The douglas_peucker strategy simplifies a linestring, ring or
     vector of points using the well-known Douglas-Peucker algorithm.
-    For the algorithm, see for example:
-\see http://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm
-\see http://www2.dcs.hull.ac.uk/CISRG/projects/Royal-Inst/demos/dp.html
 \tparam Point the point type
 \tparam PointDistanceStrategy point-segment distance strategy to be used
 \note This strategy uses itself a point-segment-distance strategy which
@@ -84,6 +81,12 @@
 \author Barend and Maarten, 1995/1996
 \author Barend, revised for Generic Geometry Library, 2008
 */
+
+/*
+For the algorithm, see for example:
+ - http://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm
+ - http://www2.dcs.hull.ac.uk/CISRG/projects/Royal-Inst/demos/dp.html
+*/
 template
 <
     typename Point,

Modified: trunk/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp
==============================================================================
--- trunk/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp	Tue Aug 20 16:22:33 2013	(r85412)
+++ trunk/boost/geometry/strategies/cartesian/centroid_bashein_detmer.hpp	2013-08-20 16:39:33 EDT (Tue, 20 Aug 2013)	(r85413)
@@ -38,17 +38,26 @@
 
 
 /*!
-\brief Centroid calculation using algorith Bashein / Detmer
+\brief Centroid calculation using algorithm Bashein / Detmer
 \ingroup strategies
 \details Calculates centroid using triangulation method published by
     Bashein / Detmer
 \tparam Point point type of centroid to calculate
 \tparam PointOfSegment point type of segments, defaults to Point
-\par Concepts for Point and PointOfSegment:
-- specialized point_traits class
+\tparam CalculationType \tparam_calculation
+
 \author Adapted from  "Centroid of a Polygon" by
     Gerard Bashein and Paul R. Detmer<em>,
 in "Graphics Gems IV", Academic Press, 1994</em>
+
+
+\qbk{
+[heading See also]
+[link geometry.reference.algorithms.centroid.centroid_3_with_strategy centroid (with strategy)]
+}
+*/
+
+/*
 \par Research notes
 The algorithm gives the same results as Oracle and PostGIS but
     differs from MySQL
@@ -100,12 +109,6 @@
         , mdsys.sdo_dim_array(mdsys.sdo_dim_element('x',0,10,.00000005)
         ,mdsys.sdo_dim_element('y',0,10,.00000005)))
         from dual
-
-\qbk{
-[heading See also]
-[link geometry.reference.algorithms.centroid.centroid_3_with_strategy centroid (with strategy)]
-}
-
  */
 template
 <

Modified: trunk/boost/geometry/strategies/spherical/distance_cross_track.hpp
==============================================================================
--- trunk/boost/geometry/strategies/spherical/distance_cross_track.hpp	Tue Aug 20 16:22:33 2013	(r85412)
+++ trunk/boost/geometry/strategies/spherical/distance_cross_track.hpp	2013-08-20 16:39:33 EDT (Tue, 20 Aug 2013)	(r85413)
@@ -42,7 +42,7 @@
 /*!
 \brief Strategy functor for distance point to segment calculation
 \ingroup strategies
-\details Class which calculates the distance of a point to a segment, using latlong points
+\details Class which calculates the distance of a point to a segment, for points on a sphere or globe
 \see http://williams.best.vwh.net/avform.htm
 \tparam CalculationType \tparam_calculation
 \tparam Strategy underlying point-point distance strategy, defaults to haversine

Modified: trunk/boost/geometry/strategies/transform/inverse_transformer.hpp
==============================================================================
--- trunk/boost/geometry/strategies/transform/inverse_transformer.hpp	Tue Aug 20 16:22:33 2013	(r85412)
+++ trunk/boost/geometry/strategies/transform/inverse_transformer.hpp	2013-08-20 16:39:33 EDT (Tue, 20 Aug 2013)	(r85413)
@@ -31,7 +31,7 @@
 {
 
 /*!
-\brief Transformation strategy to do an inverse ransformation in Cartesian system
+\brief Transformation strategy to do an inverse transformation in a Cartesian coordinate system
 \ingroup strategies
  */
 template

Modified: trunk/boost/geometry/strategies/transform/map_transformer.hpp
==============================================================================
--- trunk/boost/geometry/strategies/transform/map_transformer.hpp	Tue Aug 20 16:22:33 2013	(r85412)
+++ trunk/boost/geometry/strategies/transform/map_transformer.hpp	2013-08-20 16:39:33 EDT (Tue, 20 Aug 2013)	(r85413)
@@ -32,7 +32,7 @@
 {
 
 /*!
-\brief Transformation strategy to do map from one to another Cartesian system
+\brief Transformation strategy to map from one to another Cartesian coordinate system
 \ingroup strategies
 \tparam Mirror if true map is mirrored upside-down (in most cases pixels
     are from top to bottom, while map is from bottom to top)

Modified: trunk/boost/geometry/strategies/transform/matrix_transformers.hpp
==============================================================================
--- trunk/boost/geometry/strategies/transform/matrix_transformers.hpp	Tue Aug 20 16:22:33 2013	(r85412)
+++ trunk/boost/geometry/strategies/transform/matrix_transformers.hpp	2013-08-20 16:39:33 EDT (Tue, 20 Aug 2013)	(r85413)
@@ -359,7 +359,7 @@
 
 
 /*!
-\brief Strategy of rotate transformation in Cartesian system.
+\brief Strategy for rotate transformation in Cartesian coordinate system.
 \details Rotate rotates a geometry of specified angle about a fixed point (e.g. origin).
 \see http://en.wikipedia.org/wiki/Rotation_%28mathematics%29
 \ingroup strategies