[project @ 2002-06-03 13:19:37 by simonmar]

[haskell-directory.git] / GHC / Arr.lhs

diff --git a/GHC/Arr.lhs b/GHC/Arr.lhs
index f69fa94..b2784fb 100644 (file)
--- a/GHC/Arr.lhs
+++ b/GHC/Arr.lhs
@@ -10,7 +10,7 @@
 -- Stability   :  internal
 -- Portability :  non-portable (GHC extensions)
 --
--- GHC's array implementation.
+-- GHC\'s array implementation.
 -- 
 -----------------------------------------------------------------------------
 
@@ -278,6 +278,16 @@ instance  (Ix a1, Ix a2, Ix a3, Ix a4, Ix a5) => Ix (a1,a2,a3,a4,a5)  where
 type IPr = (Int, Int)
 
 data Ix i => Array     i e = Array   !i !i (Array# e)
+
+-- | Mutable, boxed, non-strict arrays in the 'ST' monad.  The type
+-- arguments are as follows:
+--
+--  * @s@: the state variable argument for the 'ST' type
+--
+--  * @i@: the index type of the array (should be an instance of @Ix@)
+--
+--  * @e@: the element type of the array.
+--
 data         STArray s i e = STArray !i !i (MutableArray# s e)
        -- No Ix context for STArray.  They are stupid,
        -- and force an Ix context on the equality instance.