From b1c9a0d19679e9a8d3b6ae6abb9cedb401ec1e7b Mon Sep 17 00:00:00 2001
From: q66 <daniel@octaforge.org>
Date: Mon, 3 Apr 2017 18:17:17 +0200
Subject: [PATCH] more doc fixes

---
 ostd/channel.hh   | 14 +++++++-------
 ostd/coroutine.hh | 10 ++++------
 2 files changed, 11 insertions(+), 13 deletions(-)

diff --git a/ostd/channel.hh b/ostd/channel.hh
index 2b888a8..40bac31 100644
--- a/ostd/channel.hh
+++ b/ostd/channel.hh
@@ -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()
      */
diff --git a/ostd/coroutine.hh b/ostd/coroutine.hh
index 359653a..9c8a336 100644
--- a/ostd/coroutine.hh
+++ b/ostd/coroutine.hh
@@ -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{}):