Add a bunch of documentation.

[spline3.git] / src / Point.hs

diff --git a/src/Point.hs b/src/Point.hs
index 5d7954c810634f64fa65599afd352502fce40eca..94bcd70f6e8c586f28a70e655c6bbd227ba1c801 100644 (file)
--- a/src/Point.hs
+++ b/src/Point.hs
@@ -50,10 +50,12 @@ instance Num Point where
     fromInteger n = (fromInteger n, fromInteger n, fromInteger n)
 
 
+-- | Scale a point by a constant.
 scale :: Point -> Double -> Point
 scale (x, y, z) d = (x*d, y*d, z*d)
 
 
+-- | Returns the distance between p1 and p2.
 distance :: Point -> Point -> Double
 distance p1 p2 =
     sqrt $ (x2 - x1)^(2::Int) + (y2 - y1)^(2::Int) + (z2 - z1)^(2::Int)
@@ -66,5 +68,6 @@ distance p1 p2 =
       z2 = z_coord p2
 
 
+-- | Returns 'True' if p1 'is_close' to p2, 'False' otherwise.
 is_close :: Point -> Point -> Bool
 is_close p1 p2 = (distance p1 p2) ~= 0