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

Subject: [Boost-commit] svn:boost r64530 - sandbox/geometry/boost/geometry/algorithms
From: barend.gehrels_at_[hidden]
Date: 2010-08-01 16:22:49

Author: barendgehrels
Date: 2010-08-01 16:22:44 EDT (Sun, 01 Aug 2010)
New Revision: 64530
URL: http://svn.boost.org/trac/boost/changeset/64530

Log:
Updated comments for (experimental) qbk
Text files modified: 
   sandbox/geometry/boost/geometry/algorithms/area.hpp |    37 ++++++++++++++++++++++---------------   
   1 files changed, 22 insertions(+), 15 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-08-01 16:22:44 EDT (Sun, 01 Aug 2010)
@@ -91,8 +91,8 @@
 
 template
 <
-    typename Ring, 
-    iterate_direction Direction, 
+    typename Ring,
+    iterate_direction Direction,
     closure_selector Closure,
     typename Strategy
 >
@@ -168,9 +168,9 @@
         > {};
 
 
-template 
+template
 <
-    typename Geometry, 
+    typename Geometry,
     typename Strategy
 >
 struct area<box_tag, Geometry, Strategy>
@@ -178,15 +178,15 @@
 {};
 
 
-template 
+template
 <
-    typename Ring, 
+    typename Ring,
     typename Strategy
 >
 struct area<ring_tag, Ring, Strategy>
     : detail::area::ring_area
         <
-            Ring, 
+            Ring,
             order_as_direction<geometry::point_order<Ring>::value>::value,
             geometry::closure<Ring>::value,
             Strategy
@@ -194,9 +194,9 @@
 {};
 
 
-template 
+template
 <
-    typename Polygon, 
+    typename Polygon,
     typename Strategy
 >
 struct area<polygon_tag, Polygon, Strategy>
@@ -229,8 +229,12 @@
     provided for cartesian and spherical coordinate systems
     The geometries should correct, polygons should be closed
     and according to the specified orientation (clockwise/counter clockwise)
-    \param geometry a geometry
-    \return the area
+    \tparam Geometry A type fulfilling any Geometry concept
+    \param geometry A model of Geometry
+    \return The calculated area
+
+    \xmlonly <qbk.example>area_polygon</qbk.example> \endxmlonly
+    \xmlonly <qbk.example>area_polygon_spherical</qbk.example> \endxmlonly
  */
 template <typename Geometry>
 inline typename area_result<Geometry>::type area(Geometry const& geometry)
@@ -251,10 +255,13 @@
     \brief Calculate area of a geometry using a specified strategy
     \ingroup area
     \details This version of area calculation takes a strategy
-    \param geometry a geometry
-    \param strategy the strategy to calculate area.
-        Especially for spherical areas there are some approaches.
-    \return the area
+    \tparam Geometry A type fulfilling any Geometry concept
+    \tparam Strategy A type fulfilling a AreaStrategy concept
+    \param geometry A model of Geometry
+    \param strategy A strategy to calculate area.
+        Especially for spherical and geographical area calculations there
+        are various approaches.
+    \return The calculated area
  */
 template <typename Geometry, typename Strategy>
 inline typename Strategy::return_type area(