Add generated docs

purescript · Apr 25, 2014 · 3f8fd01 · 3f8fd01
1 parent 159a4ce
commit 3f8fd01
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+# Module Documentation
+
+## Module Control.Monad.Eff.Ref
+
+### Types
+
+    data Ref :: !
+
+    data RefVal :: * -> *
+
+
+### Values
+
+    modifyRef :: forall s r. RefVal s -> (s -> s) -> Eff (ref :: Ref | r) {  }
+
+    newRef :: forall s r. s -> Eff (ref :: Ref | r) (RefVal s)
+
+    readRef :: forall s r. RefVal s -> Eff (ref :: Ref | r) s
+
+    writeRef :: forall s r. RefVal s -> s -> Eff (ref :: Ref | r) {  }
+
+
+## Module Control.Monad.Eff.Ref.Unsafe
+
+### Values
+
+    unsafeRunRef :: forall eff a. Eff (ref :: Ref | eff) a -> Eff eff a