OctaForge
/
libostd
1
0
Fork 1
Code Issues Pull Requests Releases Wiki Activity

more doc fixes

master
Daniel Kolesa 2017-04-03 18:17:17 +02:00
parent 08bd63d773
commit b1c9a0d196
2 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
ostd/channel.hh
View File

@ -53,10 +53,10 @@ template<typename T>
struct channel {
/** @brief Constructs a default channel.
*
* This uses `std::condition_variable` as its internal condition type,
* This uses std::condition_variable as its internal condition type,
* so it will work with standard threads (raw or when used with C++'s
* async APIs). You can also use channels with ostd's concurrency system
* though - see make_channel<T>() and channel(F).
* though - see ostd::make_channel() and channel(F).
*/
channel(): p_state(new impl) {}
@ -72,7 +72,7 @@ struct channel {
*
* However, typically you won't be using this directly, as you're meant
* to use the higher level concurrency system, which lready provides the
* make_channel<T>() function.
* ostd::make_channel() function.
*
* @param[in] func A function that returns the desired condvar.
*/
@ -117,7 +117,7 @@ struct channel {
*
* @param[in] val The value to insert.
*
* @throws #ostd::channel_error when the channel is closed.
* @throws ostd::channel_error when the channel is closed.
*
* @see put(T &&), get(), try_get(), close(), is_closed()
*/
@ -131,7 +131,7 @@ struct channel {
*
* @param[in] val The value to insert.
*
* @throws #ostd::channel_error when the channel is closed.
* @throws ostd::channel_error when the channel is closed.
*
* @see put(T const &)
*/
@ -151,7 +151,7 @@ struct channel {
*
* @returns The first inserted value in the queue.
*
* @throws #ostd::channel_error when the channel is closed.
* @throws ostd::channel_error when the channel is closed.
*
* @see try_get(T &), put(T const &), close(), is_closed()
*/
@ -169,7 +169,7 @@ struct channel {
*
* @returns `true` if a value was retrieved and `false` otherwise.
*
* @throws #ostd::channel_error when the channel is closed.
* @throws ostd::channel_error when the channel is closed.
*
* @see try_get(T &), put(T const &), close(), is_closed()
*/

10
ostd/coroutine.hh
View File

@ -158,8 +158,6 @@ protected:
*
* Additionally, propagates any uncaught exception that was thrown inside
* of the coroutine function by calling rethrow().
*
* @throws Whatever the coroutine function throws.
*/
void call() {
set_exec();
@ -739,10 +737,10 @@ public:
*
* Otherwise creates a context using the provided stack allocator.
*
* Throws whatever an std::function constructor might throw.
*
* @param[in] func The function to use.
* @param[in] sa The stack allocator, defaults to a default_stack.
*
* @throws Whatever an std::function constructor could throw.
*/
template<typename F, typename SA = default_stack>
coroutine(F func, SA sa = SA{}): base_t(), p_stor(std::move(func)) {
@ -988,10 +986,10 @@ public:
* Otherwise creates a context using the provided stack allocator
* and then resumes the generator, making it get a value (or die).
*
* Throws whatever an std::function constructor might throw.
*
* @param[in] func The function to use.
* @param[in] sa The stack allocator, defaults to a default_stack.
*
* @throws Whatever an `std::function` constructor could throw.
*/
template<typename F, typename SA = default_stack>
generator(F func, SA sa = SA{}):