summaryrefslogtreecommitdiff
path: root/libraries/base/Control
diff options
context:
space:
mode:
authorHerbert Valerio Riedel <hvr@gnu.org>2014-12-16 12:07:10 +0100
committerHerbert Valerio Riedel <hvr@gnu.org>2014-12-16 13:30:08 +0100
commit554aedab646075e12e53b44df04bcfbccbe03a73 (patch)
tree0832201a44fd74632bbbd88fb77cb6c11eb34cf7 /libraries/base/Control
parent45a9696c550c5fe5e891b6d4710179272dc9f6db (diff)
downloadhaskell-554aedab646075e12e53b44df04bcfbccbe03a73.tar.gz
Convert `/Since: .../` to new `@since ...` syntax
Starting with Haddock 2.16 there's a new built-in support for since-annotations Note: This exposes a bug in the `@since` implementation (see e.g. `Data.Bits`)
Diffstat (limited to 'libraries/base/Control')
-rw-r--r--libraries/base/Control/Concurrent.hs6
-rw-r--r--libraries/base/Control/Concurrent/MVar.hs8
-rw-r--r--libraries/base/Control/Exception.hs2
-rw-r--r--libraries/base/Control/Monad.hs2
4 files changed, 9 insertions, 9 deletions
diff --git a/libraries/base/Control/Concurrent.hs b/libraries/base/Control/Concurrent.hs
index 702d0bb3b4..35248bfba3 100644
--- a/libraries/base/Control/Concurrent.hs
+++ b/libraries/base/Control/Concurrent.hs
@@ -191,7 +191,7 @@ attribute will block all other threads.
-- This function is useful for informing the parent when a child
-- terminates, for example.
--
--- /Since: 4.6.0.0/
+-- @since 4.6.0.0
forkFinally :: IO a -> (Either SomeException a -> IO ()) -> IO ThreadId
forkFinally action and_then =
mask $ \restore ->
@@ -431,7 +431,7 @@ threadWaitWrite fd
-- is an IO action that can be used to deregister interest
-- in the file descriptor.
--
--- /Since: 4.7.0.0/
+-- @since 4.7.0.0
threadWaitReadSTM :: Fd -> IO (STM (), IO ())
threadWaitReadSTM fd
#ifdef mingw32_HOST_OS
@@ -455,7 +455,7 @@ threadWaitReadSTM fd
-- is an IO action that can be used to deregister interest
-- in the file descriptor.
--
--- /Since: 4.7.0.0/
+-- @since 4.7.0.0
threadWaitWriteSTM :: Fd -> IO (STM (), IO ())
threadWaitWriteSTM fd
#ifdef mingw32_HOST_OS
diff --git a/libraries/base/Control/Concurrent/MVar.hs b/libraries/base/Control/Concurrent/MVar.hs
index 72a44d38d9..45c05fdc9b 100644
--- a/libraries/base/Control/Concurrent/MVar.hs
+++ b/libraries/base/Control/Concurrent/MVar.hs
@@ -193,7 +193,7 @@ withMVar m io =
Like 'withMVar', but the @IO@ action in the second argument is executed
with asynchronous exceptions masked.
- /Since: 4.7.0.0/
+ @since 4.7.0.0
-}
{-# INLINE withMVarMasked #-}
withMVarMasked :: MVar a -> (a -> IO b) -> IO b
@@ -236,7 +236,7 @@ modifyMVar m io =
Like 'modifyMVar_', but the @IO@ action in the second argument is executed with
asynchronous exceptions masked.
- /Since: 4.6.0.0/
+ @since 4.6.0.0
-}
{-# INLINE modifyMVarMasked_ #-}
modifyMVarMasked_ :: MVar a -> (a -> IO a) -> IO ()
@@ -250,7 +250,7 @@ modifyMVarMasked_ m io =
Like 'modifyMVar', but the @IO@ action in the second argument is executed with
asynchronous exceptions masked.
- /Since: 4.6.0.0/
+ @since 4.6.0.0
-}
{-# INLINE modifyMVarMasked #-}
modifyMVarMasked :: MVar a -> (a -> IO (a,b)) -> IO b
@@ -268,7 +268,7 @@ addMVarFinalizer = GHC.MVar.addMVarFinalizer
-- | Make a 'Weak' pointer to an 'MVar', using the second argument as
-- a finalizer to run when 'MVar' is garbage-collected
--
--- /Since: 4.6.0.0/
+-- @since 4.6.0.0
mkWeakMVar :: MVar a -> IO () -> IO (Weak (MVar a))
mkWeakMVar m@(MVar m#) f = IO $ \s ->
case mkWeak# m# m f s of (# s1, w #) -> (# s1, Weak w #)
diff --git a/libraries/base/Control/Exception.hs b/libraries/base/Control/Exception.hs
index 0bcbdca942..18c0e42914 100644
--- a/libraries/base/Control/Exception.hs
+++ b/libraries/base/Control/Exception.hs
@@ -219,7 +219,7 @@ A typical use of 'tryJust' for recovery looks like this:
-- When called outside 'mask', or inside 'uninterruptibleMask', this
-- function has no effect.
--
--- /Since: 4.4.0.0/
+-- @since 4.4.0.0
allowInterrupt :: IO ()
allowInterrupt = unsafeUnmask $ return ()
diff --git a/libraries/base/Control/Monad.hs b/libraries/base/Control/Monad.hs
index 07b011a6c3..6fa4a077d4 100644
--- a/libraries/base/Control/Monad.hs
+++ b/libraries/base/Control/Monad.hs
@@ -199,7 +199,7 @@ infixl 4 <$!>
-- | Strict version of 'Data.Functor.<$>'.
--
--- /Since: 4.8.0.0/
+-- @since 4.8.0.0
(<$!>) :: Monad m => (a -> b) -> m a -> m b
{-# INLINE (<$!>) #-}
f <$!> m = do