[Improved Haddock aspects of documentation.
Nils Anders Danielsson <nad@cs.chalmers.se>**20050522193935
 Most notable changes:
 * Now --read-interface is used.
 * Files are preprocessed using cpphs before Haddock is run.
] {
hunk ./Makefile 3
+########################################################################
+# You may need to edit the following variables:
+
+# URL prefix leading to Haddock documentation for the hierarchical
+# libraries.
+GHC_DOC_URL ?= http://www.haskell.org/ghc/docs/latest/html/libraries
+# Path prefix leading to Haddock interface files for the hierarchical
+# libraries.
+GHC_DOC_PATH ?= /usr/local/share/ghc-6.4/html/libraries
+# Store documentation in this directory, after removing it.
+DOCDIR = docs
+
+########################################################################
+
hunk ./Makefile 22
-docs : $(addprefix Test/,$(EXPOSED_SOURCES))
-	-rm -rf docs
-	mkdir -p docs
+# CPP is used for conditional compilation. Different code is selected
+# dependent on the version of GHC used. That does not affect the
+# comments, though, so we can just run cpphs without bothering about
+# GHC versions.
+%.hs.processed : %.hs
+	cpphs --noline $^ -O$@
+
+$(DOCDIR) : $(addprefix Test/,$(EXPOSED_SOURCES:=.processed)) Header
+	-rm -rf $(DOCDIR)
+	mkdir -p $(DOCDIR)
hunk ./Makefile 33
-	  $^
+	  -i$(GHC_DOC_URL)/base,$(GHC_DOC_PATH)/base/base.haddock \
+	  -i$(GHC_DOC_URL)/QuickCheck,$(GHC_DOC_PATH)/QuickCheck/QuickCheck.haddock \
+	  $(filter Test/%,$^)
hunk ./Test/ChasingBottoms/Approx.hs 28
-to the limitations of the Data.Generics approach to generic
+to the limitations of the "Data.Generics" approach to generic
hunk ./Test/ChasingBottoms/IsBottom.hs 27
--- The exceptions that yield 'True' are those that correspond to \"pure
--- bottoms\", i.e. bottoms that can originate in pure code. Assertions
--- are excluded, since their behaviour depends on compiler flags (not
--- pure, and a failed assertion should really yield an exception and
--- nothing else). The same applies to arithmetic exceptions (machine
--- dependent, except possibly for 'DivideByZero', but the value
--- infinity makes that case unclear as well).
+-- The exceptions that yield 'True' are those that correspond to
+-- \"pure bottoms\", i.e. bottoms that can originate in pure code.
+-- Assertions are excluded, since their behaviour depends on compiler
+-- flags (not pure, and a failed assertion should really yield an
+-- exception and nothing else). The same applies to arithmetic
+-- exceptions (machine dependent, except possibly for
+-- 'Control.Exception.DivideByZero', but the value infinity makes that
+-- case unclear as well).
hunk ./Test/ChasingBottoms/IsBottom.hs 55
--- | 'isBottomTimeOut' works like 'isBottom', but if '?timeOutLimit'
--- is 'Just lim', then computations taking more than 'lim' seconds are
+-- | 'isBottomTimeOut' works like 'isBottom', but if @?timeOutLimit@
+-- is @'Just' lim@, then computations taking more than @lim@ seconds are
hunk ./Test/ChasingBottoms/Nat.hs 47
+--
hunk ./Test/ChasingBottoms/Nat.hs 49
---  foldN g h = natrec g (curry $ h . snd)
+--  'foldN' g h = 'natrec' g ('curry' '$' h . 'snd')
hunk ./Test/ChasingBottoms/SemanticOrd.hs 24
--- [@'?approxDepth'@] If equal to @'Just' n@, an @'approxAll' n@ is
+-- [@?approxDepth@] If equal to @'Just' n@, an @'approxAll' n@ is
hunk ./Test/ChasingBottoms/SemanticOrd.hs 28
--- [@'?timeOutLimit'@] If equal to @'Just' n@, then all computations
+-- [@?timeOutLimit@] If equal to @'Just' n@, then all computations
hunk ./Test/ChasingBottoms/TimeOut.hs 91
---   'timeOut'' n = 'timeOut' n . Control.Exception.evaluate
+--   'timeOut'' n = 'timeOut' n . 'E.evaluate'
hunk ./Test/ChasingBottoms/TimeOut.hs 94
--- ensures that @'timeOut'' 1 bottom@ usually returns @'Exception'
--- <something>@.  (@'timeOut' 1 (return bottom)@ usually returns
--- @'Value' 'bottom'@; in other words, the computation reaches whnf
--- almost immediately, defeating the purpose of the time-out.)
+-- ensures that @'timeOut'' 1 'Test.ChasingBottoms.IsBottom.bottom'@
+-- usually returns @'Exception' \<something\>@. (@'timeOut' 1 ('return'
+-- 'Test.ChasingBottoms.IsBottom.bottom')@ usually returns @'Value'
+-- 'Test.ChasingBottoms.IsBottom.bottom'@; in other words, the
+-- computation reaches whnf almost immediately, defeating the purpose
+-- of the time-out.)
hunk ./Test/ChasingBottoms/TimeOut.hs 107
---  'timeOutMicro'' n = 'timeOutMicro' n . Control.Exception.evaluate
+--  'timeOutMicro'' n = 'timeOutMicro' n . 'E.evaluate'
}