Skip to content

Commit 81a15aa

Browse files
committed
MonadMVar: added haddocks
1 parent 9b24427 commit 81a15aa

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

io-classes/src/Control/Monad/Class/MonadMVar.hs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,37 @@ class Monad m => MonadMVar m where
3535

3636
type MVar m = (mvar :: Type -> Type) | mvar -> m
3737

38+
-- | See 'IO.newEmptyMVar'.
3839
newEmptyMVar :: m (MVar m a)
40+
-- | See 'IO.takeMVar'.
3941
takeMVar :: MVar m a -> m a
42+
-- | See 'IO.putMVar'.
4043
putMVar :: MVar m a -> a -> m ()
44+
-- | See 'IO.tryTakeMVar'.
4145
tryTakeMVar :: MVar m a -> m (Maybe a)
46+
-- | See 'IO.tryPutMVar'.
4247
tryPutMVar :: MVar m a -> a -> m Bool
48+
-- | See 'IO.isEmptyMVar'.
4349
isEmptyMVar :: MVar m a -> m Bool
4450

4551
-- methods with a default implementation
52+
-- | See 'IO.newMVar'.
4653
newMVar :: a -> m (MVar m a)
54+
-- | See 'IO.readMVar'.
4755
readMVar :: MVar m a -> m a
56+
-- | See 'IO.swapMVar'.
4857
swapMVar :: MVar m a -> a -> m a
58+
-- | See 'IO.withMVar'.
4959
withMVar :: MVar m a -> (a -> m b) -> m b
60+
-- | See 'IO.withMVarMasked'.
5061
withMVarMasked :: MVar m a -> (a -> m b) -> m b
62+
-- | See 'IO.modifyMVar_'.
5163
modifyMVar_ :: MVar m a -> (a -> m a) -> m ()
64+
-- | See 'IO.modifyMVar'.
5265
modifyMVar :: MVar m a -> (a -> m (a, b)) -> m b
66+
-- | See 'IO.modifyMVarMasked_'.
5367
modifyMVarMasked_ :: MVar m a -> (a -> m a) -> m ()
68+
-- | See 'IO.modifyMVarMasked'.
5469
modifyMVarMasked :: MVar m a -> (a -> m (a,b)) -> m b
5570

5671
default newMVar :: a -> m (MVar m a)

0 commit comments

Comments
 (0)