fiber/doc
Nat Goodspeed a0490413cd Further work on futures documentation.
Explain "shared state", and provide links to the explanation wherever it's
referenced.

We don't need the doc to enumerate 'R& future<R&>::get()' or 'void
future<void>::get()' separately from 'R future<R>::get()': all three
specializations are exactly as the reader expects, given the generic
template (unlike shared_future, where it's useful to spell them out).

Encapsulate some of the necessary redundancies between future and
shared_future documentation.

Explain the effect of promise::set_value() vs. promise::set_exception() on
each of [shared_]future::get(), get_exception_ptr(), wait(), wait_for() and
wait_until().

Add get_exception_ptr() method to shared_future exposition class.

Clarify distinction between shared_future move assignment vs. copy assignment.

Document that async() is now variadic. Document its StackAllocator overload,
and the effect of passing StackAllocator. Remove warning about launch policy
'deferred' since async() has no launch policy parameter.
2015-08-12 16:32:54 -04:00
..
html documentation: some notes to boost.asio integration 2015-07-29 12:24:00 +02:00
acknowledgements.qbk update docu 2015-05-23 18:27:08 +02:00
asio.qbk docu 2015-04-18 13:23:08 +02:00
barrier.qbk documentation: barrier:wait() is interruption point 2015-07-29 10:20:01 +02:00
channel.qbk Proofread today's documentation updates. 2015-08-08 11:03:47 -04:00
condition_variables.qbk More documentation. 2015-07-20 09:40:01 -04:00
customization.qbk Add reference documentation for custom scheduling classes. 2015-07-19 22:57:56 -04:00
fiber.qbk documentation: remove refrence to boost.chrono ad boost.move 2015-08-06 17:21:29 +02:00
fibers.qbk documentation: remove refrence to boost.chrono ad boost.move 2015-08-06 17:21:29 +02:00
fibers.xml documentation: some notes to boost.asio integration 2015-07-29 12:24:00 +02:00
fls.qbk update docu 2015-02-14 11:11:11 +01:00
future.qbk Further work on futures documentation. 2015-08-12 16:32:54 -04:00
futures.qbk Further work on futures documentation. 2015-08-12 16:32:54 -04:00
Jamfile.v2 documentation update (pass #3) 2013-10-26 10:18:35 +02:00
migration.qbk update docu 2014-09-07 10:51:33 +02:00
mutexes.qbk Tweaks to new documentation 2015-07-29 09:21:49 -04:00
overview.qbk Make Rationale section reference new BOOST_FIBERS_NO_ATOMICS passage. 2015-07-28 22:31:35 -04:00
packaged_task.qbk Further work on futures documentation. 2015-08-12 16:32:54 -04:00
performance.qbk use atomics per default 2015-06-20 21:31:34 +02:00
promise.qbk Further work on futures documentation. 2015-08-12 16:32:54 -04:00
rational.qbk documentation: add comment regarding to migration of fibers 2015-08-05 19:59:22 +02:00
scheduling.qbk documentation: formating 2015-07-29 11:48:42 +02:00
stack.qbk More documentation. 2015-07-20 09:40:01 -04:00