From 099e20ec6d88048035be30d65bbc73c4ce3e93c0 Mon Sep 17 00:00:00 2001 From: Muskan Gupta Date: Thu, 29 Apr 2021 12:07:14 +0530 Subject: [PATCH] add example to the doc of combine operator (#30194) --- .../paradox/stream/operators/Sink/combine.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/akka-docs/src/main/paradox/stream/operators/Sink/combine.md b/akka-docs/src/main/paradox/stream/operators/Sink/combine.md index cde70625be..49e2816b8e 100644 --- a/akka-docs/src/main/paradox/stream/operators/Sink/combine.md +++ b/akka-docs/src/main/paradox/stream/operators/Sink/combine.md @@ -6,12 +6,29 @@ Combine several sinks into one using a user specified strategy ## Signature -@apidoc[Sink.combine](Sink$) { scala="#combine[T,U](first:akka.stream.scaladsl.Sink[U,_],second:akka.stream.scaladsl.Sink[U,_],rest:akka.stream.scaladsl.Sink[U,_]*)(strategy:Int=>akka.stream.Graph[akka.stream.UniformFanOutShape[T,U],akka.NotUsed]):akka.stream.scaladsl.Sink[T,akka.NotUsed]" java="#combine(akka.stream.javadsl.Sink,akka.stream.javadsl.Sink,java.util.List,akka.japi.function.Function)" } +@apidoc[Sink.combine](Sink$) { scala=" +#combine[T,U](first:akka.stream.scaladsl.Sink[U,_],second:akka.stream.scaladsl.Sink[U,_],rest:akka.stream.scaladsl.Sink[U,_]*)( +strategy:Int=>akka.stream.Graph[akka.stream.UniformFanOutShape[T,U],akka.NotUsed]): +akka.stream.scaladsl.Sink[T,akka.NotUsed]" java="#combine( +akka.stream.javadsl.Sink,akka.stream.javadsl.Sink,java.util.List,akka.japi.function.Function)" } ## Description Combine several sinks into one using a user specified strategy +## Example + +This example shows how to combine multiple sinks with a Fan-out Junction. + +Scala +: +@@snip [StreamPartialGraphDSLDocSpec.scala](/akka-docs/src/test/scala/docs/stream/StreamPartialGraphDSLDocSpec.scala) { +#sink-combine } + +Java +: @@snip [StreamPartialGraphDSLDocTest.java](/akka-docs/src/test/java/jdocs/stream/StreamPartialGraphDSLDocTest.java) +{ #sink-combine } + ## Reactive Streams semantics @@@div { .callout }