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

Subject: [Boost-commit] svn:boost r71156 - trunk/boost/geometry/algorithms
From: barend.gehrels_at_[hidden]
Date: 2011-04-09 17:24:55

Author: barendgehrels
Date: 2011-04-09 17:24:54 EDT (Sat, 09 Apr 2011)
New Revision: 71156
URL: http://svn.boost.org/trac/boost/changeset/71156

Log:
Added doc for equals
Text files modified: 
   trunk/boost/geometry/algorithms/equals.hpp |    10 +++++++++-                              
   1 files changed, 9 insertions(+), 1 deletions(-)

Modified: trunk/boost/geometry/algorithms/equals.hpp
==============================================================================
--- trunk/boost/geometry/algorithms/equals.hpp	(original)
+++ trunk/boost/geometry/algorithms/equals.hpp	2011-04-09 17:24:54 EDT (Sat, 09 Apr 2011)
@@ -271,12 +271,20 @@
 
 /*!
 \brief \brief_check{are spatially equal}
+\details \details_check12{equals, is spatially equal}. Spatially equal means 
+    that the same point set is included. A box can therefore be spatially equal
+    to a ring or a polygon, or a linestring can be spatially equal to a 
+    multi-linestring or a segment. This only theoretically, not all combinations
+    are implemented yet.
 \ingroup equals
 \tparam Geometry1 \tparam_geometry
 \tparam Geometry2 \tparam_geometry
 \param geometry1 \param_geometry
 \param geometry2 \param_geometry
-\return \return_check2{are spatially disjoint}
+\return \return_check2{are spatially equal}
+
+\qbk{[include reference/algorithms/equals.qbk]}
+
  */
 template <typename Geometry1, typename Geometry2>
 inline bool equals(Geometry1 const& geometry1, Geometry2 const& geometry2)