Commit Graph

88 Commits

Author SHA1 Message Date
Oliver Kowalke
bdab3735ed update docu 2014-09-12 16:58:07 +02:00
Oliver Kowalke
c161e095af docu update 2014-09-09 21:02:12 +02:00
Oliver Kowalke
c005bb2c8f doc update 2014-09-09 20:40:26 +02:00
Oliver Kowalke
491012776f update docu 2014-09-05 17:55:49 +02:00
Oliver Kowalke
142dd2cd5b some doc corrections 2014-07-21 20:04:38 +02:00
Oliver Kowalke
aa6f0b1bce add a note to destructor of fiber in documentation 2013-12-16 17:33:17 +01:00
Oliver Kowalke
909c8ed3fc some smalle fixes in documentation 2013-12-06 08:52:22 +01:00
Nat Goodspeed
8432f8b864 Update doc for set_scheduling_algorithm() for void return.
Add note to set_scheduling_algorithm() about caller's responsibility to
eventually destroy the passed scheduler object.
2013-12-04 13:26:30 -05:00
Nat Goodspeed
7eca9fb5fb Document set_scheduling_algorithm().
Add cross-references for that and for algorithm, round_robin and
round_robin_ws.
2013-12-03 22:41:25 -05:00
Oliver Kowalke
511b740ec2 default-scheduler allocated 2013-12-02 19:45:48 +01:00
Oliver Kowalke
e1adfd666c add doc about scheduling 2013-11-24 17:29:06 +01:00
Oliver Kowalke
ddd4f8fff6 update docu 2013-11-21 17:49:08 +01:00
Nat Goodspeed
b0d09be850 Fix doc about fiber::operator safe_bool(): NOT same as joinable().
Looking at the implementation, it seems that operator safe_bool() and its
companion, operator!(), interrogate whether the referenced fiber has or has
not terminated. joinable() does not.
Add more joinable() cross-references, and cross-reference joinable(), operator
safe_bool() and operator!().
2013-11-18 22:15:49 -05:00
Nat Goodspeed
e436bc991d Add class_heading, member_heading et al. QuickBook templates and use for cross-referencing. 2013-11-08 18:30:11 -05:00
Nat Goodspeed
d7b4be06c7 Link this_fiber::thread_affinity() to fiber::thread_affinity().
Use [#named_anchor] QuickBook functionality rather than trying to predict the
normalized link for [heading Member function `thread_affinity( bool)`], which
looks like this:

fiber.fiber_mgmt.fiber.member_function__code__phrase_role__identifier__thread_affinity__phrase__phrase_role__special_____phrase___phrase_role__keyword__bool__phrase__phrase_role__special_____phrase___code_
2013-11-07 08:22:58 -05:00
Nat Goodspeed
7c7683ad41 Start adding internal cross-references to fiber documentation 2013-11-06 22:02:43 -05:00
Nat Goodspeed
32af998f3c Fix markup error in fiber::thread_affinity() Note. 2013-11-06 17:02:24 -05:00
Nat Goodspeed
d9c1272df6 Describe this_fiber::thread_affinity() in terms of fiber::thread_affinity().
Also mention that fiber::thread_affinity() is off by default.
2013-11-06 16:31:20 -05:00
Nat Goodspeed
634fa3fe6a Document desired behavior for fiber::thread_affinity().
Also clarify Preconditions for fiber::priority().
2013-11-06 15:28:46 -05:00
Oliver Kowalke
64c372d059 add thread_affinity() to fiber's public interface 2013-11-02 16:56:24 +01:00
Oliver Kowalke
99cb841259 some corrections for noexcept specifier 2013-11-02 07:05:03 +01:00
Oliver Kowalke
fbc1e67c25 make fibers thread affin 2013-11-02 06:53:21 +01:00
Nat Goodspeed
2d79ce67a0 Clarify condition_variable vs. condition_variable_any.
Make condition_variable::wait_until() and wait_for() consistently use 'lk' instead of 'lt' because explanations only describe 'lk'.
Explain condition_variable::wait(), wait_until() and wait_for() Precondition.
Distinguish values returned by wait_until(), wait_for() overloads with and without predicates.
Update request for section concerning algorithm, set_scheduling_algorithm(), round_robin and round_robin_ws.
Clarify lifespan implications of fiber_group::add_fiber(). Explain requirement for a heap fiber object.
Experiment with cross-reference links to other Boost libraries.
2013-10-31 11:19:22 -04:00
Oliver Kowalke
f5d9d6536b docuemntation 2013-10-28 14:54:00 +01:00
Oliver Kowalke
676b9616d6 documentation update (pass #3) 2013-10-26 10:18:35 +02:00
Oliver Kowalke
4f60f804ff docuemtnation update 2013-10-13 11:01:38 +02:00
Oliver Kowalke
2d005f743e docu 2013-09-26 19:26:18 +02:00
Oliver Kowalke
13e52fdb23 docu 2013-09-16 17:33:15 +02:00
Oliver Kowalke
327104ffe3 dou 2013-09-15 19:38:29 +02:00
Oliver Kowalke
5e59b45c8d documentation 2013-09-13 17:38:36 +02:00
Oliver Kowalke
00ec9d32a3 update 2013-08-28 21:57:14 +02:00
Oliver Kowalke
2e000575e1 docu 2013-08-27 22:04:12 +02:00
Oliver Kowalke
1e838db13d docu 2013-08-25 19:52:15 +02:00
Oliver Kowalke
0cf8661315 documentation prepared 2013-08-21 17:30:00 +02:00
Oliver Kowalke
f06b6cf0d4 fix auto-link in config.hpp 2013-08-13 10:27:02 +02:00
Oliver Kowalke
b9542e1745 enhance docuemntation 2013-06-12 16:59:10 +02:00
Oliver Kowalke
645281a2ba add fiber::detach() 2012-12-13 17:59:13 +01:00
Oliver Kowalke
81e62e8962 changed directory structure as required by modularized-boost 2012-12-09 15:22:59 +01:00