From: Ross Paterson Date: Mon, 6 Nov 2006 12:41:40 +0000 (+0000) Subject: fix Haddock module headers X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=955f4d7da12268e4d807d2ac3427774308d9ae56;p=haskell-directory.git fix Haddock module headers --- diff --git a/Data/ByteString.hs b/Data/ByteString.hs index 093e81b..8e9e919 100644 --- a/Data/ByteString.hs +++ b/Data/ByteString.hs @@ -1,13 +1,12 @@ {-# OPTIONS_GHC -cpp -fglasgow-exts -fno-warn-orphans #-} --- --- Module : ByteString +-- | +-- Module : Data.ByteString -- Copyright : (c) The University of Glasgow 2001, -- (c) David Roundy 2003-2005, -- (c) Simon Marlow 2005 -- (c) Don Stewart 2005-2006 -- (c) Bjorn Bringert 2006 --- --- Array fusion code: +-- Array fusion code: -- (c) 2001,2002 Manuel M T Chakravarty & Gabriele Keller -- (c) 2006 Manuel M T Chakravarty & Roman Leshchinskiy -- @@ -15,12 +14,9 @@ -- -- Maintainer : dons@cse.unsw.edu.au -- Stability : experimental --- Portability : portable, requires ffi and cpp --- Tested with : GHC 6.4.1 and Hugs March 2005 +-- Portability : portable -- - --- --- | A time and space-efficient implementation of byte vectors using +-- A time and space-efficient implementation of byte vectors using -- packed Word8 arrays, suitable for high performance use, both in terms -- of large data quantities, or high speed requirements. Byte vectors -- are encoded as strict 'Word8' arrays of bytes, held in a 'ForeignPtr', @@ -31,9 +27,10 @@ -- -- > import qualified Data.ByteString as B -- --- Original GHC implementation by Bryan O\'Sullivan. Rewritten to use --- UArray by Simon Marlow. Rewritten to support slices and use --- ForeignPtr by David Roundy. Polished and extended by Don Stewart. +-- Original GHC implementation by Bryan O\'Sullivan. +-- Rewritten to use 'Data.Array.Unboxed.UArray' by Simon Marlow. +-- Rewritten to support slices and use 'ForeignPtr' by David Roundy. +-- Polished and extended by Don Stewart. -- module Data.ByteString ( diff --git a/Data/ByteString/Base.hs b/Data/ByteString/Base.hs index b96a56b..d80a118 100644 --- a/Data/ByteString/Base.hs +++ b/Data/ByteString/Base.hs @@ -1,16 +1,14 @@ {-# OPTIONS_GHC -cpp -fglasgow-exts #-} --- --- Module : ByteString.Base +-- | +-- Module : Data.ByteString.Base -- License : BSD-style -- Maintainer : dons@cse.unsw.edu.au -- Stability : experimental --- Portability : portable, requires ffi and cpp --- Tested with : GHC 6.4.1 and Hugs March 2005 +-- Portability : portable -- - --- | A module containing semi-public ByteString internals. This exposes --- the ByteString representation and low level construction functions. --- Modules which extend the ByteString system will need to use this module +-- A module containing semi-public 'ByteString' internals. This exposes +-- the 'ByteString' representation and low level construction functions. +-- Modules which extend the 'ByteString' system will need to use this module -- while ideally most users will be able to make do with the public interface -- modules. -- diff --git a/Data/ByteString/Char8.hs b/Data/ByteString/Char8.hs index bbbf521..460f18b 100644 --- a/Data/ByteString/Char8.hs +++ b/Data/ByteString/Char8.hs @@ -1,16 +1,14 @@ {-# OPTIONS_GHC -cpp -fglasgow-exts #-} --- +-- | -- Module : Data.ByteString.Char8 -- Copyright : (c) Don Stewart 2006 -- License : BSD-style -- -- Maintainer : dons@cse.unsw.edu.au -- Stability : experimental --- Portability : portable (tested with GHC>=6.4.1 and Hugs 2005) --- - +-- Portability : portable -- --- | Manipulate 'ByteString's using 'Char' operations. All Chars will be +-- Manipulate 'ByteString's using 'Char' operations. All Chars will be -- truncated to 8 bits. It can be expected that these functions will run -- at identical speeds to their 'Word8' equivalents in "Data.ByteString". -- diff --git a/Data/ByteString/Fusion.hs b/Data/ByteString/Fusion.hs index d6c91ac..7862c91 100644 --- a/Data/ByteString/Fusion.hs +++ b/Data/ByteString/Fusion.hs @@ -1,20 +1,18 @@ {-# OPTIONS_GHC -cpp -fglasgow-exts -fno-warn-orphans #-} --- +-- | -- Module : Data.ByteString.Fusion -- License : BSD-style -- Maintainer : dons@cse.unsw.edu.au -- Stability : experimental --- Portability : portable, requires ffi and cpp --- Tested with : GHC 6.4.1 and Hugs March 2005 --- - --- #hide - --- | Functional array fusion for ByteStrings. +-- Portability : portable +-- +-- Functional array fusion for ByteStrings. -- -- Originally based on code from the Data Parallel Haskell project, -- -- + +-- #hide module Data.ByteString.Fusion ( -- * Fusion utilities diff --git a/Data/ByteString/Lazy.hs b/Data/ByteString/Lazy.hs index fff9bab..6c45784 100644 --- a/Data/ByteString/Lazy.hs +++ b/Data/ByteString/Lazy.hs @@ -1,18 +1,15 @@ {-# OPTIONS_GHC -cpp -fglasgow-exts -fno-warn-orphans -fno-warn-incomplete-patterns #-} --- --- Module : ByteString.Lazy +-- | +-- Module : Data.ByteString.Lazy -- Copyright : (c) Don Stewart 2006 -- (c) Duncan Coutts 2006 -- License : BSD-style -- -- Maintainer : dons@cse.unsw.edu.au -- Stability : experimental --- Portability : portable, requires ffi and cpp --- Tested with : GHC 6.4.1 and Hugs March 2005 +-- Portability : non-portable (instance of type synonym) -- - --- --- | A time and space-efficient implementation of lazy byte vectors +-- A time and space-efficient implementation of lazy byte vectors -- using lists of packed 'Word8' arrays, suitable for high performance -- use, both in terms of large data quantities, or high speed -- requirements. Byte vectors are encoded as lazy lists of strict 'Word8' @@ -22,7 +19,7 @@ -- Some operations, such as concat, append, reverse and cons, have -- better complexity than their "Data.ByteString" equivalents, due to -- optimisations resulting from the list spine structure. And for other --- operations Lazy ByteStrings are usually within a few percent of +-- operations lazy ByteStrings are usually within a few percent of -- strict ones, but with better heap usage. For data larger than the -- available memory, or if you have tight memory constraints, this -- module will be the only option. The default chunk size is 64k, which @@ -34,9 +31,11 @@ -- -- > import qualified Data.ByteString.Lazy as B -- --- Original GHC implementation by Bryan O\'Sullivan. Rewritten to use --- UArray by Simon Marlow. Rewritten to support slices and use --- ForeignPtr by David Roundy. Polished and extended by Don Stewart. +-- Original GHC implementation by Bryan O\'Sullivan. +-- Rewritten to use 'Data.Array.Unboxed.UArray' by Simon Marlow. +-- Rewritten to support slices and use 'Foreign.ForeignPtr.ForeignPtr' +-- by David Roundy. +-- Polished and extended by Don Stewart. -- Lazy variant by Duncan Coutts and Don Stewart. -- diff --git a/Data/ByteString/Lazy/Char8.hs b/Data/ByteString/Lazy/Char8.hs index beec2ba..fe5eb80 100644 --- a/Data/ByteString/Lazy/Char8.hs +++ b/Data/ByteString/Lazy/Char8.hs @@ -1,18 +1,16 @@ {-# OPTIONS_GHC -cpp -fno-warn-orphans #-} --- +-- | -- Module : Data.ByteString.Lazy.Char8 -- Copyright : (c) Don Stewart 2006 -- License : BSD-style -- -- Maintainer : dons@cse.unsw.edu.au -- Stability : experimental --- Portability : portable (tested with GHC>=6.4.1 and Hugs 2005) --- - +-- Portability : non-portable (imports Data.ByteString.Lazy) -- --- | Manipulate /lazy/ 'ByteString's using 'Char' operations. All Chars will +-- Manipulate /lazy/ 'ByteString's using 'Char' operations. All Chars will -- be truncated to 8 bits. It can be expected that these functions will --- run at identical speeds to their Word8 equivalents in +-- run at identical speeds to their 'Data.Word.Word8' equivalents in -- "Data.ByteString.Lazy". -- -- This module is intended to be imported @qualified@, to avoid name