From: Michael Orlitzky <michael@orlitzky.com>
Date: Tue, 11 Oct 2011 16:11:36 +0000 (-0400)
Subject: Update some documentation.
X-Git-Tag: 0.0.1~98
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=bebe7214d77fd80ae2d0cc376846165e06eace93;p=spline3.git

Update some documentation.
---

diff --git a/doc/README b/doc/README
index 053df22..c62e617 100644
--- a/doc/README
+++ b/doc/README
@@ -26,6 +26,9 @@ install them.
   * Test Framework QuickCheck 2
       http://hackage.haskell.org/package/test-framework-quickcheck2
 
+  * Vector
+      http://hackage.haskell.org/package/vector
+
   * HsColour
       http://www.cs.york.ac.uk/fp/darcs/hscolour/
 
diff --git a/makefile b/makefile
index 2110611..fdac2f8 100644
--- a/makefile
+++ b/makefile
@@ -32,12 +32,7 @@ $(BIN): src/*.hs
 	ghc -optc-O3 -optc-march=native $(GHC_OPTS) src/*.hs
 
 llvm: src/*.hs
-	ghc -fllvm $(GHC_OPTS) src/*.hs
-
-all: $(BIN) test_src
-
-test_src: src/Tests/*.hs
-	ghc $(GHC_OPTS) src/*.hs src/Tests/*.hs
+	ghc -fllvm -optlo-O3 -optlc-O3 $(GHC_OPTS) src/*.hs
 
 profile: src/*.hs
 	ghc  -optc-O3 -optc-march=native $(GHC_OPTS) -prof -auto-all -caf-all src/*.hs
@@ -63,10 +58,11 @@ src_html:
 DOCS := -i /usr/share/doc/ghc-*/html/libraries/base-*/base.haddock
 DOCS += -i /usr/share/doc/ghc-*/html/libraries/ghc-prim-*/ghc-prim.haddock
 DOCS += -i /usr/share/doc/ghc-*/html/libraries/haskell98-*/haskell98.haddock
-DOCS += -i /usr/share/doc/storable-complex-*/html/storable-complex.haddock
 DOCS += -i /usr/share/doc/quickcheck-*/html/QuickCheck.haddock
-DOCS += -i /usr/share/doc/hmatrix-*/html/hmatrix.haddock
 DOCS += -i /usr/share/doc/hunit-*/html/HUnit.haddock
+DOCS += -i /usr/share/doc/test-framework-*/html/test-framework.haddock
+DOCS += -i /usr/share/doc/repa-*/html/repa.haddock
+DOCS += -i /usr/share/doc/vector-*/html/vector.haddock
 
 
 HTMLS := /usr/share/doc/ghc-*/html/libraries/base-*/*.html
@@ -74,13 +70,16 @@ HTMLS += /usr/share/doc/ghc-*/html/libraries/ghc-prim-*/*.html
 HTMLS += /usr/share/doc/ghc-*/html/libraries/haskell98-*/*.html
 HTMLS += /usr/share/doc/quickcheck-*/html/*.html
 HTMLS += /usr/share/doc/hunit-*/html/*.html
-HTMLS += /usr/share/doc/storable-complex-*/html/*.html
-HTMLS += /usr/share/doc/hmatrix-*/html/*.html
+HTMLS += /usr/share/doc/test-framework-*/html/*.html
+HTMLS += /usr/share/doc/vector-*/html/*.html
+HTMLS += /usr/share/doc/repa-*/html/*.html
 
 HSCOLOUR_SRCS := /usr/share/doc/ghc-*/html/libraries/base-*/src/*
 HSCOLOUR_SRCS += /usr/share/doc/ghc-*/html/libraries/ghc-prim-*/src/*
 HSCOLOUR_SRCS += /usr/share/doc/ghc-*/html/libraries/haskell98-*/src/*
-HSCOLOUR_SRCS += /usr/share/doc/hmatrix-*/html/src/*
+HSCOLOUR_SRCS += /usr/share/doc/test-framework-*/html/src/*
+HSCOLOUR_SRCS += /usr/share/doc/vector-*/html/src/*
+HSCOLOUR_SRCS += /usr/share/doc/repa-*/html/src/*.html
 
 doc: src_html
 	cp -n $(HTMLS) ./doc/html/
@@ -89,7 +88,7 @@ doc: src_html
 	  --odir=doc/html/ --title="spline3"               \
 	  --source-module="src/%{MODULE/.//}.html"         \
 	  --source-entity="src/%{MODULE/.//}.html#%{NAME}" \
-	  src/*.hs src/Tests/*.hs
+	  src/*.hs
 
 SSH_USER=root@michael.orlitzky.com
 PUBLIC_DOCDIR=/var/www/orlitzky.com/michael/public/spline3/
diff --git a/src/MRI.hs b/src/MRI.hs
index cb89af9..c142dcd 100644
--- a/src/MRI.hs
+++ b/src/MRI.hs
@@ -1,3 +1,8 @@
+-- | The MRI module contains functionsd and definitions relevant (and
+--   specific) to the MRI data files found at,
+--
+--   <http://graphics.stanford.edu/data/voldata/>
+--
 module MRI (
   flip_x,
   flip_y,
@@ -42,7 +47,11 @@ mri_upper_threshold = 2500
 mri_slice3d :: DIM3
 mri_slice3d = (Z :. 1 :. mri_height  :. mri_width)
 
+-- | RawData is an array of words (16 bits), as contained in the MRI
+--   data files.
 type RawData sh = Array sh Word16
+
+-- | A specialization of the 'RawData' type, to three dimensions.
 type RawData3D = RawData DIM3
 
 type RGB = (Word8, Word8, Word8)
diff --git a/util/hscolour_srcs b/util/hscolour_srcs
index d5c015c..ff14ef0 100755
--- a/util/hscolour_srcs
+++ b/util/hscolour_srcs
@@ -11,9 +11,6 @@
 # coincide with the ones passed to 'haddock' in the makefile.
 SRCS=`find ./src -iname '*.hs'`
 
-# We have to create the output directories before we start.
-mkdir -p doc/html/src/Tests
-
 for file in $SRCS; do
     DIRNAME=`dirname $file`
     BASENAME=`basename $file .hs`