[Boost-commit] svn:boost r71124 - trunk/boost/geometry/algorithms

Subject: [Boost-commit] svn:boost r71124 - trunk/boost/geometry/algorithms
From: barend.gehrels_at_[hidden]
Date: 2011-04-08 16:19:02

Author: barendgehrels
Date: 2011-04-08 16:19:01 EDT (Fri, 08 Apr 2011)
New Revision: 71124
URL: http://svn.boost.org/trac/boost/changeset/71124

Log:
Doc update, added behaviour/samples of clear, expand, reverse, unique

Text files modified: 
   trunk/boost/geometry/algorithms/clear.hpp   |     4 ++++                                    
   trunk/boost/geometry/algorithms/expand.hpp  |     8 +++++---                                
   trunk/boost/geometry/algorithms/reverse.hpp |     7 ++++++-                                 
   trunk/boost/geometry/algorithms/unique.hpp  |     2 ++                                      
   4 files changed, 17 insertions(+), 4 deletions(-)

Modified: trunk/boost/geometry/algorithms/clear.hpp
==============================================================================
--- trunk/boost/geometry/algorithms/clear.hpp	(original)
+++ trunk/boost/geometry/algorithms/clear.hpp	2011-04-08 16:19:01 EDT (Fri, 08 Apr 2011)
@@ -134,7 +134,11 @@
     the case of a polygon, this clear functionality is automatically called for the exterior ring, and for the
     interior ring collection. In the case of a point, boxes and segments, nothing will happen.
 \ingroup clear
+\tparam Geometry \tparam_geometry
+\param geometry \param_geometry which will be cleared
 \note points and boxes cannot be cleared, instead they can be set to zero by "assign_zero"
+
+\qbk{[include reference/algorithms/clear.qbk]}
 */
 template <typename Geometry>
 inline void clear(Geometry& geometry)

Modified: trunk/boost/geometry/algorithms/expand.hpp
==============================================================================
--- trunk/boost/geometry/algorithms/expand.hpp	(original)
+++ trunk/boost/geometry/algorithms/expand.hpp	2011-04-08 16:19:01 EDT (Fri, 08 Apr 2011)
@@ -291,12 +291,14 @@
 
 
 /*!
-\brief Expands a box using the extend (envelope) of another geometry (box, point)
+\brief Expands a box using the bounding box (envelope) of another geometry (box, point)
 \ingroup expand
 \tparam Box type of the box
 \tparam Geometry \tparam_geometry
-\param box box to expand another geometry with, might be changed
-\param geometry \param_geometry
+\param box box to be expanded using another geometry, mutable
+\param geometry \param_geometry geometry which envelope (bounding box) will be added to the box
+
+\qbk{[include reference/algorithms/expand.qbk]}
  */
 template <typename Box, typename Geometry>
 inline void expand(Box& box, Geometry const& geometry)

Modified: trunk/boost/geometry/algorithms/reverse.hpp
==============================================================================
--- trunk/boost/geometry/algorithms/reverse.hpp	(original)
+++ trunk/boost/geometry/algorithms/reverse.hpp	2011-04-08 16:19:01 EDT (Fri, 08 Apr 2011)
@@ -106,10 +106,15 @@
 
 
 /*!
-\brief Reverses a geometry
+\brief Reverses the points within a geometry
+\details Generic function to reverse a geometry. It resembles the std::reverse
+   functionality, but it takes the geometry type into account. Only for a ring
+   or for a linestring it is the same as the std::reverse.
 \ingroup reverse
 \tparam Geometry \tparam_geometry
 \param geometry \param_geometry which will be reversed
+
+\qbk{[include reference/algorithms/reverse.qbk]}
 */
 template <typename Geometry>
 inline void reverse(Geometry& geometry)

Modified: trunk/boost/geometry/algorithms/unique.hpp
==============================================================================
--- trunk/boost/geometry/algorithms/unique.hpp	(original)
+++ trunk/boost/geometry/algorithms/unique.hpp	2011-04-08 16:19:01 EDT (Fri, 08 Apr 2011)
@@ -124,6 +124,8 @@
 \details \details_calc{unique,minimal set (where duplicate consecutive points are removed)}.
 \tparam Geometry \tparam_geometry
 \param geometry \param_geometry which will be made unique
+
+\qbk{[include reference/algorithms/unique.qbk]}
 */
 template <typename Geometry>
 inline void unique(Geometry& geometry)