[project @ 2005-01-27 10:45:47 by simonpj]

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

diff --git a/Foreign/Ptr.hs b/Foreign/Ptr.hs
index 514de59..ad20da4 100644 (file)
--- a/Foreign/Ptr.hs
+++ b/Foreign/Ptr.hs
@@ -1,4 +1,4 @@
-{-# OPTIONS -fno-implicit-prelude #-}
+{-# OPTIONS_GHC -fno-implicit-prelude #-}
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Foreign.Ptr
@@ -42,7 +42,6 @@ module Foreign.Ptr (
 #ifdef __GLASGOW_HASKELL__
 import GHC.Ptr
 import GHC.IOBase
-import GHC.Err
 import GHC.Base
 import GHC.Num
 import GHC.List
@@ -89,6 +88,10 @@ instance Show (FunPtr a) where
    showsPrec p = showsPrec p . castFunPtrToPtr
 #endif
 
+-- | Release the storage associated with the given 'FunPtr', which
+-- must have been obtained from a wrapper stub.  This should be called
+-- whenever the return value from a foreign import wrapper function is
+-- no longer required; otherwise, the storage it uses will leak.
 foreign import ccall unsafe "freeHaskellFunctionPtr"
     freeHaskellFunPtr :: FunPtr a -> IO ()
 #endif