Skip to content

Commit

Permalink
Generate Scaladoc for Free types
Browse files Browse the repository at this point in the history
(cherry picked from commit 12629ce)
  • Loading branch information
Atry authored and xuwei-k committed Apr 11, 2017
1 parent c7350c0 commit 716bb75
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions core/src/main/scala/scalaz/Free.scala
Expand Up @@ -62,14 +62,22 @@ object Free extends FreeInstances {
def f: A => Free[S, B] = f0
}

/** A computation that can be stepped through, suspended, and paused */
/** A computation that can be stepped through, suspended, and paused
*
* @template
*/
type Trampoline[A] = Free[Function0, A]

/** A computation that produces values of type `A`, eventually resulting in a value of type `B`. */
/** A computation that produces values of type `A`, eventually resulting in a value of type `B`.
*
* @template
*/
type Source[A, B] = Free[(A, ?), B]

/** A computation that accepts values of type `A`, eventually resulting in a value of type `B`.
* Note the similarity to an [[scalaz.iteratee.Iteratee]].
*
* @template
*/
type Sink[A, B] = Free[(=> A) => ?, B]

Expand Down

0 comments on commit 716bb75

Please sign in to comment.