Wibble in docs for new ForeignPtr functionsn
authorDon Stewart <dons@cse.unsw.edu.au>
Fri, 9 Jun 2006 07:59:24 +0000 (07:59 +0000)
committerDon Stewart <dons@cse.unsw.edu.au>
Fri, 9 Jun 2006 07:59:24 +0000 (07:59 +0000)
GHC/ForeignPtr.hs

index b0850df..603a8f3 100644 (file)
@@ -183,7 +183,7 @@ mallocForeignPtrBytes (I# size) = do
 -- mallocPlainForeignPtr. This is useful for ForeignPtrs that will live
 -- only inside Haskell (such as those created for packed strings).
 -- Attempts to add a finalizer to a ForeignPtr created this way, or to
--- finalize such a pointer, will have no effect.
+-- finalize such a pointer, will throw an exception.
 -- 
 mallocPlainForeignPtr :: Storable a => IO (ForeignPtr a)
 mallocPlainForeignPtr = doMalloc undefined
@@ -197,7 +197,8 @@ mallocPlainForeignPtr = doMalloc undefined
 
 -- | This function is similar to 'mallocForeignPtrBytes', except that
 -- the internally an optimised ForeignPtr representation with no
--- finalizer is used.
+-- finalizer is used. Attempts to add a finalizer will cause an
+-- exception to be thrown.
 mallocPlainForeignPtrBytes :: Int -> IO (ForeignPtr a)
 mallocPlainForeignPtrBytes (I# size) = IO $ \s ->
     case newPinnedByteArray# size s      of { (# s, mbarr# #) ->