From d8f4b546540bd4c523cc46b2caac1c7f59000710 Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Tue, 3 Nov 2015 08:36:14 +0100
Subject: [PATCH] [MeL] updated doc for PointRule1

---
 MeshLib/Elements/PointRule1.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/MeshLib/Elements/PointRule1.h b/MeshLib/Elements/PointRule1.h
index eb6c63f20d9..80da548d108 100644
--- a/MeshLib/Elements/PointRule1.h
+++ b/MeshLib/Elements/PointRule1.h
@@ -44,8 +44,12 @@ public:
 	typedef NoEdgeReturn EdgeReturn;
 
 	/// Checks if a point is inside the element.
+	///
+	/// Specifically this function tests if the squared euclidean distance
+	/// between the points \c _nodes and \c pnt is less then \c eps.
+	///
 	/// \param pnt a 3D MathLib::Point3d object
-	/// \param eps tolerance for numerical algorithm used or computing the
+	/// \param eps tolerance for numerical algorithm used for computing the
 	/// property
 	/// \return true if the point is not outside the element, false otherwise
 	static bool isPntInElement(Node const* const* _nodes,
-- 
GitLab