[MeL] Document isPntInElement nodes param. copydoc

Extend and unify documentation, fix function's argument name.

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.

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.

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.

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.

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.

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.

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
     {

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.

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.