From 4836cf1053a971fe823ba547a8268431745c5bce Mon Sep 17 00:00:00 2001 From: simonmar Date: Thu, 9 May 2002 13:15:08 +0000 Subject: [PATCH] [project @ 2002-05-09 13:15:07 by simonmar] Various tweaks needed to get the source processed cleanly with Haddock. --- Control/Arrow.hs | 2 ++ Control/Monad/Error.hs | 4 ++-- Control/Monad/Fix.hs | 11 +++++------ Control/Monad/Identity.hs | 10 +++++----- Control/Monad/Monoid.hs | 8 ++++---- Control/Monad/RWS.hs | 11 +++++------ Control/Monad/Reader.hs | 11 +++++------ Control/Monad/State.hs | 11 +++++------ Control/Monad/Trans.hs | 8 ++++---- Control/Monad/Writer.hs | 11 +++++------ Data/Array/IO.hs | 2 +- Data/Array/ST.hs | 2 +- Data/FiniteMap.hs | 2 +- Data/PackedString.hs | 2 +- Debug/QuickCheck.hs | 2 ++ Debug/QuickCheck/Batch.hs | 2 ++ Debug/QuickCheck/Poly.hs | 2 ++ Debug/QuickCheck/Utils.hs | 2 ++ GHC/IOBase.lhs | 15 +++++++++------ System/Console/GetOpt.hs | 2 +- System/Info.hs | 2 +- Text/PrettyPrint/HughesPJ.hs | 6 +++--- 22 files changed, 68 insertions(+), 60 deletions(-) diff --git a/Control/Arrow.hs b/Control/Arrow.hs index 35cc00d..04f31a6 100644 --- a/Control/Arrow.hs +++ b/Control/Arrow.hs @@ -20,6 +20,8 @@ module Control.Arrow where +import Prelude + import Control.Monad import Control.Monad.Fix diff --git a/Control/Monad/Error.hs b/Control/Monad/Error.hs index 6f3967a..6df213e 100644 --- a/Control/Monad/Error.hs +++ b/Control/Monad/Error.hs @@ -10,9 +10,9 @@ -- -- The Error monad. -- --- Rendered by Michael Weber , +-- Rendered by Michael Weber , -- inspired by the Haskell Monad Template Library from --- \A[HREF="http://www.cse.ogi.edu/~andy"]{Andy Gill}} +-- Andy Gill () -- ----------------------------------------------------------------------------- diff --git a/Control/Monad/Fix.hs b/Control/Monad/Fix.hs index 1122588..53d5c42 100644 --- a/Control/Monad/Fix.hs +++ b/Control/Monad/Fix.hs @@ -11,12 +11,11 @@ -- -- The Fix monad. -- --- Inspired by the paper: --- \em{Functional Programming with Overloading and --- Higher-Order Polymorphism}, --- \A[HREF="http://www.cse.ogi.edu/~mpj"]{Mark P Jones}, --- Advanced School of Functional Programming, 1995.} --- +-- Inspired by the paper +-- /Functional Programming with Overloading and +-- Higher-Order Polymorphism/, +-- Mark P Jones () +-- Advanced School of Functional Programming, 1995. ----------------------------------------------------------------------------- module Control.Monad.Fix ( diff --git a/Control/Monad/Identity.hs b/Control/Monad/Identity.hs index e86da0b..282eddb 100644 --- a/Control/Monad/Identity.hs +++ b/Control/Monad/Identity.hs @@ -11,11 +11,11 @@ -- -- The Identity monad. -- --- Inspired by the paper: --- \em{Functional Programming with Overloading and --- Higher-Order Polymorphism}, --- \A[HREF="http://www.cse.ogi.edu/~mpj"]{Mark P Jones}, --- Advanced School of Functional Programming, 1995.} +-- Inspired by the paper +-- /Functional Programming with Overloading and +-- Higher-Order Polymorphism/, +-- Mark P Jones () +-- Advanced School of Functional Programming, 1995. -- ----------------------------------------------------------------------------- diff --git a/Control/Monad/Monoid.hs b/Control/Monad/Monoid.hs index 23b10b3..f892455 100644 --- a/Control/Monad/Monoid.hs +++ b/Control/Monad/Monoid.hs @@ -12,10 +12,10 @@ -- Declaration of the Monoid class,and instances for list and functions -- -- Inspired by the paper --- \em{Functional Programming with Overloading and --- Higher-Order Polymorphism}, --- \A[HREF="http://www.cse.ogi.edu/~mpj"]{Mark P Jones}, --- Advanced School of Functional Programming, 1995.} +-- /Functional Programming with Overloading and +-- Higher-Order Polymorphism/, +-- Mark P Jones () +-- Advanced School of Functional Programming, 1995. ----------------------------------------------------------------------------- module Control.Monad.Monoid ( diff --git a/Control/Monad/RWS.hs b/Control/Monad/RWS.hs index a494ef0..7f7f98b 100644 --- a/Control/Monad/RWS.hs +++ b/Control/Monad/RWS.hs @@ -7,16 +7,15 @@ -- -- Maintainer : libraries@haskell.org -- Stability : experimental --- Portability : non-portable ( requires mulit-parameter type classes, --- requires functional dependencies ) +-- Portability : non-portable ( mulit-param classes, functional dependencies ) -- -- Declaration of the MonadRWS class. -- -- Inspired by the paper --- \em{Functional Programming with Overloading and --- Higher-Order Polymorphism}, --- \A[HREF="http://www.cse.ogi.edu/~mpj"]{Mark P Jones}, --- Advanced School of Functional Programming, 1995.} +-- /Functional Programming with Overloading and +-- Higher-Order Polymorphism/, +-- Mark P Jones () +-- Advanced School of Functional Programming, 1995. ----------------------------------------------------------------------------- module Control.Monad.RWS ( diff --git a/Control/Monad/Reader.hs b/Control/Monad/Reader.hs index 8957404..758a19d 100644 --- a/Control/Monad/Reader.hs +++ b/Control/Monad/Reader.hs @@ -7,16 +7,15 @@ -- -- Maintainer : libraries@haskell.org -- Stability : experimental --- Portability : non-portable ( requires mulit-parameter type classes, --- requires functional dependencies ) +-- Portability : non-portable ( mulit-param classes, functional dependencies ) -- -- Declaration of the Monoid class,and instances for list and functions -- -- Inspired by the paper --- \em{Functional Programming with Overloading and --- Higher-Order Polymorphism}, --- \A[HREF="http://www.cse.ogi.edu/~mpj"]{Mark P Jones}, --- Advanced School of Functional Programming, 1995.} +-- /Functional Programming with Overloading and +-- Higher-Order Polymorphism/, +-- Mark P Jones () +-- Advanced School of Functional Programming, 1995. ----------------------------------------------------------------------------- module Control.Monad.Reader ( diff --git a/Control/Monad/State.hs b/Control/Monad/State.hs index 878b83f..2353d76 100644 --- a/Control/Monad/State.hs +++ b/Control/Monad/State.hs @@ -7,16 +7,15 @@ -- -- Maintainer : libraries@haskell.org -- Stability : experimental --- Portability : non-portable ( requires mulit-parameter type classes, --- requires functional dependencies ) +-- Portability : non-portable ( mulit-param classes, functional dependencies ) -- -- State monads. -- -- Inspired by the paper --- \em{Functional Programming with Overloading and --- Higher-Order Polymorphism}, --- \A[HREF="http://www.cse.ogi.edu/~mpj"]{Mark P Jones}, --- Advanced School of Functional Programming, 1995.} +-- /Functional Programming with Overloading and +-- Higher-Order Polymorphism/, +-- Mark P Jones () +-- Advanced School of Functional Programming, 1995. ----------------------------------------------------------------------------- module Control.Monad.State ( diff --git a/Control/Monad/Trans.hs b/Control/Monad/Trans.hs index 81ff397..929b242 100644 --- a/Control/Monad/Trans.hs +++ b/Control/Monad/Trans.hs @@ -12,10 +12,10 @@ -- The MonadTrans class. -- -- Inspired by the paper --- \em{Functional Programming with Overloading and --- Higher-Order Polymorphism}, --- \A[HREF="http://www.cse.ogi.edu/~mpj"]{Mark P Jones}, --- Advanced School of Functional Programming, 1995.} +-- /Functional Programming with Overloading and +-- Higher-Order Polymorphism/, +-- Mark P Jones () +-- Advanced School of Functional Programming, 1995. ----------------------------------------------------------------------------- module Control.Monad.Trans ( diff --git a/Control/Monad/Writer.hs b/Control/Monad/Writer.hs index e79abb9..af7add6 100644 --- a/Control/Monad/Writer.hs +++ b/Control/Monad/Writer.hs @@ -7,16 +7,15 @@ -- -- Maintainer : libraries@haskell.org -- Stability : experimental --- Portability : non-portable ( requires mulit-parameter type classes, --- requires functional dependencies ) +-- Portability : non-portable ( mulit-param classes, functional dependencies ) -- -- The MonadWriter class. -- -- Inspired by the paper --- \em{Functional Programming with Overloading and --- Higher-Order Polymorphism}, --- \A[HREF="http://www.cse.ogi.edu/~mpj"]{Mark P Jones}, --- Advanced School of Functional Programming, 1995.} +-- /Functional Programming with Overloading and +-- Higher-Order Polymorphism/, +-- Mark P Jones () +-- Advanced School of Functional Programming, 1995. ----------------------------------------------------------------------------- module Control.Monad.Writer ( diff --git a/Data/Array/IO.hs b/Data/Array/IO.hs index b47e147..5c6e361 100644 --- a/Data/Array/IO.hs +++ b/Data/Array/IO.hs @@ -9,7 +9,7 @@ -- Stability : experimental -- Portability : non-portable -- --- Mutable boxed/unboxed arrays in the IO monad. +-- Mutable boxed and unboxed arrays in the IO monad. -- ----------------------------------------------------------------------------- diff --git a/Data/Array/ST.hs b/Data/Array/ST.hs index d8c3028..e71dece 100644 --- a/Data/Array/ST.hs +++ b/Data/Array/ST.hs @@ -8,7 +8,7 @@ -- Stability : experimental -- Portability : non-portable -- --- Mutable boxed/unboxed arrays in the ST monad. +-- Mutable boxed and unboxed arrays in the ST monad. -- ----------------------------------------------------------------------------- diff --git a/Data/FiniteMap.hs b/Data/FiniteMap.hs index a44bb36..88279bd 100644 --- a/Data/FiniteMap.hs +++ b/Data/FiniteMap.hs @@ -201,7 +201,7 @@ emptyFM bottom = panic "emptyFM" -} --- #define EmptyFM (Branch _ _ IF_GHC(0#,0) _ _) +-- #define EmptyFM (Branch _ _ IF_GHC(0#,0) _ _) unitFM key elt = Branch key elt IF_GHC(1#,1) emptyFM emptyFM diff --git a/Data/PackedString.hs b/Data/PackedString.hs index cc5240e..fd4528b 100644 --- a/Data/PackedString.hs +++ b/Data/PackedString.hs @@ -10,7 +10,7 @@ -- -- The PackedString type, and associated operations. -- --- Original GHC implementation by Bryan O'Sullivan, +-- Original GHC implementation by Bryan O\'Sullivan, -- rewritten to use UArray by Simon Marlow. -- ----------------------------------------------------------------------------- diff --git a/Debug/QuickCheck.hs b/Debug/QuickCheck.hs index 7bf87f2..99af89b 100644 --- a/Debug/QuickCheck.hs +++ b/Debug/QuickCheck.hs @@ -67,6 +67,8 @@ module Debug.QuickCheck ) where +import Prelude + import System.Random import Data.List( group, sort, intersperse ) import Control.Monad( liftM2, liftM3, liftM4 ) diff --git a/Debug/QuickCheck/Batch.hs b/Debug/QuickCheck/Batch.hs index 66b0109..1b5cafa 100644 --- a/Debug/QuickCheck/Batch.hs +++ b/Debug/QuickCheck/Batch.hs @@ -88,6 +88,8 @@ module Debug.QuickCheck.Batch , bottom -- :: a {- _|_ -} ) where +import Prelude + import System.Random import Control.Concurrent import Control.Exception hiding (catch, evaluate) diff --git a/Debug/QuickCheck/Poly.hs b/Debug/QuickCheck/Poly.hs index 82bda15..f254432 100644 --- a/Debug/QuickCheck/Poly.hs +++ b/Debug/QuickCheck/Poly.hs @@ -26,6 +26,8 @@ module Debug.QuickCheck.Poly , OrdGAMMA ) where +import Prelude + import Debug.QuickCheck import Debug.QuickCheck.Utils diff --git a/Debug/QuickCheck/Utils.hs b/Debug/QuickCheck/Utils.hs index 4705615..8d22c27 100644 --- a/Debug/QuickCheck/Utils.hs +++ b/Debug/QuickCheck/Utils.hs @@ -20,6 +20,8 @@ module Debug.QuickCheck.Utils , isTotalOrder ) where +import Prelude + import Debug.QuickCheck isAssociativeBy :: (Show a,Testable prop) diff --git a/GHC/IOBase.lhs b/GHC/IOBase.lhs index 9c2c034..3e6462a 100644 --- a/GHC/IOBase.lhs +++ b/GHC/IOBase.lhs @@ -24,7 +24,10 @@ import Data.Maybe ( Maybe(..) ) import GHC.Show import GHC.List import GHC.Read + +#ifndef __HADDOCK__ import {-# SOURCE #-} Data.Dynamic +#endif -- --------------------------------------------------------------------------- -- The IO Monad @@ -270,22 +273,22 @@ type FilePath = String -- effects. For output, items are written out from the internal -- buffer according to the buffer mode: -- --- * line-buffering the entire output buffer is written +-- o line-buffering the entire output buffer is written -- out whenever a newline is output, the output buffer overflows, -- a flush is issued, or the handle is closed. -- --- * block-buffering the entire output buffer is written out whenever +-- o block-buffering the entire output buffer is written out whenever -- it overflows, a flush is issued, or the handle -- is closed. -- --- * no-buffering output is written immediately, and never stored +-- o no-buffering output is written immediately, and never stored -- in the output buffer. -- -- The output buffer is emptied as soon as it has been written out. -- Similarly, input occurs according to the buffer mode for handle {\em hdl}. --- * line-buffering when the input buffer for the handle is not empty, +-- o line-buffering when the input buffer for the handle is not empty, -- the next item is obtained from the buffer; -- otherwise, when the input buffer is empty, -- characters up to and including the next newline @@ -293,10 +296,10 @@ type FilePath = String -- are available until the newline character is -- available. -- --- * block-buffering when the input buffer for the handle becomes empty, +-- o block-buffering when the input buffer for the handle becomes empty, -- the next block of data is read into this buffer. -- --- * no-buffering the next input item is read and returned. +-- o no-buffering the next input item is read and returned. -- For most implementations, physical files will normally be block-buffered -- and terminals will normally be line-buffered. (the IO interface provides diff --git a/System/Console/GetOpt.hs b/System/Console/GetOpt.hs index ca32286..72ffea2 100644 --- a/System/Console/GetOpt.hs +++ b/System/Console/GetOpt.hs @@ -8,7 +8,7 @@ -- Stability : experimental -- Portability : portable -- --- A Haskell port of GNU's getopt library +-- A Haskell port of the GNU getopt library -- ----------------------------------------------------------------------------- diff --git a/System/Info.hs b/System/Info.hs index fce5b43..a064991 100644 --- a/System/Info.hs +++ b/System/Info.hs @@ -9,7 +9,7 @@ -- Portability : portable -- -- Misc information about the characteristics of the host --- architecture/machine lucky enough to run your program. +-- architecture\/machine lucky enough to run your program. -- ----------------------------------------------------------------------------- diff --git a/Text/PrettyPrint/HughesPJ.hs b/Text/PrettyPrint/HughesPJ.hs index 0bcfbbb..5ad32c0 100644 --- a/Text/PrettyPrint/HughesPJ.hs +++ b/Text/PrettyPrint/HughesPJ.hs @@ -8,12 +8,12 @@ -- Stability : provisional -- Portability : portable -- --- John Hughes's and Simon Peyton Jones's Pretty Printer Combinators +-- John Hughes\'s and Simon Peyton Jones\'s Pretty Printer Combinators -- --- Based on "The Design of a Pretty-printing Library" +-- Based on /The Design of a Pretty-printing Library/ -- in Advanced Functional Programming, -- Johan Jeuring and Erik Meijer (eds), LNCS 925 --- http://www.cs.chalmers.se/~rjmh/Papers/pretty.ps +-- -- -- Heavily modified by Simon Peyton Jones, Dec 96 -- -- 1.7.10.4