Skip to content

Commit

Permalink
Improve akka-stream docs (missing an) (akka#21649)
Browse files Browse the repository at this point in the history
  • Loading branch information
VEINHORN authored and ktoso committed Oct 13, 2016
1 parent ce22f0a commit b690cc0
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions akka-stream/src/main/scala/akka/stream/ActorMaterializer.scala
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import scala.util.control.NoStackTrace
object ActorMaterializer {

/**
* Scala API: Creates a ActorMaterializer which will execute every step of a transformation
* Scala API: Creates an ActorMaterializer which will execute every step of a transformation
* pipeline within its own [[akka.actor.Actor]]. The required [[akka.actor.ActorRefFactory]]
* (which can be either an [[akka.actor.ActorSystem]] or an [[akka.actor.ActorContext]])
* will be used to create one actor that in turn creates actors for the transformation steps.
Expand All @@ -43,7 +43,7 @@ object ActorMaterializer {
}

/**
* Scala API: Creates a ActorMaterializer which will execute every step of a transformation
* Scala API: Creates an ActorMaterializer which will execute every step of a transformation
* pipeline within its own [[akka.actor.Actor]]. The required [[akka.actor.ActorRefFactory]]
* (which can be either an [[akka.actor.ActorSystem]] or an [[akka.actor.ActorContext]])
* will be used to create these actors, therefore it is *forbidden* to pass this object
Expand All @@ -67,7 +67,7 @@ object ActorMaterializer {
}

/**
* Scala API: Creates a ActorMaterializer which will execute every step of a transformation
* Scala API: Creates an ActorMaterializer which will execute every step of a transformation
* pipeline within its own [[akka.actor.Actor]]. The required [[akka.actor.ActorRefFactory]]
* (which can be either an [[akka.actor.ActorSystem]] or an [[akka.actor.ActorContext]])
* will be used to create these actors, therefore it is *forbidden* to pass this object
Expand Down Expand Up @@ -97,7 +97,7 @@ object ActorMaterializer {
}

/**
* Java API: Creates a ActorMaterializer which will execute every step of a transformation
* Java API: Creates an ActorMaterializer which will execute every step of a transformation
* pipeline within its own [[akka.actor.Actor]]. The required [[akka.actor.ActorRefFactory]]
* (which can be either an [[akka.actor.ActorSystem]] or an [[akka.actor.ActorContext]])
* will be used to create these actors, therefore it is *forbidden* to pass this object
Expand All @@ -110,7 +110,7 @@ object ActorMaterializer {
apply()(context)

/**
* Java API: Creates a ActorMaterializer which will execute every step of a transformation
* Java API: Creates an ActorMaterializer which will execute every step of a transformation
* pipeline within its own [[akka.actor.Actor]]. The required [[akka.actor.ActorRefFactory]]
* (which can be either an [[akka.actor.ActorSystem]] or an [[akka.actor.ActorContext]])
* will be used to create one actor that in turn creates actors for the transformation steps.
Expand All @@ -119,7 +119,7 @@ object ActorMaterializer {
apply(Option(settings), None)(context)

/**
* Java API: Creates a ActorMaterializer which will execute every step of a transformation
* Java API: Creates an ActorMaterializer which will execute every step of a transformation
* pipeline within its own [[akka.actor.Actor]]. The required [[akka.actor.ActorRefFactory]]
* (which can be either an [[akka.actor.ActorSystem]] or an [[akka.actor.ActorContext]])
* will be used to create these actors, therefore it is *forbidden* to pass this object
Expand All @@ -138,7 +138,7 @@ object ActorMaterializer {
case c: ActorContext c.system
case null throw new IllegalArgumentException("ActorRefFactory context must be defined")
case _
throw new IllegalArgumentException(s"ActorRefFactory context must be a ActorSystem or ActorContext, got [${context.getClass.getName}]")
throw new IllegalArgumentException(s"ActorRefFactory context must be an ActorSystem or ActorContext, got [${context.getClass.getName}]")
}
system
}
Expand All @@ -161,7 +161,7 @@ private[akka] object ActorMaterializerHelper {
}

/**
* A ActorMaterializer takes the list of transformations comprising a
* An ActorMaterializer takes the list of transformations comprising a
* [[akka.stream.scaladsl.Flow]] and materializes them in the form of
* [[org.reactivestreams.Processor]] instances. How transformation
* steps are split up into asynchronous regions is implementation
Expand Down

0 comments on commit b690cc0

Please sign in to comment.