Skip to content
Snippets Groups Projects
Commit 4eaab57f authored by Stephen R. van den Berg's avatar Stephen R. van den Berg
Browse files

Concurrent: Improve docs.

parent cfff2a83
Branches
Tags
No related merge requests found
...@@ -204,7 +204,7 @@ class Future ...@@ -204,7 +204,7 @@ class Future
//! @b{not@} a @[Future]). //! @b{not@} a @[Future]).
//! //!
//! @seealso //! @seealso
//! @[flat_map()], @[transform()] //! @[flat_map()], @[transform()], @[recover()]
this_program map(function(mixed, mixed ... : mixed) fun, mixed ... extra) this_program map(function(mixed, mixed ... : mixed) fun, mixed ... extra)
{ {
Promise p = Promise(); Promise p = Promise();
...@@ -221,7 +221,7 @@ class Future ...@@ -221,7 +221,7 @@ class Future
//! This method is used if your @[fun] returns a @[Future] again. //! This method is used if your @[fun] returns a @[Future] again.
//! //!
//! @seealso //! @seealso
//! @[map()], @[transform_with()] //! @[map()], @[transform_with()], @[recover_with()]
this_program flat_map(function(mixed, mixed ... : this_program) fun, this_program flat_map(function(mixed, mixed ... : this_program) fun,
mixed ... extra) mixed ... extra)
{ {
...@@ -235,6 +235,13 @@ class Future ...@@ -235,6 +235,13 @@ class Future
//! the fulfilled result of this @[Future], or the result //! the fulfilled result of this @[Future], or the result
//! of applying @[fun] with the failed result followed //! of applying @[fun] with the failed result followed
//! by @[extra]. //! by @[extra].
//!
//! @note
//! This method is used if your callbacks returns a regular value (i.e.
//! @b{not@} a @[Future]).
//!
//! @seealso
//! @[recover_with()], @[map()], @[transform()]
this_program recover(function(mixed, mixed ... : mixed) fun, this_program recover(function(mixed, mixed ... : mixed) fun,
mixed ... extra) mixed ... extra)
{ {
...@@ -248,6 +255,12 @@ class Future ...@@ -248,6 +255,12 @@ class Future
//! the fulfilled result of this @[Future], or the fulfilled result //! the fulfilled result of this @[Future], or the fulfilled result
//! of applying @[fun] with the failed result followed //! of applying @[fun] with the failed result followed
//! by @[extra]. //! by @[extra].
//!
//! @note
//! This method is used if your callbacks returns a @[Future] again.
//!
//! @seealso
//! @[recover()], @[flat_map()], @[transform_with()]
this_program recover_with(function(mixed, mixed ... : this_program) fun, this_program recover_with(function(mixed, mixed ... : this_program) fun,
mixed ... extra) mixed ... extra)
{ {
...@@ -282,7 +295,7 @@ class Future ...@@ -282,7 +295,7 @@ class Future
//! @b{not@} a @[Future]). //! @b{not@} a @[Future]).
//! //!
//! @seealso //! @seealso
//! @[map()], @[transform_with()] //! @[transform_with()], @[map()], @[recover()]
this_program transform(function(mixed, mixed ... : mixed) success, this_program transform(function(mixed, mixed ... : mixed) success,
function(mixed, mixed ... : mixed)|void failure, function(mixed, mixed ... : mixed)|void failure,
mixed ... extra) mixed ... extra)
...@@ -304,7 +317,7 @@ class Future ...@@ -304,7 +317,7 @@ class Future
//! This method is used if your callbacks returns a @[Future] again. //! This method is used if your callbacks returns a @[Future] again.
//! //!
//! @seealso //! @seealso
//! @[flat_map()], @[transform()] //! @[transform()], @[flat_map()], @[recover_with]
this_program transform_with(function(mixed, mixed ... : this_program) success, this_program transform_with(function(mixed, mixed ... : this_program) success,
function(mixed, mixed ... : this_program)|void failure, function(mixed, mixed ... : this_program)|void failure,
mixed ... extra) mixed ... extra)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment