From 4f667de73d25149cb9dbe5bdb51bbfb4429f92b7 Mon Sep 17 00:00:00 2001 From: Ignasi Marimon-Clos Date: Mon, 27 Apr 2020 16:40:57 +0200 Subject: [PATCH] Some cleanup to prepare... --- .../stream/operators/RetryFlow/withBackoff.md | 12 ++++-------- .../operators/RetryFlow/withBackoffAndContext.md | 9 ++++----- .../main/paradox/stream/operators/Sink/actorRef.md | 3 ++- .../main/paradox/stream/operators/Sink/collection.md | 2 ++ .../stream/operators/Sink/fromMaterializer.md | 1 + .../src/main/paradox/stream/operators/Sink/setup.md | 1 + .../stream/operators/Source-or-Flow/logWithMarker.md | 9 ++++----- .../main/paradox/stream/operators/Source/maybe.md | 8 ++++---- .../main/paradox/stream/operators/Source/unfold.md | 8 ++++---- 9 files changed, 26 insertions(+), 27 deletions(-) diff --git a/akka-docs/src/main/paradox/stream/operators/RetryFlow/withBackoff.md b/akka-docs/src/main/paradox/stream/operators/RetryFlow/withBackoff.md index 5860939341..e4c8336926 100644 --- a/akka-docs/src/main/paradox/stream/operators/RetryFlow/withBackoff.md +++ b/akka-docs/src/main/paradox/stream/operators/RetryFlow/withBackoff.md @@ -4,17 +4,13 @@ Wrap the given @apidoc[Flow] and retry individual elements in that stream with a @ref[Error handling](../index.md#error-handling) +@@@div { .group-scala } + ## Signature -Scala -: @@signature [RetryFlow.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/RetryFlow.scala) { #withBackoff } +@@signature [RetryFlow.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/RetryFlow.scala) { #withBackoff } -Java -: @@snip [RetryFlowTest.java](/akka-stream-tests/src/test/java/akka/stream/javadsl/RetryFlowTest.java) { #withBackoff-signature } - -## API documentation - -@apidoc[RetryFlow$] +@@@ ## Description diff --git a/akka-docs/src/main/paradox/stream/operators/RetryFlow/withBackoffAndContext.md b/akka-docs/src/main/paradox/stream/operators/RetryFlow/withBackoffAndContext.md index ffb1e6e54c..97a5d3ed45 100644 --- a/akka-docs/src/main/paradox/stream/operators/RetryFlow/withBackoffAndContext.md +++ b/akka-docs/src/main/paradox/stream/operators/RetryFlow/withBackoffAndContext.md @@ -4,14 +4,13 @@ Wrap the given @apidoc[FlowWithContext] and retry individual elements in that st @ref[Error handling](../index.md#error-handling) +@@@div { .group-scala } + ## Signature -Scala -: @@signature [RetryFlow.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/RetryFlow.scala) { #withBackoffAndContext } - -Java -: @@snip [RetryFlowTest.java](/akka-stream-tests/src/test/java/akka/stream/javadsl/RetryFlowTest.java) { #signature } +@@signature [RetryFlow.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/RetryFlow.scala) { #withBackoffAndContext } +@@@ ## Description diff --git a/akka-docs/src/main/paradox/stream/operators/Sink/actorRef.md b/akka-docs/src/main/paradox/stream/operators/Sink/actorRef.md index 7e70702cd5..127ffae75e 100644 --- a/akka-docs/src/main/paradox/stream/operators/Sink/actorRef.md +++ b/akka-docs/src/main/paradox/stream/operators/Sink/actorRef.md @@ -4,10 +4,11 @@ Send the elements from the stream to an `ActorRef`. @ref[Sink operators](../index.md#sink-operators) -@@@ div { .group-scala } +@@@div { .group-scala } ## Signature @@signature [Sink.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Sink.scala) { #actorRef } + @@@ ## Description diff --git a/akka-docs/src/main/paradox/stream/operators/Sink/collection.md b/akka-docs/src/main/paradox/stream/operators/Sink/collection.md index 176058df1e..26774cf7dd 100644 --- a/akka-docs/src/main/paradox/stream/operators/Sink/collection.md +++ b/akka-docs/src/main/paradox/stream/operators/Sink/collection.md @@ -10,6 +10,8 @@ @@signature [Sink.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Sink.scala) { #collection } +@@@ + ## Description @scala[Collect values emitted from the stream into an arbitrary collection `That`. The resulting collection is available through a `Future[That]` or when the stream completes. Note that the collection boundaries are those defined in the `CanBuildFrom` associated with the chosen collection. See [The Architecture of Scala 2.13's Collections](https://docs.scala-lang.org/overviews/core/architecture-of-scala-213-collections.html) for more info. The [`seq`](seq.html) operator is a shorthand for `Sink.collection[T, Vector[T]]`.]@java[Operator only available in the Scala API. The closest operator in the Java API is [`Sink.seq`](seq.html).] diff --git a/akka-docs/src/main/paradox/stream/operators/Sink/fromMaterializer.md b/akka-docs/src/main/paradox/stream/operators/Sink/fromMaterializer.md index 59d12c969a..22a8786a9b 100644 --- a/akka-docs/src/main/paradox/stream/operators/Sink/fromMaterializer.md +++ b/akka-docs/src/main/paradox/stream/operators/Sink/fromMaterializer.md @@ -9,6 +9,7 @@ Defer the creation of a `Sink` until materialization and access `Materializer` a ## Signature @@signature [Sink.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Sink.scala) { #fromMaterializer } + @@@ ## Description diff --git a/akka-docs/src/main/paradox/stream/operators/Sink/setup.md b/akka-docs/src/main/paradox/stream/operators/Sink/setup.md index 5415b7f2d0..8443b77120 100644 --- a/akka-docs/src/main/paradox/stream/operators/Sink/setup.md +++ b/akka-docs/src/main/paradox/stream/operators/Sink/setup.md @@ -15,6 +15,7 @@ The `setup` operator has been deprecated, use @ref:[fromMaterializer](./fromMate ## Signature @@signature [Sink.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Sink.scala) { #setup } + @@@ ## Description diff --git a/akka-docs/src/main/paradox/stream/operators/Source-or-Flow/logWithMarker.md b/akka-docs/src/main/paradox/stream/operators/Source-or-Flow/logWithMarker.md index 6f7d5a80ce..a350ee40e4 100644 --- a/akka-docs/src/main/paradox/stream/operators/Source-or-Flow/logWithMarker.md +++ b/akka-docs/src/main/paradox/stream/operators/Source-or-Flow/logWithMarker.md @@ -4,14 +4,13 @@ Log elements flowing through the stream as well as completion and erroring. @ref[Simple operators](../index.md#simple-operators) +@@@div { .group-scala } + ## Signature +@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Flow.scala) { #logWithMarker } -Scala -: @@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Flow.scala) { #logWithMarker } - -Java -: @@snip [FlowLogWithMarkerTest.java](/akka-stream-tests/src/test/java/akka/stream/javadsl/FlowLogWithMarkerTest.java) { #signature } +@@@ ## Description diff --git a/akka-docs/src/main/paradox/stream/operators/Source/maybe.md b/akka-docs/src/main/paradox/stream/operators/Source/maybe.md index 824fb655e4..e70f6f42a1 100644 --- a/akka-docs/src/main/paradox/stream/operators/Source/maybe.md +++ b/akka-docs/src/main/paradox/stream/operators/Source/maybe.md @@ -4,13 +4,13 @@ Create a source that emits once the materialized @scala[`Promise`] @java[`Comple @ref[Source operators](../index.md#source-operators) +@@@div { .group-scala } + ## Signature -Scala - : @@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #maybe } +@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #maybe } -Java -: @@snip [SourceDocExamples.java](/akka-docs/src/test/java/jdocs/stream/operators/SourceDocExamples.java) { #maybe-signature } +@@@ ## Description diff --git a/akka-docs/src/main/paradox/stream/operators/Source/unfold.md b/akka-docs/src/main/paradox/stream/operators/Source/unfold.md index a2640d1d8c..2b770a768f 100644 --- a/akka-docs/src/main/paradox/stream/operators/Source/unfold.md +++ b/akka-docs/src/main/paradox/stream/operators/Source/unfold.md @@ -4,13 +4,13 @@ Stream the result of a function as long as it returns a @scala[`Some`] @java[non @ref[Source operators](../index.md#source-operators) +@@@div { .group-scala } + ## Signature -Scala -: @@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #unfold } +@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #unfold } -Java -: @@snip [SourceUnfoldTest.java](/akka-stream-tests/src/test/java/akka/stream/javadsl/SourceUnfoldTest.java) { #signature } +@@@ ## Description