More Haddock comments
authorRoman Leshchinskiy <rl@cse.unsw.edu.au>
Sat, 12 Jul 2008 03:50:55 +0000 (03:50 +0000)
committerRoman Leshchinskiy <rl@cse.unsw.edu.au>
Sat, 12 Jul 2008 03:50:55 +0000 (03:50 +0000)
Data/Vector.hs
Data/Vector/Mutable.hs
Data/Vector/Unboxed.hs
Data/Vector/Unboxed/Mutable.hs

index 41a25e2..f661d6e 100644 (file)
@@ -1,5 +1,17 @@
 {-# LANGUAGE MagicHash, UnboxedTuples, FlexibleInstances, MultiParamTypeClasses #-}
 
 {-# LANGUAGE MagicHash, UnboxedTuples, FlexibleInstances, MultiParamTypeClasses #-}
 
+-- |
+-- Module      : Data.Vector
+-- Copyright   : (c) Roman Leshchinskiy 2008
+-- License     : BSD-style
+--
+-- Maintainer  : rl@cse.unsw.edu.au
+-- Stability   : experimental
+-- Portability : non-portable
+-- 
+-- Boxed vectors
+--
+
 module Data.Vector (
   Vector(..), module Data.Vector.IVector
 ) where
 module Data.Vector (
   Vector(..), module Data.Vector.IVector
 ) where
index 5292831..ced0233 100644 (file)
@@ -1,5 +1,17 @@
 {-# LANGUAGE MagicHash, UnboxedTuples, MultiParamTypeClasses, GADTs, FlexibleInstances #-}
 
 {-# LANGUAGE MagicHash, UnboxedTuples, MultiParamTypeClasses, GADTs, FlexibleInstances #-}
 
+-- |
+-- Module      : Data.Vector.Mutable
+-- Copyright   : (c) Roman Leshchinskiy 2008
+-- License     : BSD-style
+--
+-- Maintainer  : rl@cse.unsw.edu.au
+-- Stability   : experimental
+-- Portability : non-portable
+-- 
+-- Mutable boxed vectors.
+--
+
 module Data.Vector.Mutable ( Vector(..) )
 where
 
 module Data.Vector.Mutable ( Vector(..) )
 where
 
@@ -20,6 +32,11 @@ data Vector m a where
          -> MutableArray# s a
          -> Vector (ST s) a
 #else
          -> MutableArray# s a
          -> Vector (ST s) a
 #else
+-- | Type of mutable boxed vectors. This is actually a GADT:
+--
+-- > data Vector m a where
+-- >   Vector :: !Int -> !Int -> MutableArray# s a -> Vector (ST s) a
+--
 data Vector m a = forall s. Vector !Int !Int (MutableArray# s a)
 #endif
 
 data Vector m a = forall s. Vector !Int !Int (MutableArray# s a)
 #endif
 
index 87bf1f6..2d51f29 100644 (file)
@@ -1,5 +1,17 @@
 {-# LANGUAGE MagicHash, UnboxedTuples, FlexibleInstances, MultiParamTypeClasses #-}
 
 {-# LANGUAGE MagicHash, UnboxedTuples, FlexibleInstances, MultiParamTypeClasses #-}
 
+-- |
+-- Module      : Data.Vector.Unboxed
+-- Copyright   : (c) Roman Leshchinskiy 2008
+-- License     : BSD-style
+--
+-- Maintainer  : rl@cse.unsw.edu.au
+-- Stability   : experimental
+-- Portability : non-portable
+-- 
+-- Unboxed vectors based on 'Unbox'.
+--
+
 module Data.Vector.Unboxed (
   Vector(..), module Data.Vector.IVector
 ) where
 module Data.Vector.Unboxed (
   Vector(..), module Data.Vector.IVector
 ) where
index 25520bb..2dacab0 100644 (file)
@@ -1,5 +1,17 @@
 {-# LANGUAGE MagicHash, UnboxedTuples, MultiParamTypeClasses, FlexibleInstances, GADTs, ScopedTypeVariables #-}
 
 {-# LANGUAGE MagicHash, UnboxedTuples, MultiParamTypeClasses, FlexibleInstances, GADTs, ScopedTypeVariables #-}
 
+-- |
+-- Module      : Data.Vector.Unboxed.Mutable
+-- Copyright   : (c) Roman Leshchinskiy 2008
+-- License     : BSD-style
+--
+-- Maintainer  : rl@cse.unsw.edu.au
+-- Stability   : experimental
+-- Portability : non-portable
+-- 
+-- Mutable unboxed vectors based on 'Unbox'.
+--
+
 module Data.Vector.Unboxed.Mutable ( Vector(..) )
 where
 
 module Data.Vector.Unboxed.Mutable ( Vector(..) )
 where
 
@@ -21,6 +33,11 @@ data Vector m a where
           -> MutableByteArray# s
           -> Vector (ST s) a
 #else
           -> MutableByteArray# s
           -> Vector (ST s) a
 #else
+-- | Type of mutable unboxed vectors. This is actually a GADT:
+--
+-- > data Vector m a where
+-- >   Vector :: !Int -> !Int -> MutableByteArray# s -> Vector (ST s) a
+--
 data Vector m a = forall s. Vector !Int !Int (MutableByteArray# s)
 #endif
 
 data Vector m a = forall s. Vector !Int !Int (MutableByteArray# s)
 #endif