[Boost-commit] svn:boost r66113 - sandbox/geometry/boost/geometry/algorithms

Subject: [Boost-commit] svn:boost r66113 - sandbox/geometry/boost/geometry/algorithms
From: mateusz_at_[hidden]
Date: 2010-10-19 20:09:45

Author: mloskot
Date: 2010-10-19 20:09:40 EDT (Tue, 19 Oct 2010)
New Revision: 66113
URL: http://svn.boost.org/trac/boost/changeset/66113

Log:
[geometry] Updated detailed description of area algorithm. Paragraphs copied from previous version of quickbook doc.
Text files modified: 
   sandbox/geometry/boost/geometry/algorithms/area.hpp |     9 +++++++++                               
   1 files changed, 9 insertions(+), 0 deletions(-)

Modified: sandbox/geometry/boost/geometry/algorithms/area.hpp
==============================================================================
--- sandbox/geometry/boost/geometry/algorithms/area.hpp	(original)
+++ sandbox/geometry/boost/geometry/algorithms/area.hpp	2010-10-19 20:09:40 EDT (Tue, 19 Oct 2010)
@@ -200,6 +200,15 @@
 \brief \brief_calc{area}
 \ingroup area
 \details \details_calc{area}. \details_default_strategy
+
+The area algorithm calculates the surface area of all geometries having a surface, namely
+box, polygon, ring, multipolygon. The units are the square of the units used for the points
+defining the surface. If subject geometry is defined in meters, then area is calculated
+in square meters.
+
+The area calculation can be done in all three common coordinate systems, Cartesian, Spherical
+and Geographic as well.
+
 \tparam Geometry \tparam_geometry
 \param geometry \param_geometry
 \return \return_calc{area}