From 4288b2b8dd44b8f1e57013a0385a609f41184d27 Mon Sep 17 00:00:00 2001
From: vbd <vbd>
Date: Mon, 10 Sep 2007 11:57:47 +0000
Subject: [PATCH] staffan : 	* doc updates

---
 src/INTERP_KERNEL/TransformedTriangle.hxx           | 5 ++++-
 src/INTERP_KERNEL/TransformedTriangle_inline.hxx    | 6 ++++++
 src/INTERP_KERNEL/TransformedTriangle_intersect.cxx | 4 ++--
 src/INTERP_KERNEL/TransformedTriangle_math.cxx      | 4 ++--
 4 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/src/INTERP_KERNEL/TransformedTriangle.hxx b/src/INTERP_KERNEL/TransformedTriangle.hxx
index a313814c2..b4d022ea0 100644
--- a/src/INTERP_KERNEL/TransformedTriangle.hxx
+++ b/src/INTERP_KERNEL/TransformedTriangle.hxx
@@ -35,7 +35,8 @@ namespace INTERP_UTILS
    *             Journal of Computational Physics (1999)
    */
 
-  /* ! READ ME FIRST !
+  /** \file TransformedTriangle.hxx
+   * ! READ ME FIRST !
    * OVERVIEW of how the class works : (details can be found in the commentaries above each method)
    * 
    * Constructor : 
@@ -83,6 +84,7 @@ namespace INTERP_UTILS
      * and the triangle. The end element, NO_* gives the number of elements in the enumeration
      * and can be used as end element in loops.
      */
+
     /// Corners of tetrahedron
     enum TetraCorner { O = 0, X, Y, Z, NO_TET_CORNER };
 
@@ -102,6 +104,7 @@ namespace INTERP_UTILS
     enum IntersectionPolygon{ A = 0, B, NO_INTERSECTION_POLYGONS };
 
     /// Double products
+    /// 
     /// NB : order corresponds to TetraEdges (Grandy, table III)
     enum DoubleProduct { C_YZ = 0, C_ZX, C_XY, C_ZH, C_XH, C_YH, C_01, C_10, NO_DP };
 
diff --git a/src/INTERP_KERNEL/TransformedTriangle_inline.hxx b/src/INTERP_KERNEL/TransformedTriangle_inline.hxx
index 63c37d026..d3f2d80ab 100644
--- a/src/INTERP_KERNEL/TransformedTriangle_inline.hxx
+++ b/src/INTERP_KERNEL/TransformedTriangle_inline.hxx
@@ -8,6 +8,12 @@
 ////////////////////////////////////////////////////////////////////////////////////////
 /// Optimization methods. These are only defined and used if OPTIMIZE is defined.
 ////////////////////////////////////////////////////////////////////////////////////////
+/**
+ * Calls TransformedTriangle::testTriangleSurroundsEdge for edges OX to ZX and stores the result in
+ * member variable array_triangleSurroundsEdgeCache. 
+ *
+ */
+
 inline void TransformedTriangle::preCalculateTriangleSurroundsEdge() 
 {
   for(TetraEdge edge = OX ; edge <= ZX ; edge = TetraEdge(edge + 1))
diff --git a/src/INTERP_KERNEL/TransformedTriangle_intersect.cxx b/src/INTERP_KERNEL/TransformedTriangle_intersect.cxx
index 5ab7a5f81..2605bb3c5 100644
--- a/src/INTERP_KERNEL/TransformedTriangle_intersect.cxx
+++ b/src/INTERP_KERNEL/TransformedTriangle_intersect.cxx
@@ -673,7 +673,7 @@ namespace INTERP_UTILS
     return true;
   }
 
-  /*
+  /**
    * Tests if the given corner of the triangle lies above the XYZ-facet of the tetrahedron.
    *
    * @param  corner corner of the triangle
@@ -811,7 +811,7 @@ namespace INTERP_UTILS
 #endif
 
 #ifndef OPTIMIZE // inlined otherwise -> see TransformedTriangle_inline.hxx
-  /*
+  /**
    * Tests if the H-coordinates (1 - x - y) for the two end of a segment of the triangle
    * lie on different sides of the H = 0 plane.
    *
diff --git a/src/INTERP_KERNEL/TransformedTriangle_math.cxx b/src/INTERP_KERNEL/TransformedTriangle_math.cxx
index 3ef665293..6ed3a7477 100644
--- a/src/INTERP_KERNEL/TransformedTriangle_math.cxx
+++ b/src/INTERP_KERNEL/TransformedTriangle_math.cxx
@@ -150,7 +150,7 @@ namespace INTERP_UTILS
     _isDoubleProductsCalculated = true;
   }
 
-  /*
+  /**
    * Checks if the double products for a given segment are consistent, as defined by
    * Grandy, [46]
    *
@@ -206,7 +206,7 @@ namespace INTERP_UTILS
   }
 #endif OPTIMIZE
 
-  /*
+  /**
    * Calculate the shortest distance between a tetrahedron corner and a triangle segment.
    * 
    * @param  corner corner of the tetrahedron
-- 
2.39.2