correct documentation

MeshLib/Elements/Cell.cpp

@@ -35,6 +35,10 @@ bool Cell::testElementNodeOrder() const
 	for (unsigned j=0; j<nFaces; ++j)
 	{
 		MeshLib::Face const*const face (dynamic_cast<const MeshLib::Face*>(this->getFace(j)));
+		// Node 1 is checked below because that way all nodes are used for the test
+		// at some point, while for node 0 at least one node in every element
+		// type would be used for checking twice and one wouldn't be checked at
+		// all. (based on the definition of the _face_nodes variable)
 		const MeshLib::Node x (*(face->getNode(1)));
 		const MathLib::Vector3 cx (c, x);
 		const double s = MathLib::scalarProduct(face->getSurfaceNormal(), cx);

MeshLib/Elements/CellRule.cpp

@@ -28,6 +28,10 @@ bool CellRule::testElementNodeOrder(const Element* e)
 	for (unsigned j=0; j<nFaces; ++j)
 	{
 		MeshLib::Face const*const face (dynamic_cast<const MeshLib::Face*>(e->getFace(j)));
+		// Node 1 is checked below because that way all nodes are used for the test
+		// at some point, while for node 0 at least one node in every element
+		// type would be used for checking twice and one wouldn't be checked at
+		// all. (based on the definition of the _face_nodes variable)
 		const MeshLib::Node x (*(face->getNode(1)));
 		const MathLib::Vector3 cx (c, x);
 		const double s = MathLib::scalarProduct(face->getSurfaceNormal(), cx);

MeshLib/Elements/Element.h

@@ -225,6 +225,7 @@ protected:
 
 	Node** _nodes;
 	std::size_t _id;
+	/// Content corresponds to length for 1D, area for 2D, and volume for 3D elements
 	double _content;
 	/**
 	 * this is an index for external additional information like materials

MeshLib/Elements/HexRule8.h

@@ -84,7 +84,7 @@ public:
 
 	/**
 	 * Checks if a point is inside the element.
-	 * @param pnt a 3D GeoLib::Point object
+	 * @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
 	 */

MeshLib/Elements/LineRule2.h

@@ -64,7 +64,7 @@ public:
 
 	/**
 	 * Checks if a point is inside the element.
-	 * @param pnt a 3D GeoLib::Point object
+	 * @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
 	 */

MeshLib/Elements/PrismRule6.h

@@ -85,7 +85,7 @@ public:
 
 	/**
 	 * Checks if a point is inside the element.
-	 * @param pnt a 3D GeoLib::Point object
+	 * @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
 	 */

MeshLib/Elements/PyramidRule5.h

@@ -84,7 +84,7 @@ public:
 
 	/**
 	 * Checks if a point is inside the element.
-	 * @param pnt a 3D GeoLib::Point object
+	 * @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
 	 */

MeshLib/Elements/QuadRule4.h

@@ -66,7 +66,7 @@ public:
 
 	/**
 	 * Checks if a point is inside the element.
-	 * @param pnt a 3D GeoLib::Point object
+	 * @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
 	 */

MeshLib/Elements/TemplateElement.h

@@ -109,7 +109,7 @@ public:
 
 	/**
 	 * Checks if a point is inside the element.
-	 * @param pnt a 3D GeoLib::Point object
+	 * @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
 	 */

MeshLib/Elements/TetRule4.h

@@ -79,7 +79,7 @@ public:
 
 	/**
 	 * Checks if a point is inside the element.
-	 * @param pnt a 3D GeoLib::Point object
+	 * @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
 	 */

MeshLib/Elements/TriRule3.h

@@ -67,7 +67,7 @@ public:
 
 	/**
 	 * Checks if a point is inside the element.
-	 * @param pnt a 3D GeoLib::Point object
+	 * @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
 	 */