Added rest of generated docs

Author: robertdp

.gitignore

@@ -5,7 +5,7 @@
 /generated-docs/*
 !/generated-docs/md
 /generated-docs/md/*
-!/generated-docs/md/React.Halo.md
+!/generated-docs/md/React.Halo.*
 /.psc-package/
 /.psc*
 /.purs*

README.md

@@ -27,6 +27,10 @@ Then install with Spago:
 
 `$ spago install react-halo`
 
+## Generated documentation
+
+See [here](https://github.com/robertdp/purescript-react-halo/blob/master/generated-docs/md/React.Halo.md)
+
 ## What does Halo provide?
 
 Whether you are using the hook or one of the component helpers, the main feature that Halo provides is the `eval` function. It looks like:
@@ -108,3 +112,4 @@ kill :: forall m action state props. ForkId -> HaloM props state action m Unit
 ```
 
 Similarly to subscriptions, when the component unmounts all still-running forks will be killed.
+

generated-docs/md/React.Halo.Component.Control.md

@@ -0,0 +1,131 @@
+## Module React.Halo.Component.Control
+
+#### `HaloF`
+
+``` purescript
+data HaloF props state action m a
+  = Props (props -> a)
+  | State (state -> Tuple a state)
+  | Subscribe (SubscriptionId -> Event action) (SubscriptionId -> a)
+  | Unsubscribe SubscriptionId a
+  | Lift (m a)
+  | Par (HaloAp props state action m a)
+  | Fork (HaloM props state action m Unit) (ForkId -> a)
+  | Kill ForkId a
+```
+
+##### Instances
+``` purescript
+(Functor m) => Functor (HaloF props state action m)
+```
+
+#### `HaloM`
+
+``` purescript
+newtype HaloM props state action m a
+  = HaloM (Free (HaloF props state action m) a)
+```
+
+##### Instances
+``` purescript
+Functor (HaloM props state action m)
+Apply (HaloM props state action m)
+Applicative (HaloM props state action m)
+Bind (HaloM props state action m)
+Monad (HaloM props state action m)
+(Semigroup a) => Semigroup (HaloM props state action m a)
+(Monoid a) => Monoid (HaloM props state action m a)
+MonadTrans (HaloM props state action)
+(MonadEffect m) => MonadEffect (HaloM props state action m)
+(MonadAff m) => MonadAff (HaloM props state action m)
+MonadState state (HaloM props state action m)
+MonadRec (HaloM props state action m)
+(MonadAsk r m) => MonadAsk r (HaloM props state action m)
+(MonadTell w m) => MonadTell w (HaloM props state action m)
+(MonadThrow e m) => MonadThrow e (HaloM props state action m)
+```
+
+#### `HaloAp`
+
+``` purescript
+newtype HaloAp props state action m a
+  = HaloAp (FreeAp (HaloM props state action m) a)
+```
+
+##### Instances
+``` purescript
+Newtype (HaloAp props state action m a) _
+Functor (HaloAp props state action m)
+Apply (HaloAp props state action m)
+Applicative (HaloAp props state action m)
+```
+
+#### `SubscriptionId`
+
+``` purescript
+newtype SubscriptionId
+  = SubscriptionId Int
+```
+
+##### Instances
+``` purescript
+Eq SubscriptionId
+Ord SubscriptionId
+```
+
+#### `ForkId`
+
+``` purescript
+newtype ForkId
+  = ForkId Int
+```
+
+##### Instances
+``` purescript
+Eq ForkId
+Ord ForkId
+```
+
+#### `hoist`
+
+``` purescript
+hoist :: forall props state action m m'. Functor m => (m ~> m') -> (HaloM props state action m) ~> (HaloM props state action m')
+```
+
+#### `props`
+
+``` purescript
+props :: forall props m action state. HaloM props state action m props
+```
+
+#### `subscribe'`
+
+``` purescript
+subscribe' :: forall m action state props. (SubscriptionId -> Event action) -> HaloM props state action m SubscriptionId
+```
+
+#### `subscribe`
+
+``` purescript
+subscribe :: forall props state action m. Event action -> HaloM props state action m SubscriptionId
+```
+
+#### `unsubscribe`
+
+``` purescript
+unsubscribe :: forall m action state props. SubscriptionId -> HaloM props state action m Unit
+```
+
+#### `fork`
+
+``` purescript
+fork :: forall m action state props. HaloM props state action m Unit -> HaloM props state action m ForkId
+```
+
+#### `kill`
+
+``` purescript
+kill :: forall m action state props. ForkId -> HaloM props state action m Unit
+```
+
+

generated-docs/md/React.Halo.Component.State.md

@@ -0,0 +1,22 @@
+## Module React.Halo.Component.State
+
+#### `HaloState`
+
+``` purescript
+newtype HaloState props state action
+  = HaloState { eval :: Lifecycle props action -> HaloM props state action Aff Unit, forks :: Ref (Map ForkId (Fiber Unit)), fresh :: Ref Int, props :: Ref props, render :: state -> Effect Unit, state :: Ref state, subscriptions :: Ref (Map SubscriptionId (Effect Unit)), unmounted :: Ref Boolean }
+```
+
+#### `createInitialState`
+
+``` purescript
+createInitialState :: forall props state action. state -> (Lifecycle props action -> HaloM props state action Aff Unit) -> (state -> Effect Unit) -> props -> Effect (HaloState props state action)
+```
+
+#### `fresh`
+
+``` purescript
+fresh :: forall props state action a. (Int -> a) -> HaloState props state action -> Effect a
+```
+
+

generated-docs/md/React.Halo.Component.md

@@ -0,0 +1,25 @@
+## Module React.Halo.Component
+
+#### `Lifecycle`
+
+``` purescript
+data Lifecycle props action
+  = Initialize props
+  | Update props props
+  | Action action
+  | Finalize
+```
+
+#### `ComponentSpec`
+
+``` purescript
+type ComponentSpec props state action m = { eval :: Lifecycle props action -> HaloM props state action m Unit, initialState :: state, render :: { props :: props, send :: action -> Effect Unit, state :: state } -> JSX }
+```
+
+#### `HookSpec`
+
+``` purescript
+type HookSpec props state action m = { eval :: Lifecycle props action -> HaloM props state action m Unit, initialState :: state, props :: props }
+```
+
+

generated-docs/md/React.Halo.Eval.md

@@ -0,0 +1,63 @@
+## Module React.Halo.Eval
+
+#### `evalHaloM`
+
+``` purescript
+evalHaloM :: forall props state action. HaloState props state action -> (HaloM props state action Aff) ~> Aff
+```
+
+#### `evalHaloF`
+
+``` purescript
+evalHaloF :: forall props state action. HaloState props state action -> (HaloF props state action Aff) ~> Aff
+```
+
+#### `EvalSpec`
+
+``` purescript
+type EvalSpec props action state m = { onAction :: action -> HaloM props state action m Unit, onFinalize :: Maybe action, onInitialize :: props -> Maybe action, onUpdate :: props -> props -> Maybe action }
+```
+
+#### `defaultEval`
+
+``` purescript
+defaultEval :: forall props action state m. EvalSpec props action state m
+```
+
+#### `makeEval`
+
+``` purescript
+makeEval :: forall props action state m. EvalSpec props action state m -> Lifecycle props action -> HaloM props state action m Unit
+```
+
+#### `runAff`
+
+``` purescript
+runAff :: Aff Unit -> Effect Unit
+```
+
+#### `runInitialize`
+
+``` purescript
+runInitialize :: forall props state action. HaloState props action state -> props -> Effect Unit
+```
+
+#### `handleUpdate`
+
+``` purescript
+handleUpdate :: forall props state action. HaloState props action state -> props -> Effect Unit
+```
+
+#### `handleAction`
+
+``` purescript
+handleAction :: forall props state action. HaloState props state action -> action -> Effect Unit
+```
+
+#### `runFinalize`
+
+``` purescript
+runFinalize :: forall props state action. HaloState props state action -> Effect Unit
+```
+
+