From a7dacf6aedb269f52dc4335ba8084851fd47c9f5 Mon Sep 17 00:00:00 2001
From: Dmitri Naumov <dmitri.naumov@ufz.de>
Date: Tue, 22 Nov 2016 17:17:46 +0100
Subject: [PATCH] [MeL] Document isPntInElement nodes param. copydoc
Extend and unify documentation, fix function's argument name.
---
MeshLib/Elements/HexRule8.h | 9 ++++-----
MeshLib/Elements/LineRule2.h | 9 ++++-----
MeshLib/Elements/PointRule1.h | 11 ++++-------
MeshLib/Elements/PrismRule6.h | 9 ++++-----
MeshLib/Elements/PyramidRule5.h | 9 ++++-----
MeshLib/Elements/QuadRule4.h | 9 ++++-----
MeshLib/Elements/TemplateElement.h | 8 ++++----
MeshLib/Elements/TetRule4.h | 9 ++++-----
MeshLib/Elements/TriRule3.h | 9 ++++-----
9 files changed, 36 insertions(+), 46 deletions(-)
diff --git a/MeshLib/Elements/HexRule8.h b/MeshLib/Elements/HexRule8.h
index 9c6bbf64ca8..9fcd4417571 100644
--- a/MeshLib/Elements/HexRule8.h
+++ b/MeshLib/Elements/HexRule8.h
@@ -80,12 +80,11 @@ public:
static const Element* getFace(const Element* e, unsigned i);
/**
- * Checks if a point is inside the element.
- * @param pnt a 3D MathLib::Point3D object
- * @param eps tolerance for numerical algorithm used or computing the property
- * @return true if the point is not outside the element, false otherwise
+ * \copydoc MeshLib::Element::isPntInElement()
+ * @param nodes the nodes of the element.
*/
- static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps);
+ static bool isPntInElement(Node const* const* nodes,
+ MathLib::Point3d const& pnt, double eps);
/**
* Tests if the element is geometrically valid.
diff --git a/MeshLib/Elements/LineRule2.h b/MeshLib/Elements/LineRule2.h
index 9583918cb13..ebfa3dd2861 100644
--- a/MeshLib/Elements/LineRule2.h
+++ b/MeshLib/Elements/LineRule2.h
@@ -49,12 +49,11 @@ public:
typedef LinearEdgeReturn EdgeReturn;
/**
- * Checks if a point is inside the element.
- * @param pnt a 3D MathLib::Point3d object
- * @param eps tolerance for numerical algorithm used or computing the property
- * @return true if the point is not outside the element, false otherwise
+ * \copydoc MeshLib::Element::isPntInElement()
+ * @param nodes the nodes of the element.
*/
- static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps);
+ static bool isPntInElement(Node const* const* nodes,
+ MathLib::Point3d const& pnt, double eps);
/**
* Tests if the element is geometrically valid.
diff --git a/MeshLib/Elements/PointRule1.h b/MeshLib/Elements/PointRule1.h
index d807cea2866..64a7be67ee3 100644
--- a/MeshLib/Elements/PointRule1.h
+++ b/MeshLib/Elements/PointRule1.h
@@ -43,16 +43,13 @@ public:
/// Edge rule
typedef NoEdgeReturn EdgeReturn;
- /// Checks if a point is inside the element.
+ /// \copydoc MeshLib::Element::isPntInElement()
///
/// Specifically this function tests if the squared euclidean distance
- /// between the points \c _nodes and \c pnt is less then \c eps.
+ /// 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 for computing the
- /// property
- /// \return true if the point is not outside the element, false otherwise
- static bool isPntInElement(Node const* const* _nodes,
+ /// @param nodes the nodes of the element.
+ static bool isPntInElement(Node const* const* nodes,
MathLib::Point3d const& pnt, double eps);
/// Tests if the element is geometrically valid.
diff --git a/MeshLib/Elements/PrismRule6.h b/MeshLib/Elements/PrismRule6.h
index 0630d52ecfe..32340a942cf 100644
--- a/MeshLib/Elements/PrismRule6.h
+++ b/MeshLib/Elements/PrismRule6.h
@@ -81,12 +81,11 @@ public:
static const Element* getFace(const Element* e, unsigned i);
/**
- * Checks if a point is inside the element.
- * @param pnt a 3D MathLib::Point3d object
- * @param eps tolerance for numerical algorithm used or computing the property
- * @return true if the point is not outside the element, false otherwise
+ * \copydoc MeshLib::Element::isPntInElement()
+ * @param nodes the nodes of the element.
*/
- static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps);
+ static bool isPntInElement(Node const* const* nodes,
+ MathLib::Point3d const& pnt, double eps);
/**
* Tests if the element is geometrically valid.
diff --git a/MeshLib/Elements/PyramidRule5.h b/MeshLib/Elements/PyramidRule5.h
index 803723984e0..48b48d81a44 100644
--- a/MeshLib/Elements/PyramidRule5.h
+++ b/MeshLib/Elements/PyramidRule5.h
@@ -80,12 +80,11 @@ public:
static const Element* getFace(const Element* e, unsigned i);
/**
- * Checks if a point is inside the element.
- * @param pnt a 3D MathLib::Point3d object
- * @param eps tolerance for numerical algorithm used or computing the property
- * @return true if the point is not outside the element, false otherwise
+ * \copydoc MeshLib::Element::isPntInElement()
+ * @param nodes the nodes of the element.
*/
- static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps);
+ static bool isPntInElement(Node const* const* nodes,
+ MathLib::Point3d const& pnt, double eps);
/**
* Tests if the element is geometrically valid.
diff --git a/MeshLib/Elements/QuadRule4.h b/MeshLib/Elements/QuadRule4.h
index 8cad04ddc4e..d8516c0cd17 100644
--- a/MeshLib/Elements/QuadRule4.h
+++ b/MeshLib/Elements/QuadRule4.h
@@ -62,12 +62,11 @@ public:
typedef LinearEdgeReturn EdgeReturn;
/**
- * Checks if a point is inside the element.
- * @param pnt a 3D MathLib::Point3d object
- * @param eps tolerance for numerical algorithm used or computing the property
- * @return true if the point is not outside the element, false otherwise
+ * \copydoc MeshLib::Element::isPntInElement()
+ * @param nodes the nodes of the element.
*/
- static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps);
+ static bool isPntInElement(Node const* const* nodes,
+ MathLib::Point3d const& pnt, double eps);
/**
* Tests if the element is geometrically valid.
diff --git a/MeshLib/Elements/TemplateElement.h b/MeshLib/Elements/TemplateElement.h
index d93a4c95bc1..4885a548c40 100644
--- a/MeshLib/Elements/TemplateElement.h
+++ b/MeshLib/Elements/TemplateElement.h
@@ -108,10 +108,10 @@ public:
bool isEdge(unsigned idx1, unsigned idx2) const;
/**
- * Checks if a point is inside the element.
- * @param pnt a 3D MathLib::Point3d object
- * @param eps tolerance for numerical algorithm used or computing the property
- * @return true if the point is not outside the element, false otherwise
+ * \copydoc MeshLib::Element::isPntInElement()
+ *
+ * This is actually calling the correct implementation of this function
+ * passing the element's nodes.
*/
bool isPntInElement(MathLib::Point3d const& pnt, double eps = std::numeric_limits<double>::epsilon()) const
{
diff --git a/MeshLib/Elements/TetRule4.h b/MeshLib/Elements/TetRule4.h
index 53927c6272d..c9327e39f7a 100644
--- a/MeshLib/Elements/TetRule4.h
+++ b/MeshLib/Elements/TetRule4.h
@@ -75,12 +75,11 @@ public:
static const Element* getFace(const Element* e, unsigned i);
/**
- * Checks if a point is inside the element.
- * @param pnt a 3D MathLib::Point3d object
- * @param eps tolerance for numerical algorithm used or computing the property
- * @return true if the point is not outside the element, false otherwise
+ * \copydoc MeshLib::Element::isPntInElement()
+ * @param nodes the nodes of the element.
*/
- static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps);
+ static bool isPntInElement(Node const* const* nodes,
+ MathLib::Point3d const& pnt, double eps);
/**
* Tests if the element is geometrically valid.
diff --git a/MeshLib/Elements/TriRule3.h b/MeshLib/Elements/TriRule3.h
index 6f08356c0c5..7521f1b383e 100644
--- a/MeshLib/Elements/TriRule3.h
+++ b/MeshLib/Elements/TriRule3.h
@@ -63,12 +63,11 @@ public:
typedef LinearEdgeReturn EdgeReturn;
/**
- * Checks if a point is inside the element.
- * @param pnt a 3D MathLib::Point3d object
- * @param eps tolerance for numerical algorithm used or computing the property
- * @return true if the point is not outside the element, false otherwise
+ * \copydoc MeshLib::Element::isPntInElement()
+ * @param nodes the nodes of the element.
*/
- static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps);
+ static bool isPntInElement(Node const* const* nodes,
+ MathLib::Point3d const& pnt, double eps);
/**
* Tests if the element is geometrically valid.
--
GitLab