From 46f7eef3d9970bf9e3f07e7bff4da259472747dd Mon Sep 17 00:00:00 2001 From: Konrad Malawski Date: Mon, 24 Oct 2016 13:31:47 +0200 Subject: [PATCH] +doc add missing java documentation for scanAsync/foldAsync (#21701) * +doc add missing java documentation for scanAsync/foldAsync =doc fix formatting in stages overview (scanAsync/foldAsync) * Future => CompletionStage --- akka-docs/rst/java/stream/stages-overview.rst | 20 +++++++++++++++++++ .../rst/scala/stream/stages-overview.rst | 4 ++-- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/akka-docs/rst/java/stream/stages-overview.rst b/akka-docs/rst/java/stream/stages-overview.rst index 2b7e37517b..365a464914 100644 --- a/akka-docs/rst/java/stream/stages-overview.rst +++ b/akka-docs/rst/java/stream/stages-overview.rst @@ -647,6 +647,16 @@ the second element is required from downstream. **completes** when upstream completes +scanAsync +^^^^^^^^^ +Just like ``scan`` but receiving a function that results in a ``CompletionStage`` to the next value. + +**emits** when the ``CompletionStage`` resulting from the function scanning the element resolves to the next value + +**backpressures** when downstream backpressures + +**completes** when upstream completes and the last ``CompletionStage`` is resolved + fold ^^^^ Start with current value ``zero`` and then apply the current and next value to the given function, when upstream @@ -658,6 +668,16 @@ complete the current value is emitted downstream. **completes** when upstream completes +foldAsync +^^^^^^^^^ +Just like ``fold`` but receiving a function that results in a ``CompletionStage`` to the next value. + +**emits** when upstream completes and the last ``CompletionStage`` is resolved + +**backpressures** when downstream backpressures + +**completes** when upstream completes and the last ``CompletionStage`` is resolved + reduce ^^^^^^ Start with first element and then apply the current and next value to the given function, when upstream diff --git a/akka-docs/rst/scala/stream/stages-overview.rst b/akka-docs/rst/scala/stream/stages-overview.rst index c4f80b049e..5adb5e191b 100644 --- a/akka-docs/rst/scala/stream/stages-overview.rst +++ b/akka-docs/rst/scala/stream/stages-overview.rst @@ -637,7 +637,7 @@ the second element is required from downstream. **completes** when upstream completes scanAsync -^^^^ +^^^^^^^^^ Just like ``scan`` but receiving a function that results in a ``Future`` to the next value. **emits** when the ``Future`` resulting from the function scanning the element resolves to the next value @@ -658,7 +658,7 @@ complete the current value is emitted downstream. **completes** when upstream completes foldAsync -^^^^ +^^^^^^^^^ Just like ``fold`` but receiving a function that results in a ``Future`` to the next value. **emits** when upstream completes and the last ``Future`` is resolved