raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Improve akka-stream docs (missing an) (#21649)

Browse source
This commit is contained in:
Boris Korogvich 2016-10-13 12:41:33 +03:00 • committed by Konrad Malawski
parent ce22f0a364
commit b690cc049e
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
akka-stream/src/main/scala/akka/stream/ActorMaterializer.scala
View file

@ -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.
@ -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
@ -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
@ -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
@ -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.
@ -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
@ -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
}
@ -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