=str javadoc rewording on new wireTap method

This commit is contained in:
Konrad `ktoso` Malawski 2018-04-25 02:20:10 +09:00 committed by Konrad `ktoso` Malawski
parent 5f5b41f3b8
commit cceb184098
5 changed files with 10 additions and 9 deletions

View file

@ -484,8 +484,8 @@ final class Flow[In, Out, Mat](delegate: scaladsl.Flow[In, Out, Mat]) extends Gr
new Flow(delegate.map(f.apply))
/**
* Similar to [[map]], however does not modify the passed through element, the returned value is ignored.
* This is a simplified version of `wireTap(Sink)`, which you may use to wireTap a Sink onto this stream.
* This is a simplified version of `wireTap(Sink)` that takes only a simple procedure.
* Elements will be passed into this "side channel" function, and any of its results will be ignored.
*
* This operation is useful for inspecting the passed through element, usually by means of side-effecting
* operations (such as `println`, or emitting metrics), for each element without having to modify it.

View file

@ -1073,7 +1073,8 @@ final class Source[Out, Mat](delegate: scaladsl.Source[Out, Mat]) extends Graph[
new Source(delegate.map(f.apply))
/**
* Similar to [[map]], however does not modify the passed through element, the returned value is ignored.
* This is a simplified version of `wireTap(Sink)` that takes only a simple procedure.
* Elements will be passed into this "side channel" function, and any of its results will be ignored.
*
* This operation is useful for inspecting the passed through element, usually by means of side-effecting
* operations (such as `println`, or emitting metrics), for each element without having to modify it.

View file

@ -136,8 +136,8 @@ class SubFlow[In, Out, Mat](delegate: scaladsl.SubFlow[Out, Mat, scaladsl.Flow[I
new SubFlow(delegate.map(f.apply))
/**
* Similar to [[map]], however does not modify the passed through element, the returned value is ignored.
* This is a simplified version of `wireTap(Sink)`, which you may use to wireTap a Sink onto this stream.
* This is a simplified version of `wireTap(Sink)` that takes only a simple procedure.
* Elements will be passed into this "side channel" function, and any of its results will be ignored.
*
* This operation is useful for inspecting the passed through element, usually by means of side-effecting
* operations (such as `println`, or emitting metrics), for each element without having to modify it.

View file

@ -129,8 +129,8 @@ class SubSource[Out, Mat](delegate: scaladsl.SubFlow[Out, Mat, scaladsl.Source[O
new SubSource(delegate.map(f.apply))
/**
* Similar to [[map]], however does not modify the passed through element, the returned value is ignored.
* This is a simplified version of `wireTap(Sink)`, which you may use to wireTap a Sink onto this stream.
* This is a simplified version of `wireTap(Sink)` that takes only a simple procedure.
* Elements will be passed into this "side channel" function, and any of its results will be ignored.
*
* This operation is useful for inspecting the passed through element, usually by means of side-effecting
* operations (such as `println`, or emitting metrics), for each element without having to modify it.

View file

@ -767,8 +767,8 @@ trait FlowOps[+Out, +Mat] {
def map[T](f: Out T): Repr[T] = via(Map(f))
/**
* Similar to [[map]], however does not modify the passed through element, the returned value is ignored.
* This is a simplified version of `wireTap(Sink)`, which you may use to wireTap a Sink onto this stream.
* This is a simplified version of `wireTap(Sink)` that takes only a simple function.
* Elements will be passed into this "side channel" function, and any of its results will be ignored.
*
* This operation is useful for inspecting the passed through element, usually by means of side-effecting
* operations (such as `println`, or emitting metrics), for each element without having to modify it.