From b0ee5368730f12d14cb065d7809c689bd051efde Mon Sep 17 00:00:00 2001 From: Mateusz Loskot Date: Wed, 20 Oct 2010 00:09:40 +0000 Subject: [PATCH] [geometry] Updated detailed description of area algorithm. Paragraphs copied from previous version of quickbook doc. [SVN r66113] --- include/boost/geometry/algorithms/area.hpp | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/include/boost/geometry/algorithms/area.hpp b/include/boost/geometry/algorithms/area.hpp index dbc03c5c3..69a574c4c 100644 --- a/include/boost/geometry/algorithms/area.hpp +++ b/include/boost/geometry/algorithms/area.hpp @@ -200,6 +200,15 @@ struct area \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}