Merge branch 'master' into develop

libraries/concurrency/channel/process/process_example.cpp

@@ -1,4 +1,6 @@
+#include <atomic>
 #include <iostream>
+#include <thread>
 
 #include <stlab/concurrency/channel.hpp>
 #include <stlab/concurrency/default_executor.hpp>
@@ -35,17 +37,26 @@ struct adder
 
 int main() {
   sender<int> send;       
-  receiver<int> receiver; 
+  receiver<int> receiver;
   std::tie(send, receiver) = channel<int>(default_executor);
 
-  auto calculator = receiver | adder{} | 
-    [](int x) { std::cout << x << '\n'; };
+  std::atomic_bool done{false};
+
+  auto calculator = receiver | 
+    adder{} | 
+    [&_done = done](int x) { std::cout << x << '\n'; 
+      _done = true;
+    };
 
   receiver.set_ready();
 
-  while (true) {
-    int x;
-    std::cin >> x;
-    send(x);
-  }
+  send(1);
+  send(2);
+  send(3);
+  send(0);
+
+    // Waiting just for illustrational purpose
+    while (!done) {
+        std::this_thread::sleep_for(std::chrono::milliseconds(1));
+    }
 }

libraries/concurrency/channel/receiver/executor/executor.md

@@ -6,7 +6,8 @@ scope: stlab
 pure-name: executor
 defined-in-header: stlab/concurrency/channel.hpp 
 declaration: executor()
-description: Constructs a new executor object
+brief: Constructs a new executor wrapper object
+description: Constructs a new executor wrapper object
 entities:
   - kind: methods
     list:

libraries/concurrency/channel/receiver/executor/index.md

@@ -8,6 +8,7 @@ pure-name: executor
 defined-in-header: stlab/concurrency/channel.hpp
 git-link: https://github.com/stlab/libraries/blob/develop/stlab/concurrency/channel.hpp
 declaration: struct executor
+brief: Executor wrapper class
 description: This class has only one purpose, to encapsulate an executor to be piped to a `receiver<T>`
 dtor: default
 example: executor_example.cpp

libraries/concurrency/channel/receiver/operator_pipe.md

@@ -6,7 +6,7 @@ scope: receiver
 pure-name: operator|
 defined-in-header: stlab/concurrency/channel.hpp 
 declaration: operator|()
-brief: Creates a new receiver with the given process attached downstream.
+brief: Attaches a new process to the channel.
 description: Creates a new receiver, attaches the given process as downstream to it and returns this new receiver. The new receiver inherits the executor from its upstream receiver if not an alternative executor is attached. In case that `T` of `receiver<T>` is a move only type, repeated calls of this operator overwrite the previous attached downstream channel.
 example: operator_pipe_example.cpp
 entities:

libraries/concurrency/channel/receiver/set_ready.md

@@ -6,7 +6,8 @@ scope: receiver
 pure-name: set_ready
 defined-in-header: stlab/concurrency/channel.hpp 
 declaration: set_ready
-description: Sets this receiver ready to receive values.
+brief: Sets the receiver ready to receive values.
+description: Sets the receiver ready to receive values.
 example: set_ready_example.cpp
 entities:
   - kind: methods

libraries/concurrency/channel/sender/operator().md

@@ -6,6 +6,7 @@ scope: sender
 pure-name: operator()
 defined-in-header: stlab/concurrency/channel.hpp 
 declaration: operator()
+brief: Sends a new value into the channel
 description: Sends a new value into the channel
 example: call_operator_example.cpp
 entities:

libraries/concurrency/channel/zip.md

@@ -4,7 +4,7 @@ title: stlab::zip
 tags: [library]
 scope: stlab
 pure-name: zip
-brief: Creates a future that zips all passed arguments
+brief: It creates a process that zips all passed arguments and returns a receiver.
 annotation: template function
 example: zip_example.cpp
 entities:

libraries/concurrency/executor/default_executor/index.md

@@ -6,7 +6,8 @@ name: stlab::default_executor
 pure-name: default_executor
 defined-in-header: executor/concurrency/default_executor.hpp
 declaration: struct default_executor
-description: Executes functions on the system's thread pool
+brief: Interface to the system's thread pool
+description: Executes functions on the system's thread pool. On MacOS, Windows, Emscripten and PNaCl the OS integrated thread pool is the base of this class. For other OS an custom thread pool is provided. 
 member-types:
   - type: result_type
     definition: void

libraries/concurrency/executor/index.md

@@ -2,7 +2,7 @@
 layout: library
 title: Executors
 tags: [library]
-brief: Executors. They execute.
+brief: A collection of executors with different strategies to run tasks.
 description: |
     Executors provide a means of running functions using different execution policies via a consistent interface.
 ---

libraries/concurrency/future/future/recover.md

@@ -6,7 +6,8 @@ scope: future
 pure-name: recover
 defined-in-header: stlab/concurrency/future.hpp 
 declaration: recover()
-description: Creates a recoverable continuation on the current object.
+brief: Creates a recoverable future on the current object.
+description: Since the futures are value based, the recover method should be used to do the error handling.    
 example: recover_example.cpp
 entities:
   - kind: methods
@@ -45,4 +46,7 @@ entities:
         description: Executor which is used to schedule the resulting task
       - name: f
         description: Callable object that implements the `recover()` function. Its parameter must be of type of this `future<T>` instance.
+      - kind: result
+        description: It returns the recoverable future
+
 ---

libraries/concurrency/future/future/then.md

@@ -5,7 +5,7 @@ tags: [library]
 scope: future
 pure-name: then
 defined-in-header: stlab/concurrency/future.hpp
-brief: Creates a continuation
+brief: Creates a continuation on the current future.
 declaration: then()
 example: [then_continuation_example.cpp, then_split_example.cpp]
 description: |

libraries/concurrency/index.md

@@ -9,6 +9,11 @@ description: |
     Since one can create with futures only graphs for single use, this library provides as well channels. With these channels one can build graphs, that can be used for multiple invocations.
 ---
 
+### Source Code
+
+The source code is hosted on [github](https://github.com/stlab/libraries).
+
+
 {% include example_table.html %}
 
 ### Requirements
@@ -17,4 +22,4 @@ description: |
 * boost 1.60.0 (optional, variant and test for executing the UnitTests)
 
 ### Authors
-Sean Parent, Felix Petriconi
+Sean Parent, Foster Brereton, Felix Petriconi