Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r78706 - trunk/boost/geometry/algorithms
From: barend.gehrels_at_[hidden]
Date: 2012-05-28 06:02:18


Author: barendgehrels
Date: 2012-05-28 06:02:17 EDT (Mon, 28 May 2012)
New Revision: 78706
URL: http://svn.boost.org/trac/boost/changeset/78706

Log:
[geometry] doc update for touches
Text files modified:
   trunk/boost/geometry/algorithms/touches.hpp | 12 ++++++------
   1 files changed, 6 insertions(+), 6 deletions(-)

Modified: trunk/boost/geometry/algorithms/touches.hpp
==============================================================================
--- trunk/boost/geometry/algorithms/touches.hpp (original)
+++ trunk/boost/geometry/algorithms/touches.hpp 2012-05-28 06:02:17 EDT (Mon, 28 May 2012)
@@ -84,13 +84,13 @@
 }}
 
 /*!
-\brief \brief_check{has at least one intersection (crossing or self-tangency)}
-\note This function can be called for one geometry (self-intersection) and
- also for two geometries (intersection)
+\brief \brief_check{has at least one touching point (self-tangency)}
+\note This function can be called for one geometry (self-tangency) and
+ also for two geometries (touch)
 \ingroup touches
 \tparam Geometry \tparam_geometry
 \param geometry \param_geometry
-\return \return_check{is self-intersecting}
+\return \return_check{is self-touching}
 
 \qbk{distinguish,one geometry}
 \qbk{[def __one_parameter__]}
@@ -129,13 +129,13 @@
 
 
 /*!
-\brief \brief_check2{have at least one intersection}
+\brief \brief_check2{have at least one touching point (tangent - non overlapping)}
 \ingroup touches
 \tparam Geometry1 \tparam_geometry
 \tparam Geometry2 \tparam_geometry
 \param geometry1 \param_geometry
 \param geometry2 \param_geometry
-\return \return_check2{intersect each other}
+\return \return_check2{touch each other}
 
 \qbk{distinguish,two geometries}
 \qbk{[include reference/algorithms/touches.qbk]}


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk