[project @ 2002-08-25 09:16:07 by panne]

[ghc-base.git] / GHC / Err.lhs

diff --git a/GHC/Err.lhs b/GHC/Err.lhs
index fb34ab5..43834aa 100644 (file)
--- a/GHC/Err.lhs
+++ b/GHC/Err.lhs
@@ -1,20 +1,24 @@
-% -----------------------------------------------------------------------------
-% $Id: Err.lhs,v 1.4 2002/04/11 12:03:43 simonpj Exp $
-%
-% (c) The University of Glasgow, 1994-2000
-%
-
-\section[GHC.Err]{Module @GHC.Err@}
-
-The GHC.Err module defines the code for the wired-in error functions,
-which have a special type in the compiler (with "open tyvars").
-
-We cannot define these functions in a module where they might be used
-(e.g., GHC.Base), because the magical wired-in type will get confused
-with what the typechecker figures out.
-
 \begin{code}
 {-# OPTIONS -fno-implicit-prelude #-}
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  GHC.Err
+-- Copyright   :  (c) The University of Glasgow, 1994-2002
+-- License     :  see libraries/base/LICENSE
+-- 
+-- Maintainer  :  cvs-ghc@haskell.org
+-- Stability   :  internal
+-- Portability :  non-portable (GHC extensions)
+--
+-- The "GHC.Err" module defines the code for the wired-in error functions,
+-- which have a special type in the compiler (with \"open tyvars\").
+-- 
+-- We cannot define these functions in a module where they might be used
+-- (e.g., "GHC.Base"), because the magical wired-in type will get confused
+-- with what the typechecker figures out.
+-- 
+-----------------------------------------------------------------------------
+
 module GHC.Err 
        (
          irrefutPatError
@@ -25,8 +29,7 @@ module GHC.Err
        , recConError
        , runtimeError              -- :: Addr#  -> a   -- Addr# points to UTF8 encoded C string
 
-       , absentErr, parError       -- :: a
-       , seqError                  -- :: a
+       , absentErr                -- :: a
 
        , error                    -- :: String -> a
        , assertError              -- :: String -> Bool -> a -> a
@@ -34,9 +37,11 @@ module GHC.Err
        , undefined                -- :: a
        ) where
 
+#ifndef __HADDOCK__
 import GHC.Base
 import GHC.List     ( span )
 import GHC.Exception
+#endif
 \end{code}
 
 %*********************************************************
@@ -68,11 +73,9 @@ Used for compiler-generated error message;
 encoding saves bytes of string junk.
 
 \begin{code}
-absentErr, parError, seqError :: a
+absentErr :: a
 
 absentErr = error "Oops! The program has entered an `absent' argument!\n"
-parError  = error "Oops! Entered GHCerr.parError (a GHC bug -- please report it!)\n"
-seqError  = error "Oops! Entered seqError (a GHC bug -- please report it!)\n"
 \end{code}
 
 \begin{code}