From: Michael Orlitzky <michael@orlitzky.com>
Date: Sat, 30 Apr 2011 19:35:03 +0000 (-0400)
Subject: Fix the naming of the faces and convert their comments to haddock form.
X-Git-Tag: 0.0.1~359
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=cb12813c94e3ddb73e84d2b1e77667fe3ca016a5;p=spline3.git

Fix the naming of the faces and convert their comments to haddock form.
---

diff --git a/src/Face.hs b/src/Face.hs
index d93ebff..6f7e99b 100644
--- a/src/Face.hs
+++ b/src/Face.hs
@@ -29,7 +29,7 @@ instance ThreeDimensional Face where
     -- Too lazy to implement this right now.
     contains_point _ _ = False
 
--- The top face of the cube.
+-- | The top (in the direction of z) face of the cube.
 face0 :: Cube -> Face
 face0 c = Face c v0' v1' v2' v3'
     where
@@ -40,7 +40,7 @@ face0 c = Face c v0' v1' v2' v3'
       v2' = (center c) + (delta, -delta, delta)
       v3' = (center c) + (-delta, -delta, delta)
 
--- The right face of the cube.
+-- | The back (in the direction of x) face of the cube.
 face1 :: Cube -> Face
 face1 c = Face c v0' v1' v2' v3'
     where
@@ -52,7 +52,7 @@ face1 c = Face c v0' v1' v2' v3'
       v3' = (center c) + (delta, -delta, delta)
 
 
--- The bottom face of the cube.
+-- The bottom face (in the direction of -z) of the cube.
 face2 :: Cube -> Face
 face2 c = Face c v0' v1' v2' v3'
     where
@@ -64,7 +64,7 @@ face2 c = Face c v0' v1' v2' v3'
       v3' = (center c) + (delta, -delta, -delta)
 
 
--- The left face of the cube.
+-- | The front (in the direction of -x) face of the cube.
 face3 :: Cube -> Face
 face3 c = Face c v0' v1' v2' v3'
     where
@@ -76,7 +76,7 @@ face3 c = Face c v0' v1' v2' v3'
       v3' = (center c) + (-delta, -delta, -delta)
 
 
--- The front face of the cube.
+-- | The left (in the direction of -y) face of the cube.
 face4 :: Cube -> Face
 face4 c = Face c v0' v1' v2' v3'
     where
@@ -88,7 +88,7 @@ face4 c = Face c v0' v1' v2' v3'
       v3' = (center c) + (-delta, -delta, -delta)
 
 
--- The back face of the cube.
+-- | The right (in the direction of y) face of the cube.
 face5 :: Cube -> Face
 face5 c = Face c v0' v1' v2' v3'
     where