boost/geometry
2
0
Fork 0
mirror of https://github.com/boostorg/geometry.git synced 2026-02-12 12:12:10 +00:00
Code Issues Projects Releases Wiki Activity

[geometry] Updated detailed description of area algorithm. Paragraphs copied from previous version of quickbook doc.

Browse Source 
[SVN r66113]
This commit is contained in:
Mateusz Loskot
2010-10-20 00:09:40 +00:00
parent d33a1519c6
commit b0ee536873
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
include/boost/geometry/algorithms/area.hpp
View File

@@ -200,6 +200,15 @@ struct area<polygon_tag, Polygon, Strategy>
\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}