diff options
| author | Ömer Sinan Ağacan <omeragacan@gmail.com> | 2019-02-13 13:52:17 +0300 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2019-02-16 09:10:23 -0500 |
| commit | 7752fa54909a10b565a80a5ca8b751e174b14282 (patch) | |
| tree | 21b36c186fdc98942f7b5fe7814860fdd533e095 | |
| parent | 5544f6082d6e15d305b83f27f4daa29576d3666e (diff) | |
| download | haskell-7752fa54909a10b565a80a5ca8b751e174b14282.tar.gz | |
Minor documentation fix in GHC.ForeignPtr
| -rw-r--r-- | libraries/base/GHC/ForeignPtr.hs | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/libraries/base/GHC/ForeignPtr.hs b/libraries/base/GHC/ForeignPtr.hs index dc3b88a5f8..965ebb0780 100644 --- a/libraries/base/GHC/ForeignPtr.hs +++ b/libraries/base/GHC/ForeignPtr.hs @@ -250,7 +250,7 @@ mallocPlainForeignPtrAlignedBytes (I# size) (I# align) = IO $ \s -> } addForeignPtrFinalizer :: FinalizerPtr a -> ForeignPtr a -> IO () --- ^This function adds a finalizer to the given foreign object. The +-- ^ This function adds a finalizer to the given foreign object. The -- finalizer will run /before/ all other finalizers for the same -- object which have already been registered. addForeignPtrFinalizer (FunPtr fp) (ForeignPtr p c) = case c of @@ -269,10 +269,8 @@ addForeignPtrFinalizer (FunPtr fp) (ForeignPtr p c) = case c of addForeignPtrFinalizerEnv :: FinalizerEnvPtr env a -> Ptr env -> ForeignPtr a -> IO () --- ^ Like 'addForeignPtrFinalizerEnv' but allows the finalizer to be --- passed an additional environment parameter to be passed to the --- finalizer. The environment passed to the finalizer is fixed by the --- second argument to 'addForeignPtrFinalizerEnv' +-- ^ Like 'addForeignPtrFinalizer' but the finalizer is passed an additional +-- environment parameter. addForeignPtrFinalizerEnv (FunPtr fp) (Ptr ep) (ForeignPtr p c) = case c of PlainForeignPtr r -> insertCFinalizer r fp 1# ep p () MallocPtr _ r -> insertCFinalizer r fp 1# ep p c |