[project @ 2002-05-09 13:16:29 by simonmar]

[ghc-base.git] / Foreign / Storable.hs

diff --git a/Foreign/Storable.hs b/Foreign/Storable.hs
index 755b383..3d57481 100644 (file)
--- a/Foreign/Storable.hs
+++ b/Foreign/Storable.hs
@@ -1,22 +1,24 @@
 {-# OPTIONS -fno-implicit-prelude #-}
 -----------------------------------------------------------------------------
--- 
+-- |
 -- Module      :  Foreign.Storable
 -- Copyright   :  (c) The FFI task force 2001
--- License     :  BSD-style (see the file libraries/core/LICENSE)
+-- License     :  BSD-style (see the file libraries/base/LICENSE)
 -- 
 -- Maintainer  :  ffi@haskell.org
 -- Stability   :  provisional
 -- Portability :  portable
 --
--- $Id: Storable.hs,v 1.3 2002/02/05 17:32:25 simonmar Exp $
---
--- A class for primitive marshaling
+-- The module "Storable" provides most elementary support for
+-- marshalling and is part of the language-independent portion of the
+-- Foreign Function Interface (FFI), and will normally be imported via
+-- the "Foreign" module.
 --
 -----------------------------------------------------------------------------
 
 module Foreign.Storable
-       ( Storable(
+       ( -- * The 'Storable' class
+         Storable(
             sizeOf,         -- :: a -> Int
             alignment,      -- :: a -> Int
             peekElemOff,    -- :: Ptr a -> Int      -> IO a